AsyncCommandBase & auto syntax & .NET 8.0

Aviuz · Jul 28, 2024 · 956d9b2 · 956d9b2
1 parent 5e3ad7f
commit 956d9b2
Show file tree

Hide file tree

Showing 23 changed files with 165 additions and 46 deletions.
diff --git a/source/ECF.AutoFac/.nuspec b/source/ECF.AutoFac/.nuspec
@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
     <metadata>
         <id>EasyConsoleFramework.AutoFac</id>
-        <version>0.2.1</version>
+        <version>0.2.2</version>
         <description>Easy Console Framewok - Framework for building command based IoC console application. This package is using AutoFac library for IoC.</description>
         <authors>Aviuz</authors>
         <tags>console IoC ecf autofac</tags>
@@ -18,16 +18,22 @@
 
         <dependencies>
             <group targetFramework="net6">
-				<dependency id="EasyConsoleFramework.Base" version="0.2.0" />
+				<dependency id="EasyConsoleFramework.Base" version="0.2.2" />
                 <dependency id="Autofac" version="6.5.0" />
 				<dependency id="Microsoft.Extensions.Configuration.Json" version="6.0.0" />
             </group>
 
             <group targetFramework="net7">
-				<dependency id="EasyConsoleFramework.Base" version="0.2.0" />
+				<dependency id="EasyConsoleFramework.Base" version="0.2.2" />
 				<dependency id="Autofac" version="6.5.0" />
                 <dependency id="Microsoft.Extensions.Configuration.Json" version="7.0.0" />
             </group>
+
+			<group targetFramework="net8">
+				<dependency id="EasyConsoleFramework.Base" version="0.2.2" />
+				<dependency id="Autofac" version="6.5.0" />
+				<dependency id="Microsoft.Extensions.Configuration.Json" version="8.0.0" />
+			</group>
         </dependencies>
     </metadata>
 
@@ -41,5 +47,9 @@
         <file src="bin\Release\net7.0\ECF.Autofac.dll" target="lib\net7.0" />
         <file src="bin\Release\net7.0\ECF.Autofac.pdb" target="lib\net7.0" />
         <file src="bin\Release\net7.0\ECF.Autofac.deps.json" target="lib\net7.0" />
+
+        <file src="bin\Release\net8.0\ECF.Autofac.dll" target="lib\net8.0" />
+        <file src="bin\Release\net8.0\ECF.Autofac.pdb" target="lib\net8.0" />
+        <file src="bin\Release\net8.0\ECF.Autofac.deps.json" target="lib\net8.0" />
     </files>
 </package>
diff --git a/source/ECF.AutoFac/ECF.AutoFac.csproj b/source/ECF.AutoFac/ECF.AutoFac.csproj
@@ -1,10 +1,10 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFrameworks>net6.0;net7.0</TargetFrameworks>
+		<TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
-		<Version>0.2.0</Version>
+		<Version>0.2.2</Version>
 	</PropertyGroup>
 
 	<ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
@@ -17,6 +17,11 @@
 		<PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="7.0.0" />
 	</ItemGroup>
 
+	<ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
+		<PackageReference Include="Autofac" Version="6.5.0" />
+		<PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="8.0.0" />
+	</ItemGroup>
+
 	<ItemGroup>
 	  <ProjectReference Include="..\ECF\ECF.csproj" />
 	</ItemGroup>

diff --git a/source/ECF.Microsoft.DependencyInjection/.nuspec b/source/ECF.Microsoft.DependencyInjection/.nuspec
@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
     <metadata>
         <id>ECF</id>
-        <version>0.2.1</version>
+        <version>0.2.2</version>
         <description>Easy Console Framewok - Framework for building command based IoC console application. This package is using Microsoft.Extensions.DependencyInjection library for IoC</description>
         <authors>Aviuz</authors>
         <tags>console IoC ecf DependencyInjection</tags>
@@ -18,16 +18,22 @@
 
         <dependencies>
             <group targetFramework="net6">
-                <dependency id="EasyConsoleFramework.Base" version="0.2.0" />
+                <dependency id="EasyConsoleFramework.Base" version="0.2.2" />
                 <dependency id="Microsoft.Extensions.DependencyInjection" version="6.0.1" />
                 <dependency id="Microsoft.Extensions.Configuration.Json" version="6.0.0" />
             </group>
 
             <group targetFramework="net7">
-				<dependency id="EasyConsoleFramework.Base" version="0.2.0" />
+				<dependency id="EasyConsoleFramework.Base" version="0.2.2" />
 				<dependency id="Microsoft.Extensions.DependencyInjection" version="7.0.0" />
                 <dependency id="Microsoft.Extensions.Configuration.Json" version="7.0.0" />
             </group>
+
+			<group targetFramework="net8">
+				<dependency id="EasyConsoleFramework.Base" version="0.2.2" />
+				<dependency id="Microsoft.Extensions.DependencyInjection" version="8.0.0" />
+				<dependency id="Microsoft.Extensions.Configuration.Json" version="8.0.0" />
+			</group>
         </dependencies>
     </metadata>
 
