support customize [Command("")]class

neuecc · neuecc · commit 435d6cc3c542 · 2021-04-07T16:44:41.000+09:00
diff --git a/.github/workflows/build-debug.yml b/.github/workflows/build-debug.yml
@@ -21,7 +21,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: 3.1.x
+          dotnet-version: 5.0.x
 
       - run: dotnet build -c Debug
       - run: dotnet test -c Debug --no-build < /dev/null
diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml
@@ -15,6 +15,7 @@ env:
   GIT_TAG: ${{ github.event.inputs.tag }}
   DRY_RUN: ${{ github.event.inputs.dry_run }}
   DOTNET_SDK_VERISON_3: 3.1.x
+  DOTNET_SDK_VERISON_5: 5.0.x
 
 jobs:
   build-dotnet:
@@ -27,7 +28,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: ${{ env.DOTNET_SDK_VERISON_3 }}
+          dotnet-version: ${{ env.DOTNET_SDK_VERISON_5 }}
       # pack nuget
       - run: dotnet build -c Release -p:Version=${{ env.GIT_TAG }}
       - run: dotnet test -c Release --no-build
@@ -50,7 +51,7 @@ jobs:
       # setup dotnet for nuget push
       - uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: ${{ env.DOTNET_SDK_VERISON_3 }}
+          dotnet-version: ${{ env.DOTNET_SDK_VERISON_5 }}
       # tag
       - uses: actions/checkout@v2
       - name: tag
diff --git a/ReadMe.md b/ReadMe.md
@@ -334,7 +334,7 @@ public class App : ConsoleAppBase
 ```
 
 ```
-RunConsoleAPpFramework();
+RunConsoleAppFramework();
 
 public class App2 : ConsoleAppBase
 {
@@ -345,10 +345,11 @@ public class App2 : ConsoleAppBase
     }
 }
 
