feat: Added MethodNamingConvention support.

tryAGI · May 21, 2024 · 6befdfc · 6befdfc
1 parent 7726d02
commit 6befdfc
Show file tree

Hide file tree

Showing 17 changed files with 235 additions and 121 deletions.
diff --git a/src/libs/OpenApiGenerator.Cli/Commands/GenerateCommand.cs b/src/libs/OpenApiGenerator.Cli/Commands/GenerateCommand.cs
@@ -2,6 +2,7 @@
 using OpenApiGenerator.Core.Extensions;
 using OpenApiGenerator.Core.Generators;
 using OpenApiGenerator.Core.Models;
+using OpenApiGenerator.Core.Naming.Methods;
 
 namespace OpenApiGenerator.Cli.Commands;
 
@@ -73,6 +74,8 @@ private static async Task HandleAsync(
             UseRequiredKeyword: default,
             GenerateConstructors: false,
             GenerateMethods: false,
+            MethodNamingConvention: default,
+            MethodNamingConventionFallback: MethodNamingConvention.MethodAndPath,
             GenerateMethodsAsHttpClientExtensions: false,
             GenerateMethodsUsingSystemNetHttpJson: false,
             IncludeOperationIds: [],

diff --git a/src/libs/OpenApiGenerator.Core/Extensions/OpenApiExtensions.cs b/src/libs/OpenApiGenerator.Core/Extensions/OpenApiExtensions.cs
@@ -3,6 +3,7 @@
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers;
 using OpenApiGenerator.Core.Models;
+using OpenApiGenerator.Core.Naming.Methods;
 using OpenApiGenerator.Core.Serialization;
 
 namespace OpenApiGenerator.Core.Extensions;
@@ -29,31 +30,16 @@ public static OpenApiDocument GetOpenApiDocument(
         return openApiDocument;
     }
 
-
-    public static string GetOperationIdOrCompute(this OpenApiOperation operation, string path, OperationType operationType)
+    public static string GetMethodName(this OpenApiOperation operation, string path, OperationType operationType, MethodNamingConvention convention, MethodNamingConvention fallback)
     {
         operation = operation ?? throw new ArgumentNullException(nameof(operation));
 
-        if (operation.OperationId != null)
-        {
-            return operation.OperationId.ToPropertyName();
-        }
+        var mainGenerator = convention.GetGenerator();
+        var fallbackGenerator = fallback.GetGenerator();
 
-        path = path ?? throw new ArgumentNullException(nameof(path));
-
-        var prefix = operationType switch
-        {
-            OperationType.Get => "get",
-            OperationType.Post => "create",
-            OperationType.Put => "put",
-            OperationType.Delete => "delete",
-            OperationType.Patch => "edit",
-            OperationType.Head => "head",
-            OperationType.Options => "options",
-            OperationType.Trace => "trace",
-            _ => throw new NotSupportedException($"OperationType {operationType} is not supported."),
-        };
-        return $"{prefix}{path.TrimStart('/').ToPropertyName().UseWordSeparator('/')}";
+        return mainGenerator.TryGenerate(operation, path, operationType) ??
+               fallbackGenerator.TryGenerate(operation, path, operationType) ??
+               throw new InvalidOperationException("Failed to generate method name");
     }
 
     /// <summary>

diff --git a/src/libs/OpenApiGenerator.Core/Generators/ClientGeneratorMethods.cs b/src/libs/OpenApiGenerator.Core/Generators/ClientGeneratorMethods.cs
@@ -9,7 +9,7 @@ namespace OpenApiGenerator.Core.Generators;
 public static class ClientGeneratorMethods
 {
     public static ImmutableArray<EndPoint> PrepareData(
-        (string yaml, Settings settings) tuple,
+        (string text, Settings settings) tuple,
         CancellationToken cancellationToken = default)
     {
         var (text, settings) = tuple;
@@ -26,9 +26,19 @@ public static ImmutableArray<EndPoint> PrepareData(
         return openApiDocument.Paths.SelectMany(path =>
             path.Value.Operations
                 .Where(x =>
-                    (includedOperationIds.Count == 0 ||
-                    includedOperationIds.Contains(x.Value.GetOperationIdOrCompute(path: path.Key, operationType: x.Key))) &&
-                    !excludedOperationIds.Contains(x.Value.GetOperationIdOrCompute(path: path.Key, operationType: x.Key)))
+                {
+                    if (includedOperationIds.Count == 0 && excludedOperationIds.Count == 0)
+                    {
+                        return true;
+                    }
+
+                    var methodName = x.Value.GetMethodName(path: path.Key, operationType: x.Key,
+                        settings.MethodNamingConvention, settings.MethodNamingConventionFallback);
+
+                    return (includedOperationIds.Count == 0 ||
+                            includedOperationIds.Contains(methodName)) &&
+                           !excludedOperationIds.Contains(methodName);
+                })
                 .Select(operation => EndPoint.FromSchema(operation, settings, path.Key)))
             // Constructor
             .Concat(settings.GenerateSdk || settings.GenerateConstructors ? [new EndPoint(

diff --git a/src/libs/OpenApiGenerator.Core/Models/EndPoint.cs b/src/libs/OpenApiGenerator.Core/Models/EndPoint.cs
@@ -54,7 +54,7 @@ public static EndPoint FromSchema(
             : ModelData.FromKey("test", settings) with{ Schema = default };
         var response = operation.Value.Responses.Values.FirstOrDefault();
         var endPoint = new EndPoint(
-            Id: operation.Value.GetOperationIdOrCompute(path: path, operationType: operation.Key),
+            Id: operation.Value.GetMethodName(path: path, operationType: operation.Key, settings.MethodNamingConvention, settings.MethodNamingConventionFallback),
             Namespace: settings.Namespace,
             ClassName: settings.ClassName.Replace(".", string.Empty),
             BaseUrl: string.Empty,

diff --git a/src/libs/OpenApiGenerator.Core/Models/Settings.cs b/src/libs/OpenApiGenerator.Core/Models/Settings.cs
@@ -1,5 +1,6 @@
 using System.Collections.Immutable;
 using OpenApiGenerator.Core.Json;
+using OpenApiGenerator.Core.Naming.Methods;
 
 namespace OpenApiGenerator.Core.Models;
 
@@ -13,6 +14,8 @@ public readonly record struct Settings(
 
     bool GenerateConstructors,
     bool GenerateMethods,
+    MethodNamingConvention MethodNamingConvention,
+    MethodNamingConvention MethodNamingConventionFallback,
     bool GenerateMethodsAsHttpClientExtensions,
     bool GenerateMethodsUsingSystemNetHttpJson,
     ImmutableArray<string> IncludeOperationIds,

diff --git a/src/libs/OpenApiGenerator.Core/Naming/Methods/IMethodNameGenerator.cs b/src/libs/OpenApiGenerator.Core/Naming/Methods/IMethodNameGenerator.cs
@@ -0,0 +1,8 @@
+using Microsoft.OpenApi.Models;
+
+namespace OpenApiGenerator.Core.Naming.Methods;
+
+public interface IMethodNameGenerator
+{
+    public string? TryGenerate(OpenApiOperation operation, string path, OperationType operationType);
+}
diff --git a/src/libs/OpenApiGenerator.Core/Naming/Methods/MethodAndPathGenerator.cs b/src/libs/OpenApiGenerator.Core/Naming/Methods/MethodAndPathGenerator.cs
@@ -0,0 +1,27 @@
+using Microsoft.OpenApi.Models;
+using OpenApiGenerator.Core.Extensions;
+
+namespace OpenApiGenerator.Core.Naming.Methods;
+
+public class MethodAndPathGenerator : IMethodNameGenerator
+{
+    public string TryGenerate(OpenApiOperation operation, string path, OperationType operationType)
+    {
+        path = path ?? throw new ArgumentNullException(nameof(path));
+
+        var prefix = operationType switch
+        {
+            OperationType.Get => "get",
+            OperationType.Post => "create",
+            OperationType.Put => "put",
+            OperationType.Delete => "delete",
+            OperationType.Patch => "edit",
+            OperationType.Head => "head",
+            OperationType.Options => "options",
+            OperationType.Trace => "trace",
+            _ => throw new NotSupportedException($"OperationType {operationType} is not supported."),
+        };
+
+        return $"{prefix}{path.TrimStart('/').ToPropertyName().UseWordSeparator('/')}";
+    }
+}
diff --git a/src/libs/OpenApiGenerator.Core/Naming/Methods/MethodNamingConvention.cs b/src/libs/OpenApiGenerator.Core/Naming/Methods/MethodNamingConvention.cs
@@ -0,0 +1,22 @@
+namespace OpenApiGenerator.Core.Naming.Methods;
+
+public enum MethodNamingConvention
+{
+    SimpleOperationId,
+    MethodAndPath,
+    OperationIdWithDots,
+}
+
+public static class MethodNamingConventionExtensions
+{
+    public static IMethodNameGenerator GetGenerator(this MethodNamingConvention operation)
+    {
+        return operation switch
+        {
+            MethodNamingConvention.SimpleOperationId => new SimpleOperationIdGenerator(),
+            MethodNamingConvention.OperationIdWithDots => new OperationIdWithDotsGenerator(),
+            MethodNamingConvention.MethodAndPath => new MethodAndPathGenerator(),
+            _ => throw new ArgumentOutOfRangeException(nameof(operation), operation, null),
+        };
+    }
+}
diff --git a/src/libs/OpenApiGenerator.Core/Naming/Methods/OperationIdWithDotsGenerator.cs b/src/libs/OpenApiGenerator.Core/Naming/Methods/OperationIdWithDotsGenerator.cs
@@ -0,0 +1,23 @@
+using Microsoft.OpenApi.Models;
+using OpenApiGenerator.Core.Extensions;
+
+namespace OpenApiGenerator.Core.Naming.Methods;
+
+public class OperationIdWithDotsGenerator : IMethodNameGenerator
+{
+    public string? TryGenerate(OpenApiOperation operation, string path, OperationType operationType)
+    {
+        operation = operation ?? throw new ArgumentNullException(nameof(operation));
+
+        if (operation.OperationId is null ||
+            !operation.OperationId.Contains('.'))
+        {
+            return null;
+        }
+
+        return string.Concat(operation.OperationId
+            .Split('.')
+            .Reverse()
+            .Select(x => x.ToPropertyName()));
+    }
+}
diff --git a/src/libs/OpenApiGenerator.Core/Naming/Methods/SimpleOperationIdGenerator.cs b/src/libs/OpenApiGenerator.Core/Naming/Methods/SimpleOperationIdGenerator.cs
@@ -0,0 +1,14 @@
+using Microsoft.OpenApi.Models;
+using OpenApiGenerator.Core.Extensions;
+
+namespace OpenApiGenerator.Core.Naming.Methods;
+
+public class SimpleOperationIdGenerator : IMethodNameGenerator
+{
+    public string? TryGenerate(OpenApiOperation operation, string path, OperationType operationType)
+    {
+        operation = operation ?? throw new ArgumentNullException(nameof(operation));
+
+        return operation.OperationId?.ToPropertyName();
+    }
+}
diff --git a/src/libs/OpenApiGenerator/OpenApiGenerator.props b/src/libs/OpenApiGenerator/OpenApiGenerator.props
@@ -30,6 +30,10 @@
     <CompilerVisibleProperty Include="OpenApiGenerator_GenerateConstructors"/>
     <!-- true/false. Default: false -->
     <CompilerVisibleProperty Include="OpenApiGenerator_GenerateMethods"/>
+    <!-- SimpleOperationId/MethodAndPath/OperationIdWithDots. Default: SimpleOperationId -->
+    <CompilerVisibleProperty Include="OpenApiGenerator_MethodNamingConvention"/>
+    <!-- SimpleOperationId/MethodAndPath/OperationIdWithDots. Default: MethodAndPath -->
+    <CompilerVisibleProperty Include="OpenApiGenerator_MethodNamingConventionFallback"/>
     <!-- true/false. Default: false. Not Implemented. -->
     <CompilerVisibleProperty Include="OpenApiGenerator_GenerateMethodsAsHttpClientExtensions"/>
     <!-- true/false. Default: false. Not Implemented. -->

diff --git a/src/libs/OpenApiGenerator/OptionsExtensions.cs b/src/libs/OpenApiGenerator/OptionsExtensions.cs
@@ -5,6 +5,7 @@
 using OpenApiGenerator.Core.Models;
 using OpenApiGenerator.Core.Extensions;
 using OpenApiGenerator.Core.Json;
+using OpenApiGenerator.Core.Naming.Methods;
 
 namespace OpenApiGenerator;
 
@@ -32,6 +33,8 @@ public static Settings GetSettings(
 
             GenerateConstructors: options.GetBoolGlobalOption(nameof(Settings.GenerateConstructors), prefix),
             GenerateMethods: options.GetBoolGlobalOption(nameof(Settings.GenerateMethods), prefix),
+            MethodNamingConvention: options.GetEnumGlobalOption<MethodNamingConvention>(nameof(Settings.MethodNamingConvention), prefix),
+            MethodNamingConventionFallback: options.GetEnumGlobalOption(nameof(Settings.MethodNamingConventionFallback), prefix, defaultValue: MethodNamingConvention.MethodAndPath),
             GenerateMethodsAsHttpClientExtensions: options.GetBoolGlobalOption(nameof(Settings.GenerateMethodsAsHttpClientExtensions), prefix),
             GenerateMethodsUsingSystemNetHttpJson: options.GetBoolGlobalOption(nameof(Settings.GenerateMethodsUsingSystemNetHttpJson), prefix),
             IncludeOperationIds: (options.GetGlobalOption(nameof(Settings.IncludeOperationIds), prefix)?.Split(';') ??
@@ -69,14 +72,15 @@ public static bool GetBoolGlobalOption(
     public static T GetEnumGlobalOption<T>(
         this AnalyzerConfigOptionsProvider provider,
         string name,
-        string? prefix = null) where T : struct, Enum
+        string? prefix = null,
+        T defaultValue = default) where T : struct, Enum
     {
         provider = provider ?? throw new ArgumentNullException(nameof(provider));
         name = name ?? throw new ArgumentNullException(nameof(name));
 
         return Enum.TryParse<T>(
             provider.GetGlobalOption(name, prefix) ??
-            $"{default(T):G}",
+            $"{defaultValue:G}",
             ignoreCase: true,
             out var value) ? value : default;
     }

diff --git a/src/tests/OpenApiGenerator.SnapshotTests/Tests.cs b/src/tests/OpenApiGenerator.SnapshotTests/Tests.cs
@@ -95,9 +95,12 @@ public Task Replicate(JsonSerializerType jsonSerializerType)
     {
         return CheckSourceAsync<SdkGenerator>(jsonSerializerType, [
             new CustomAdditionalText(
-                path: H.Resources.ollamacurated_yaml.FileName,
-                text: H.Resources.ollamacurated_yaml.AsString())
-        ]);
+                path: H.Resources.replicate_json.FileName,
+                text: H.Resources.replicate_json.AsString())
+        ], new Dictionary<string, string>
+        {
+            ["build_property.OpenApiGenerator_MethodNamingConvention"] = "OperationIdWithDots",
+        });
     }
 
     [DataTestMethod]

diff --git a/src/tests/OpenApiGenerator.UnitTests/CacheTests.cs b/src/tests/OpenApiGenerator.UnitTests/CacheTests.cs
@@ -1,5 +1,6 @@
 using System.Collections.Immutable;
 using OpenApiGenerator.Core.Models;
+using OpenApiGenerator.Core.Naming.Methods;
 
 namespace OpenApiGenerator.UnitTests;
 
@@ -15,6 +16,8 @@ public class CacheTests
         UseRequiredKeyword: default,
         GenerateConstructors: false,
         GenerateMethods: false,
+        MethodNamingConvention: default,
+        MethodNamingConventionFallback: MethodNamingConvention.MethodAndPath,
         GenerateMethodsAsHttpClientExtensions: false,
         GenerateMethodsUsingSystemNetHttpJson: false,
         IncludeOperationIds: ImmutableArray.Create(["123", "456"]),

diff --git a/src/tests/OpenApiGenerator.UnitTests/ClientTests.cs b/src/tests/OpenApiGenerator.UnitTests/ClientTests.cs
@@ -2,6 +2,7 @@
 using System.Runtime.CompilerServices;
 using OpenApiGenerator.Core.Generators;
 using OpenApiGenerator.Core.Models;
+using OpenApiGenerator.Core.Naming.Methods;
 
 namespace OpenApiGenerator.UnitTests;
 
@@ -18,6 +19,8 @@ public class ClientTests :
         UseRequiredKeyword: default,
         GenerateConstructors: false,
         GenerateMethods: false,
+        MethodNamingConvention: default,
+        MethodNamingConventionFallback: MethodNamingConvention.MethodAndPath,
         GenerateMethodsAsHttpClientExtensions: false,
         GenerateMethodsUsingSystemNetHttpJson: false,
         IncludeOperationIds: [],
@@ -70,12 +73,12 @@ public Task Ollama()
     [TestMethod]
     public Task Replicate()
     {
-        var yaml = H.Resources.replicate_json.AsString();
-        var settings = DefaultSettings;
-
-        var models = ClientGeneratorMethods.PrepareData((yaml, settings));
+        var methods = ClientGeneratorMethods.PrepareData((H.Resources.replicate_json.AsString(), DefaultSettings with
+        {
+            MethodNamingConvention = MethodNamingConvention.OperationIdWithDots,
+        }));
 
-        return VerifyAsync(models);
+        return VerifyAsync(methods);
     }
 
     [TestMethod]

diff --git a/src/tests/OpenApiGenerator.UnitTests/ModelTests.cs b/src/tests/OpenApiGenerator.UnitTests/ModelTests.cs
@@ -2,6 +2,7 @@
 using System.Runtime.CompilerServices;
 using OpenApiGenerator.Core.Generators;
 using OpenApiGenerator.Core.Models;
+using OpenApiGenerator.Core.Naming.Methods;
 
 namespace OpenApiGenerator.UnitTests;
 
@@ -18,6 +19,8 @@ public class ModelTests :
         UseRequiredKeyword: default,
         GenerateConstructors: false,
         GenerateMethods: false,
+        MethodNamingConvention: default,
+        MethodNamingConventionFallback: MethodNamingConvention.MethodAndPath,
         GenerateMethodsAsHttpClientExtensions: false,
         GenerateMethodsUsingSystemNetHttpJson: false,
         IncludeOperationIds: [],
@@ -72,13 +75,11 @@ public Task Ollama()
     [TestMethod]
     public Task Replicate()
     {
-        var yaml = H.Resources.replicate_json.AsString();
-        var settings = DefaultSettings;
-
-        var models = ModelGeneratorMethods.PrepareData((yaml, settings));
+        var models = ModelGeneratorMethods.PrepareData((H.Resources.replicate_json.AsString(), DefaultSettings));
 
         return VerifyAsync(models);
     }
+
     //
     // [TestMethod]
     // public Task GitHub()