@@ -41,5 +47,9 @@
         <file src="bin\Release\net7.0\ECF.dll" target="lib\net7.0" />
         <file src="bin\Release\net7.0\ECF.pdb" target="lib\net7.0" />
         <file src="bin\Release\net7.0\ECF.deps.json" target="lib\net7.0" />
+
+        <file src="bin\Release\net8.0\ECF.dll" target="lib\net8.0" />
+        <file src="bin\Release\net8.0\ECF.pdb" target="lib\net8.0" />
+        <file src="bin\Release\net8.0\ECF.deps.json" target="lib\net8.0" />
     </files>
 </package>
diff --git a/source/ECF.Microsoft.DependencyInjection/ECF.Microsoft.DependencyInjection.csproj b/source/ECF.Microsoft.DependencyInjection/ECF.Microsoft.DependencyInjection.csproj
@@ -1,10 +1,10 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net6.0;net7.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
-    <Version>0.2.0</Version>
+    <Version>0.2.2</Version>
     <AssemblyName>ECF</AssemblyName>
     <RootNamespace>ECF</RootNamespace>
   </PropertyGroup>
@@ -18,6 +18,11 @@
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="7.0.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="7.0.0" />
   </ItemGroup>
+
+  <ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="8.0.0" />
+  </ItemGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\ECF\ECF.csproj" />

diff --git a/source/ECF.Templates/ECFTemplates.csproj b/source/ECF.Templates/ECFTemplates.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <PackageType>Template</PackageType>
-    <Version>0.2.0</Version>
+    <Version>0.2.2</Version>
     <PackageId>ECFTemplates</PackageId>
     <Title>ECF Templates</Title>
     <Authors>Aviuz</Authors>

diff --git a/source/ECF.Templates/templates/ECF.Autofac/NewProject.csproj b/source/ECF.Templates/templates/ECF.Autofac/NewProject.csproj
@@ -2,13 +2,13 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="EasyConsoleFramework.Autofac" Version="0.2.1" />
+    <PackageReference Include="EasyConsoleFramework.Autofac" Version="0.2.2" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/source/ECF.Templates/templates/ECF/NewProject.csproj b/source/ECF.Templates/templates/ECF/NewProject.csproj
@@ -2,13 +2,13 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="ECF" Version="0.2.1" />
+    <PackageReference Include="ECF" Version="0.2.2" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/source/ECF/.nuspec b/source/ECF/.nuspec
@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
     <metadata>
         <id>EasyConsoleFramework.Base</id>
-        <version>0.2.0</version>
+        <version>0.2.2</version>
         <description>Easy Console Framewok - Framework for building command based IoC console application. This package is base library without any IoC dependency.</description>
         <authors>Aviuz</authors>
         <tags>console IoC ecf</tags>
@@ -24,6 +24,10 @@
             <group targetFramework="net7">
                 <dependency id="Microsoft.Extensions.Configuration.Json" version="7.0.0" />
             </group>
+
+			<group targetFramework="net8">
+				<dependency id="Microsoft.Extensions.Configuration.Json" version="8.0.0" />
+			</group>
         </dependencies>
     </metadata>
 
@@ -37,5 +41,9 @@
         <file src="bin\Release\net7.0\ECF.Base.dll" target="lib\net7.0" />
         <file src="bin\Release\net7.0\ECF.Base.pdb" target="lib\net7.0" />
         <file src="bin\Release\net7.0\ECF.Base.deps.json" target="lib\net7.0" />
+
+		<file src="bin\Release\net8.0\ECF.Base.dll" target="lib\net8.0" />
+		<file src="bin\Release\net8.0\ECF.Base.pdb" target="lib\net8.0" />
+		<file src="bin\Release\net8.0\ECF.Base.deps.json" target="lib\net8.0" />
     </files>
 </package>
diff --git a/source/ECF/AsyncCommandBase.cs b/source/ECF/AsyncCommandBase.cs
@@ -0,0 +1,8 @@
+namespace ECF;
+
+public abstract class AsyncCommandBase : CommandBase
+{
+    public override sealed void Execute() => ExecuteAsync().Wait();
+
+    public abstract Task ExecuteAsync();
+}
diff --git a/source/ECF/CommandArguments.cs b/source/ECF/CommandArguments.cs
@@ -4,5 +4,11 @@ public class CommandArguments
     {
         public string CommandName { get; set; }
         public string[] Arguments { get; set; }
+
+        public CommandArguments(string commandName, string[] arguments)
+        {
+            CommandName = commandName;
+            Arguments = arguments;
+        }
     }
 }
diff --git a/source/ECF/CommandBase.cs b/source/ECF/CommandBase.cs
@@ -61,11 +61,7 @@ public virtual void ApplyArguments(CommandArguments args)
 
         public virtual string GetHelp()
         {
-            var commandAttribute = GetType().GetCustomAttributes()
-                .Select(attr => attr as ICommandAttribute)
-                .Where(attr => attr != null)
-                .Cast<ICommandAttribute>()
-                .First();
+            ICommandAttribute commandAttribute = GetCommandAttribute();
             string usageParameters = GetSyntaxExpression();
             string description = GetDescription();
             string parametersHelp = GetParametersHelp();
@@ -130,9 +126,26 @@ public bool IsFlagActive(string key)
             return values.BoolValues[key];
         }
 