-
+// command attribute also can use to class.
+[Command("mycmd")
 public class App3 : ConsoleAppBase
 {
-     // routing command: `app3 e2`
+     // routing command: `mycmd e2`
     [Command("e2", "exec app 2.")]
     public void ExecExec()
     {
@@ -646,6 +647,28 @@ public class MyApp : ConsoleAppBase, IDisposable
 }
 ```
 
+also supports `IAsyncDisposable.Dispose`, however if implements both `IDisposable` and `IAsyncDisposable`, called only `IAsyncDisposable`(this is the limitation of default `ServiceProviderEngineScope`).
+
+```csharp
+public class MyApp : ConsoleAppBase, IDisposable, IAsyncDisposable
+{
+    public void Hello()
+    {
+        Console.WriteLine("Hello");
+    }
+
+    void IDisposable.Dispose()
+    {
+        Console.WriteLine("Not called.");
+    }
+        
+    async ValueTask IAsyncDisposable.DisposeAsync()
+    {
+        Console.WriteLine("called.");
+    }
+}
+```
+
 ConsoleAppContext
 ---
 ConsoleAppContext is injected to property on method executing.
diff --git a/sandbox/MultiContainedApp/Program.cs b/sandbox/MultiContainedApp/Program.cs
@@ -11,10 +11,11 @@ class Program
     {
         static async Task Main(string[] args)
         {
-            //args = new string[] { "Bar.Hello3", "2" };
+            //d
             //args = new string[] { "bar", "hello3", "-help" };
             //args = new string[] { "foo", "echo", "help"};
             //args = new string[] { "bar.hello2", "help" };
+            args = new string[] { "foo-bar", "ec", "-msg", "tako" };
 
 
             await Host.CreateDefaultBuilder()
@@ -39,12 +40,13 @@ await Host.CreateDefaultBuilder()
 
     [ConsoleAppFilter(typeof(MyFilter2), Order = 9999)]
     [ConsoleAppFilter(typeof(MyFilter2), Order = 9999)]
-    public class Foo : ConsoleAppBase
+    // [Command("AAA")]
+    public class FooBar : ConsoleAppBase
     {
         [Command("ec", "My echo")]
         public void Echo(string msg)
         {
-            Console.WriteLine(msg);
+            Console.WriteLine(msg + "OK??");
         }
 
         public void Sum(int x, int y)
@@ -55,9 +57,16 @@ public void Sum(int x, int y)
 
     public class Bar : ConsoleAppBase
     {
-        public void Hello2()
+        [Command("ec", "My echo")]
+        public void Hello2(string msg)
+        {
+            Console.WriteLine("H E L L O 2");
+        }
+
+        
+        public void Sum(int x, int y)
         {
-            Console.WriteLine("H E L L O");
+            Console.WriteLine((x + y).ToString());
         }
     }
 
diff --git a/sandbox/SingleContainedApp/Program.cs b/sandbox/SingleContainedApp/Program.cs
@@ -217,12 +217,12 @@ void IDisposable.Dispose()
     //    }
     //}
 
-    public class Program : ConsoleAppBase, IDisposable
+    public class Program : ConsoleAppBase, IDisposable, IAsyncDisposable
     {
         static async Task Main(string[] args)
         {
             //args = new[] { "-m", "a ", "-b", "False" };
-           args = new[] { "hello" };
+            args = new[] { "hello" };
 
             await Host.CreateDefaultBuilder().RunConsoleAppFrameworkAsync<Program>(args, new ConsoleAppOptions
             {
@@ -240,10 +240,15 @@ public void Hello(
             if (hello == null) hello = DateTime.Now;
             Console.WriteLine(hello);
         }
-
+        
         void IDisposable.Dispose()
         {
-            throw new NotImplementedException();
+            Console.WriteLine("standard dispose");
+        }
+        
+        async ValueTask IAsyncDisposable.DisposeAsync()
+        {
+            Console.WriteLine("async dispose");
         }
     }
 }
diff --git a/src/ConsoleAppFramework/CommandAttribute.cs b/src/ConsoleAppFramework/CommandAttribute.cs
@@ -2,6 +2,7 @@
 
 namespace ConsoleAppFramework
 {
+    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false)]
     public class CommandAttribute : Attribute
     {
         public string[] CommandNames { get; }
diff --git a/src/ConsoleAppFramework/ConsoleAppEngineHostBuilderExtensions.cs b/src/ConsoleAppFramework/ConsoleAppEngineHostBuilderExtensions.cs
@@ -364,9 +364,11 @@ static List<Type> GetConsoleAppTypes(Assembly[] searchAssemblies)
                         isFound = true;
                     }
                 }
+
                 if (!isFound && split.Length == 2)
                 {
-                    if (baseType.Name.Equals(split[0], StringComparison.OrdinalIgnoreCase))
+                    var baseNames = baseType.GetCustomAttribute<CommandAttribute>()?.CommandNames ?? new[] { baseType.Name };
+                    if (baseNames.Any(x => x.Equals(split[0], StringComparison.OrdinalIgnoreCase)))
                     {
                         if (foundType != null)
                         {
@@ -395,7 +397,6 @@ static List<Type> GetConsoleAppTypes(Assembly[] searchAssemblies)
                 return (foundType, foundMethod);
             }
             return (null, null);
-
         }
     }
 }
diff --git a/src/ConsoleAppFramework/ConsoleAppOptions.cs b/src/ConsoleAppFramework/ConsoleAppOptions.cs
@@ -17,5 +17,8 @@ public class ConsoleAppOptions
         public JsonSerializerOptions? JsonSerializerOptions { get; set; }
 
         public ConsoleAppFilter[]? GlobalFilters { get; set; }
+
+        // for https://github.com/Cysharp/ConsoleAppFramework/issues/60
+        // public INamingConverter NamingConverter { get; set; } = new HypenLowerNamingConverter();
     }
 }
diff --git a/src/ConsoleAppFramework/INamingConverter.cs b/src/ConsoleAppFramework/INamingConverter.cs
@@ -0,0 +1,95 @@
+﻿//using System;
+//using System.Collections.Generic;
+//using System.Text;
+
+//namespace ConsoleAppFramework
+//{
+//    public interface INamingConverter
+//    {
+//        string ConvertToAliasName(string name);
+//        string ConvertToOriginalName(string name);
+//    }
+
+//    public class OriginalNamingConverter : INamingConverter
+//    {
+//        public string ConvertToAliasName(string name)
+//        {
+//            return name;
+//        }
+
+//        public string ConvertToOriginalName(string name)
+//        {
+//            return name;
+//        }
+//    }
+
+//    public class LowerCaseNamingConverter : INamingConverter
+//    {
+//        public string ConvertToAliasName(string name)
+//        {
+//            return name.ToLower();
+//        }
+
+//        // compare is case insensitive so use as is.
+//        public string ConvertToOriginalName(string name)
+//        {
+//            return name;
+//        }
+//    }
+
+//    public class HypenLowerNamingConverter : INamingConverter
+//    {
+//        public string ConvertToAliasName(string s)
+//        {
+//            if (string.IsNullOrEmpty(s)) return s;
+
+//            var sb = new StringBuilder();
+//            for (int i = 0; i < s.Length; i++)
+//            {
+//                var c = s[i];
+
+//                if (Char.IsUpper(c))
+//                {
+//                    // first
+//                    if (i == 0)
+//                    {
+//                        sb.Append(char.ToLowerInvariant(c));
+//                    }
+//                    else if (char.IsUpper(s[i - 1])) // WriteIO => write-io
+//                    {
+//                        sb.Append(char.ToLowerInvariant(c));
+//                    }
+//                    else
+//                    {
+//                        sb.Append("-");
+//                        sb.Append(char.ToLowerInvariant(c));
+//                    }
+//                }
+//                else
+//                {
+//                    sb.Append(c);
+//                }
+//            }
+
+//            return sb.ToString();
+//        }
+
+//        public string ConvertToOriginalName(string s)
+//        {
+//            var sb = new StringBuilder();
+//            for (int i = 0; i < s.Length; i++)
+//            {
+//                if (s[i] == '-')
+//                {
+//                    continue;
+//                }
+//                else
+//                {
+//                    sb.Append(s[i]);
+//                }
+//            }
+
+//            return sb.ToString();
+//        }
+//    }
+//}

Original file line number	Diff line number	Diff line change
`@@ -11,10 +11,11 @@ class Program`
`11`	`11`	`{`
`12`	`12`	`static async Task Main(string[] args)`
`13`	`13`	`{`
`14`		`- //args = new string[] { "Bar.Hello3", "2" };`
	`14`	`+ //d`
`15`	`15`	`//args = new string[] { "bar", "hello3", "-help" };`
`16`	`16`	`//args = new string[] { "foo", "echo", "help"};`
`17`	`17`	`//args = new string[] { "bar.hello2", "help" };`
	`18`	`+ args = new string[] { "foo-bar", "ec", "-msg", "tako" };`
`18`	`19`
`19`	`20`
`20`	`21`	`await Host.CreateDefaultBuilder()`
`@@ -39,12 +40,13 @@ await Host.CreateDefaultBuilder()`
`39`	`40`
`40`	`41`	`[ConsoleAppFilter(typeof(MyFilter2), Order = 9999)]`
`41`	`42`	`[ConsoleAppFilter(typeof(MyFilter2), Order = 9999)]`
`42`		`- public class Foo : ConsoleAppBase`
	`43`	`+ // [Command("AAA")]`
	`44`	`+ public class FooBar : ConsoleAppBase`
`43`	`45`	`{`
`44`	`46`	`[Command("ec", "My echo")]`
`45`	`47`	`public void Echo(string msg)`
`46`	`48`	`{`
`47`		`- Console.WriteLine(msg);`
	`49`	`+ Console.WriteLine(msg + "OK??");`
`48`	`50`	`}`
`49`	`51`
`50`	`52`	`public void Sum(int x, int y)`
`@@ -55,9 +57,16 @@ public void Sum(int x, int y)`
`55`	`57`
`56`	`58`	`public class Bar : ConsoleAppBase`
`57`	`59`	`{`
`58`		`- public void Hello2()`
	`60`	`+ [Command("ec", "My echo")]`
	`61`	`+ public void Hello2(string msg)`
	`62`	`+ {`
	`63`	`+ Console.WriteLine("H E L L O 2");`
	`64`	`+ }`
	`65`	`+`
	`66`	`+`
	`67`	`+ public void Sum(int x, int y)`
`59`	`68`	`{`
`60`		`- Console.WriteLine("H E L L O");`
	`69`	`+ Console.WriteLine((x + y).ToString());`
`61`	`70`	`}`
`62`	`71`	`}`
`63`	`72`
Original file line number	Diff line number	Diff line change
`@@ -217,12 +217,12 @@ void IDisposable.Dispose()`
`217`	`217`	`// }`
`218`	`218`	`//}`
`219`	`219`
`220`		`- public class Program : ConsoleAppBase, IDisposable`
	`220`	`+ public class Program : ConsoleAppBase, IDisposable, IAsyncDisposable`
`221`	`221`	`{`
`222`	`222`	`static async Task Main(string[] args)`
`223`	`223`	`{`
`224`	`224`	`//args = new[] { "-m", "a ", "-b", "False" };`
`225`		`- args = new[] { "hello" };`
	`225`	`+ args = new[] { "hello" };`
`226`	`226`
`227`	`227`	`await Host.CreateDefaultBuilder().RunConsoleAppFrameworkAsync<Program>(args, new ConsoleAppOptions`
`228`	`228`	`{`
`@@ -240,10 +240,15 @@ public void Hello(`
`240`	`240`	`if (hello == null) hello = DateTime.Now;`
`241`	`241`	`Console.WriteLine(hello);`
`242`	`242`	`}`
`243`		`-`
	`243`	`+`
`244`	`244`	`void IDisposable.Dispose()`
`245`	`245`	`{`
`246`		`- throw new NotImplementedException();`
	`246`	`+ Console.WriteLine("standard dispose");`
	`247`	`+ }`
	`248`	`+`
	`249`	`+ async ValueTask IAsyncDisposable.DisposeAsync()`
	`250`	`+ {`
	`251`	`+ Console.WriteLine("async dispose");`
`247`	`252`	`}`
`248`	`253`	`}`
`249`	`254`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace ConsoleAppFramework`
`4`	`4`	`{`
	`5`	`+ [AttributeUsage(AttributeTargets.Class \| AttributeTargets.Method, AllowMultiple = false)]`
`5`	`6`	`public class CommandAttribute : Attribute`
`6`	`7`	`{`
`7`	`8`	`public string[] CommandNames { get; }`
Original file line number	Diff line number	Diff line change
`@@ -364,9 +364,11 @@ static List<Type> GetConsoleAppTypes(Assembly[] searchAssemblies)`
`364`	`364`	`isFound = true;`
`365`	`365`	`}`
`366`	`366`	`}`
	`367`	`+`
`367`	`368`	`if (!isFound && split.Length == 2)`
`368`	`369`	`{`
`369`		`- if (baseType.Name.Equals(split[0], StringComparison.OrdinalIgnoreCase))`
	`370`	`+ var baseNames = baseType.GetCustomAttribute<CommandAttribute>()?.CommandNames ?? new[] { baseType.Name };`
	`371`	`+ if (baseNames.Any(x => x.Equals(split[0], StringComparison.OrdinalIgnoreCase)))`
`370`	`372`	`{`
`371`	`373`	`if (foundType != null)`
`372`	`374`	`{`
`@@ -395,7 +397,6 @@ static List<Type> GetConsoleAppTypes(Assembly[] searchAssemblies)`
`395`	`397`	`return (foundType, foundMethod);`
`396`	`398`	`}`
`397`	`399`	`return (null, null);`
`398`		`-`
`399`	`400`	`}`
`400`	`401`	`}`
`401`	`402`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,5 +17,8 @@ public class ConsoleAppOptions`
`17`	`17`	`public JsonSerializerOptions? JsonSerializerOptions { get; set; }`
`18`	`18`
`19`	`19`	`public ConsoleAppFilter[]? GlobalFilters { get; set; }`
	`20`	`+`
	`21`	`+ // for https://github.com/Cysharp/ConsoleAppFramework/issues/60`
	`22`	`+ // public INamingConverter NamingConverter { get; set; } = new HypenLowerNamingConverter();`
`20`	`23`	`}`
`21`	`24`	`}`