general refactoring around the C# code

DaredevilOSS · Jun 27, 2024 · 597022a · 597022a
1 parent 603680c
commit 597022a
Show file tree

Hide file tree

Showing 10 changed files with 88 additions and 64 deletions.
diff --git a/CodeGenerator/CodeGenerator.cs b/CodeGenerator/CodeGenerator.cs
@@ -3,6 +3,7 @@
 using RubyCodegen;
 using SqlcGenCsharp.Drivers;
 using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
@@ -13,7 +14,7 @@ namespace SqlcGenCsharp;
 
 public class CodeGenerator
 {
-    public const string AutoGeneratedComment = "# auto-generated by sqlc - do not edit";
+    private const string AutoGeneratedComment = "# auto-generated by sqlc - do not edit";
 
     private DbDriver? _dbDriver;
     private Options? _options;
@@ -48,7 +49,6 @@ public Task<GenerateResponse> Generate(GenerateRequest generateRequest)
         var files = fileQueries
             .Select(fq => GenerateFile(fq.Value, fq.Key))
             .AppendIfNotNull(GenerateGemfile());
-
         return Task.FromResult(new GenerateResponse { Files = { files } });
 
         Dictionary<string, Query[]> GetFileQueries()
@@ -77,14 +77,18 @@ private File GenerateFile(IList<Query> queries, string className)
 
                         {moduleDeclaration.Build()}
                         """;
-        return new File { Name = $"{className.SnakeCase()}.rb", Contents = ByteString.CopyFromUtf8(contents) };
+        return new File
+        {
+            Name = $"{className.SnakeCase()}.rb",
+            Contents = ByteString.CopyFromUtf8(contents)
+        };
     }
 
     private File? GenerateGemfile()
     {
         if (!Options.GenerateGemfile)
             return null;
-        var requireGems = DbDriver.GetRequiredGems().Select(gem => $"gem '{gem.GetName()}'").JoinByNewLine();
+        var requireGems = DbDriver.GetRequiredGems().Select(gem => $"gem '{gem.Name()}'").JoinByNewLine();
         return new File
         {
             Name = "Gemfile",
@@ -120,7 +124,10 @@ ModuleDeclaration GetModuleDeclaration()
 
         ClassDeclaration GetClassDeclaration()
         {
-            return new ClassDeclaration(className, new[] { initMethod }.Concat(queries.Select(GetMethodDeclaration)));
+            return new ClassDeclaration(
+                className,
+                new[] { initMethod }.Concat(queries.Select(GetMethodDeclaration))
+            );
         }
     }
 
@@ -129,10 +136,7 @@ private static SimpleStatement GenerateDataclass(string name, ClassMember classM
     {
         var dataclassName = $"{name.FirstCharToUpper()}{classMember.Name()}";
         var dataColumns = columns.Select(c => $":{c.Name.ToLower()}").ToList();
-        var dataColumnsStr = dataColumns.Count < 5
-            ? dataColumns.JoinByComma().Indent() :
-            $"\n{dataColumns.JoinByCommaAndNewLine().Indent()}\n";
-
+        var dataColumnsStr = dataColumns.JoinByCommaAndFormat();
         return new SimpleStatement(dataclassName,
             new SimpleExpression(options.RubyVersion.LatestRubySupported()
                 ? $"Struct.new({dataColumnsStr})"

diff --git a/Drivers/ClassMember.cs b/Drivers/ClassMember.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace SqlcGenCsharp;
+namespace SqlcGenCsharp.Drivers;
 
 public enum ClassMember
 {

diff --git a/Drivers/MethodGen.cs b/Drivers/MethodGen.cs
@@ -24,12 +24,12 @@ public MethodDeclaration OneDeclare(string funcName, string queryTextConstant, s
                     new SimpleStatement($"{Variable.Entity.AsVar()}", newObjectExpression),
                     new SimpleExpression($"return {Variable.Entity.AsVar()}")
                 ]
-        );
+            ).ToList();
 
         return new MethodDeclaration(funcName, GetMethodArgs(argInterface, parameters),
             new List<IComposable>
             {
-                new WithResource(Variable.Pool.AsProperty(), Variable.Client.AsVar(), withResourceBody)
+                new WithResource(Variable.Pool.AsProperty(), Variable.Client.AsVar(), withResourceBody.ToList())
             });
     }
 
@@ -52,15 +52,16 @@ public MethodDeclaration ManyDeclare(string funcName, string queryTextConstant,
                     dbDriver.PrepareStmt(funcName, queryTextConstant),
                     ExecuteAndAssign(funcName, queryParams),
                     new SimpleStatement(Variable.Entities.AsVar(), new SimpleExpression("[]")),
-                    new ForeachLoop(Variable.Result.AsVar(), Variable.Row.AsVar(), new List<IComposable> { listAppend }),
+                    new ForeachLoop(Variable.Result.AsVar(), Variable.Row.AsVar(),
+                        new List<IComposable> { listAppend }),
                     new SimpleExpression($"return {Variable.Entities.AsVar()}")
                 ]
-        );
+            );
 
         return new MethodDeclaration(funcName, GetMethodArgs(argInterface, parameters),
             new List<IComposable>
             {
-                new WithResource(Variable.Pool.AsProperty(), Variable.Client.AsVar(), withResourceBody)
+                new WithResource(Variable.Pool.AsProperty(), Variable.Client.AsVar(), withResourceBody.ToList())
             });
     }
 
@@ -72,12 +73,14 @@ public MethodDeclaration ExecDeclare(string funcName, string queryTextConstant,
         withResourceBody = withResourceBody.AppendIfNotNull(queryParams);
         withResourceBody = withResourceBody
             .Append(dbDriver.PrepareStmt(funcName, queryTextConstant))
-            .Append(dbDriver.ExecuteStmt(funcName, queryParams));
+            .Append(dbDriver.ExecuteStmt(funcName, queryParams))
+            .ToList();
 
         return new MethodDeclaration(funcName, GetMethodArgs(argInterface, parameters),
             new List<IComposable>
             {
-                new WithResource(Variable.Pool.AsProperty(), Variable.Client.AsVar(), withResourceBody)
+                new WithResource(Variable.Pool.AsProperty(), Variable.Client.AsVar(), withResourceBody.ToList()
+                )
             });
     }
 
@@ -95,24 +98,29 @@ public MethodDeclaration ExecLastIdDeclare(string funcName, string queryTextCons
                     new SimpleExpression($"return {Variable.Client.AsVar()}.last_id")
                 ]
             );
-        return new MethodDeclaration(funcName, GetMethodArgs(argInterface, parameters),
+
+        return new MethodDeclaration(
+            funcName, GetMethodArgs(argInterface, parameters),
             new List<IComposable>
             {
-                new WithResource(Variable.Pool.AsProperty(), Variable.Client.AsVar(), withResourceBody)
-            });
+                new WithResource(Variable.Pool.AsProperty(), Variable.Client.AsVar(),
+                    withResourceBody.ToList())
+            }
+        );
     }
 
     private static SimpleStatement? GetQueryParams(string argInterface, IList<Parameter> parameters)
     {
         var queryParams = parameters.Select(p => $"{argInterface}.{p.Column.Name}").ToList();
         return queryParams.Count == 0
             ? null
-            : new SimpleStatement(Variable.QueryParams.AsVar(), new SimpleExpression($"[{queryParams.JoinByComma()}]"));
+            : new SimpleStatement(Variable.QueryParams.AsVar(),
+                new SimpleExpression($"[{queryParams.JoinByCommaAndFormat()}]"));
     }
 
-    private static IEnumerable<SimpleExpression> GetColumnsInitExpressions(IEnumerable<Column> columns)
+    private static IList<SimpleExpression> GetColumnsInitExpressions(IList<Column> columns)
     {
-        return columns.Select(c => new SimpleExpression($"{Variable.Row.AsVar()}['{c.Name}']"));
+        return columns.Select(c => new SimpleExpression($"{Variable.Row.AsVar()}['{c.Name}']")).ToList();
     }
 
     private SimpleStatement ExecuteAndAssign(string funcName, SimpleStatement? queryParams)

diff --git a/Drivers/PgDriver.cs b/Drivers/PgDriver.cs
@@ -35,7 +35,7 @@ public override MethodDeclaration GetInitMethod()
             ]
         );
 
-        IEnumerable<IComposable> PgClientCreate()
+        IList<IComposable> PgClientCreate()
         {
             return new List<IComposable>
             {

diff --git a/Extensions/ListExtensions.cs b/Extensions/ListExtensions.cs
@@ -2,6 +2,8 @@
 
 public static class ListExtensions
 {
+    private const int MaxElementsPerLine = 5;
+
     public static IEnumerable<T> AppendIfNotNull<T>(this IEnumerable<T> me, T? item)
     {
         return item is not null ? me.Append(item) : me;
@@ -12,13 +14,10 @@ public static string JoinByNewLine(this IEnumerable<string> me, int cnt = 1)
         return string.Join(new string('\n', cnt), me);
     }
 
-    public static string JoinByComma(this IEnumerable<string> me)
-    {
-        return string.Join(", ", me);
-    }
-
-    public static string JoinByCommaAndNewLine(this IEnumerable<string> me)
+    public static string JoinByCommaAndFormat(this IList<string> me)
     {
-        return string.Join(",\n", me);
+        return me.Count < MaxElementsPerLine
+            ? string.Join(", ", me).Indent()
+            : $"\n{string.Join(",\n", me).Indent()}\n";
     }
 }
diff --git a/PluginOptions/Options.cs b/PluginOptions/Options.cs
@@ -21,8 +21,8 @@ public Options(GenerateRequest generateRequest)
 
         Enum.TryParse(rawOptions.DriverName, true, out DriverName outDriverName);
         DriverName = outDriverName;
-        GenerateGemfile = rawOptions.GenerateCsproj;
-        RubyVersion = DotnetFrameworkExtensions.ParseName(rawOptions.TargetFramework);
+        GenerateGemfile = rawOptions.GenerateGemfile;
+        RubyVersion = RubyVersionExtensions.ParseName(rawOptions.RubyVersionPattern);
     }
 
     public DriverName DriverName { get; }

diff --git a/PluginOptions/RawOptions.cs b/PluginOptions/RawOptions.cs
@@ -6,11 +6,11 @@ internal class RawOptions
 {
     [JsonPropertyName("driver")] public required string DriverName { get; init; }
 
-    [JsonPropertyName("generateCsproj")]
-    public bool GenerateCsproj { get; init; } = true; // generating .csproj files by default
+    [JsonPropertyName("generateGemfile")]
+    public bool GenerateGemfile { get; init; } // not generating Gemfile files by default
 
-    [JsonPropertyName("targetFramework")]
-    public string TargetFramework { get; init; } = RubyVersion.Ruby1.ToName();
+    [JsonPropertyName("rubyVersionPattern")]
+    public string RubyVersionPattern { get; init; } = RubyVersion.V33.ToString();
 
     [JsonPropertyName("filePerQuery")] public bool FilePerQuery { get; init; } // generating single file by default
 }
diff --git a/PluginOptions/RubyMajorVersion.cs b/PluginOptions/RubyMajorVersion.cs
@@ -1,38 +1,51 @@
-using System.Collections.Generic;
-using System.Linq;
+using System;
+using System.Text.RegularExpressions;
+using Enum = System.Enum;
 
 namespace SqlcGenCsharp;
 
 public enum RubyVersion
 {
-    Ruby1,
-    Ruby2,
-    Ruby3
+    V31,
+    V32,
+    V33
 }
 
-public static class DotnetFrameworkExtensions
+public static partial class RubyVersionExtensions
 {
-    private static readonly Dictionary<RubyVersion, string> EnumToString = new()
+    public static RubyVersion ParseName(string versionPattern)
     {
-        { RubyVersion.Ruby1, "ruby1.0" },
-        { RubyVersion.Ruby2, "ruby2.7" },
-        { RubyVersion.Ruby3, "ruby3.3" }
-    };
+        var semanticVersionRegex = SemanticVersionRegex();
+        var match = semanticVersionRegex.Match(versionPattern);
+        if (!match.Success)
+            throw new ArgumentException($"version {versionPattern} can't be parsed to a ruby version");
 
-    public static string ToName(this RubyVersion me)
-    {
-        return EnumToString[me];
-    }
+        var major = short.Parse(match.Groups[1].Value);
+        if (major != 3)
+            throw new ArgumentException($"Ruby versions older than Ruby3 are not supported");
 
-    public static RubyVersion ParseName(string dotnetFramework)
-    {
-        return EnumToString
-            .ToDictionary(x => x.Value, x => x.Key)
-            [dotnetFramework];
+        short? minor = null;
+        if (match.Groups[2].Success)
+            minor = short.Parse(match.Groups[2].Value);
+        if ((minor is < 1 or > 3))
+            throw new ArgumentException($"Ruby versions newer than Ruby3.3 do not exist");
+
+        // short? patch = null; patch version is currently not interesting
+        // if (match.Groups[3].Success)
+        //    patch = short.Parse(match.Groups[3].Value);
+
+        var rubyVersionStr = $"V{major}.{minor}";
+        var valid = Enum.TryParse(rubyVersionStr, out RubyVersion rubyVersion);
+        if (!valid)
+            throw new ArgumentException($"Failed to parse {rubyVersionStr} to {nameof(RubyVersion)}");
+        return rubyVersion;
     }
 
     public static bool LatestRubySupported(this RubyVersion me)
     {
-        return me == RubyVersion.Ruby3;
+        return me is RubyVersion.V32 or RubyVersion.V33;
     }
+
+    [GeneratedRegex(@"^(0|[1-9][0-9]*)(?:\.(0|[1-9][0-9]*))?(?:\.(0|[1-9][0-9]*))?$")]
+    private static partial Regex SemanticVersionRegex();
 }
diff --git a/RubySyntax/Basic.cs b/RubySyntax/Basic.cs
@@ -9,7 +9,7 @@ public string Build()
         return $"require '{gem}'";
     }
 
-    public string GetName()
+    public string Name()
     {
         return gem;
     }

diff --git a/RubySyntax/Flows.cs b/RubySyntax/Flows.cs
@@ -2,7 +2,7 @@
 
 namespace RubyCodegen;
 
-public class WithResource(string resourceFrom, string resourceName, IEnumerable<IComposable> statements) : IComposable
+public class WithResource(string resourceFrom, string resourceName, IList<IComposable> statements) : IComposable
 {
     public string Build()
     {
@@ -50,14 +50,14 @@ public string Build()
     }
 }
 
-public class NewObject(string objectType, IEnumerable<SimpleExpression> initExpressions,
-    IEnumerable<IComposable>? bodyStatements = null) : IComposable
+public class NewObject(string objectType, IList<SimpleExpression> initExpressions,
+    IList<IComposable>? bodyStatements = null) : IComposable
 {
     public string Build()
     {
         var initParams = initExpressions
             .Select(e => e.Build())
-            .JoinByCommaAndNewLine()
+            .JoinByNewLine()
             .Indent();
         var baseCommand = $"{objectType}.new(\n{initParams}\n)";
         if (bodyStatements is null)
@@ -72,7 +72,7 @@ public string Build()
     }
 }
 
-public class ForeachLoop(string collectionVar, string controlVar, IEnumerable<IComposable> statements) : IComposable
+public class ForeachLoop(string collectionVar, string controlVar, IList<IComposable> statements) : IComposable
 {
     public string Build()
     {