+        private ICommandAttribute GetCommandAttribute()
+        {
+            return GetType().GetCustomAttributes()
+                 .Select(attr => attr as ICommandAttribute)
+                 .Where(attr => attr != null)
+                 .Cast<ICommandAttribute>()
+                 .First();
+        }
+
         private string GetSyntaxExpression()
         {
-            return GetType().GetCustomAttribute<CmdSyntaxAttribute>()?.SyntaxExpression ?? string.Empty;
+            string? customSyntax = GetType().GetCustomAttribute<CmdSyntaxAttribute>()?.SyntaxExpression;
+            if (customSyntax != null) return customSyntax; // for developer specified syntax
+
+            var strParts = parameters
+                .OrderBy(x => x.GetOrder())
+                .Select(x => x.GetSyntaxToken())
+                .Where(x => x != null);
+
+            return string.Join(" ", strParts);
         }
 
         private string GetDescription()

diff --git a/source/ECF/CommandBaseComponents/CommandArgument.cs b/source/ECF/CommandBaseComponents/CommandArgument.cs
@@ -44,5 +44,9 @@ public void AppendHelp(StringBuilder sb)
         }
 
         public string SectionName() => "Arguments";
+
+        public int GetOrder() => attribute.Index;
+
+        public string GetSyntaxToken() => $"<{attribute.Name}>";
     }
 }
diff --git a/source/ECF/CommandBaseComponents/CommandFlag.cs b/source/ECF/CommandBaseComponents/CommandFlag.cs
@@ -41,5 +41,11 @@ public void AppendHelp(StringBuilder sb)
         }
 
         public string SectionName() => "Flags";
+
+        public int GetOrder() => int.MaxValue;
+
+        public string GetSyntaxToken() => !string.IsNullOrWhiteSpace(attribute.LongName) 
+            ? "--" + attribute.LongName
+            : "-" + attribute.ShortName;
     }
 }
diff --git a/source/ECF/CommandBaseComponents/CommandParameter.cs b/source/ECF/CommandBaseComponents/CommandParameter.cs
@@ -45,5 +45,17 @@ public void AppendHelp(StringBuilder sb)
         }
 
         public string SectionName() => "Parameters";
+
+        public int GetOrder() => int.MaxValue - 1;
+
+        public string? GetSyntaxToken()
+        {
+            if(!string.IsNullOrEmpty(attribute.LongName)) 
+                return $"--{attribute.LongName} <value>";
+            else if(string.IsNullOrEmpty(attribute.ShortName))
+                return $"-{attribute.ShortName} <value>";
+            else
+                return null;
+        }
     }
 }
diff --git a/source/ECF/CommandBaseComponents/ICommandBaseParameter.cs b/source/ECF/CommandBaseComponents/ICommandBaseParameter.cs
@@ -4,9 +4,14 @@ namespace ECF.CommandBaseComponents
 {
     internal interface ICommandBaseParameter
     {
+        // command execution
         bool TryMatch(ArgumentIterator visitor);
         void Apply(ArgumentIterator visitor, ValueDictionary valueDictionary);
+
+        // help generation
         void AppendHelp(StringBuilder sb);
         string SectionName();
+        int GetOrder();
+        string? GetSyntaxToken();
     }
 }
diff --git a/source/ECF/CommandBaseComponents/PropertyArgument.cs b/source/ECF/CommandBaseComponents/PropertyArgument.cs
@@ -5,13 +5,13 @@ namespace ECF.CommandBaseComponents
 {
     internal class PropertyArgument : ICommandBaseParameter
     {
-        private readonly CommandBase command;
+        private readonly object parent;
         private readonly PropertyInfo propertyInfo;
         private readonly ArgumentAttribute attribute;
 
-        public PropertyArgument(CommandBase command, PropertyInfo propertyInfo, ArgumentAttribute attribute)
+        public PropertyArgument(object parent, PropertyInfo propertyInfo, ArgumentAttribute attribute)
         {
-            this.command = command;
+            this.parent = parent;
             this.propertyInfo = propertyInfo;
             this.attribute = attribute;
         }
@@ -32,7 +32,7 @@ public bool TryMatch(ArgumentIterator visitor)
 
         public void Apply(ArgumentIterator visitor, ValueDictionary valueDictionary)
         {
-            propertyInfo.SetValue(command, Convert.ChangeType(visitor.Take(false), propertyInfo.PropertyType));
+            propertyInfo.SetValue(parent, Convert.ChangeType(visitor.Take(false), propertyInfo.PropertyType));
         }
 
         public void AppendHelp(StringBuilder sb)
@@ -49,5 +49,9 @@ public void AppendHelp(StringBuilder sb)
         }
 
         public string SectionName() => "Arguments";
+
+        public int GetOrder() => attribute.Index;
+
+        public string GetSyntaxToken() => $"<{attribute.Name}>";
     }
 }