Config changes

platyscript · platyscript · commit 9de59d8b78a7 · 2026-01-10T10:56:22.000+05:30
diff --git a/sample.yaml b/sample.yaml
@@ -0,0 +1,49 @@
+# the connection string to the database
+connectionString: "Data Source=(local);Initial Catalog=Tracker;Integrated Security=True"
+
+# the database provider name. Default:SqlServer
+provider: SqlServer
+
+# config name to read the connection string from the user secrets file
+connectionName: "ConnectionStrings:Generator"
+
+# the user secret identifier, can be shared with .net core project
+userSecretsId: "984ef0cf-2b22-4fd1-876d-e01499da4c1f"
+
+# the directory to output the configuration. Default is current.
+outputDirectory: .\
+
+# tables to include or empty to include all
+tables:
+  - Priority
+  - Status
+  - Task
+  - User
+
+# schemas to include or empty to include all
+schemas:
+  - dbo
+
+# exclude tables or columns
+exclude:
+  # list of expressions for tables to exclude, source is Schema.TableName
+  tables:
+    - exact: dbo.SchemaVersions
+    - regex: dbo\.SchemaVersions$
+  # list of expressions for columns to exclude, source is Schema.TableName.ColumnName
+  columns:
+    - exact: dbo.SchemaVersions\.Version
+    - regex: dbo\.SchemaVersions\.Version$
+
+# how to generate entity class names from the table name. Preserve|Plural|Singular. Default: Singular
+entityNaming: Singular
+
+# how to generate relationship collections names for the entity.  Default: Plural
+relationshipNaming: Plural
+
+# Rename entities and properties with regular expressions.  Matched expressions will be removed.
+renaming:
+  entities:
+    - ^(sp|tbl|udf|vw)_
+  properties:
+    - ^{Table.Name}(?=Id|Name)
diff --git a/src/DbApiBuilderEntityGenerator.Core/ConfigurationSerializer.cs b/src/DbApiBuilderEntityGenerator.Core/ConfigurationSerializer.cs
@@ -25,7 +25,7 @@ public ConfigurationSerializer(ILogger<ConfigurationSerializer> logger)
   /// <summary>
   /// The options file name. Default 'generation.yml'
   /// </summary>
-  public const string OptionsFileName = "generation.yml";
+  public const string OptionsFileName = "sample.yaml";
 
   /// <summary>
   /// Loads the options file using the specified <paramref name="directory"/> and <paramref name="file"/>.
diff --git a/src/DbApiBuilderEntityGenerator.Core/OptionMapper.cs b/src/DbApiBuilderEntityGenerator.Core/OptionMapper.cs
@@ -0,0 +1,92 @@
+using System;
+using DbApiBuilderEntityGenerator.Core.Options;
+using DbApiBuilderEntityGenerator.Core.Serialization;
+
+namespace DbApiBuilderEntityGenerator.Core;
+
+public static class OptionMapper
+{
+  public static GeneratorOptions Map(GeneratorModel generator)
+  {
+    var options = new GeneratorOptions();
+    options.Variables.ShouldEvaluate = false;
+    options.ConnectionName = generator.ConnectionName;
+    options.ConnectionString = generator.ConnectionString;
+    options.ConnectionName = generator.ConnectionName;
+    options.UserSecretsId = generator.UserSecretsId;
+    MapList(options.Tables, generator.Tables);
+    MapList(options.Schemas, generator.Schemas);
+    MapDatabaseMatch(options.Exclude, generator.Exclude);
+    options.EntityNaming = generator.EntityNaming;
+    options.RelationshipNaming = generator.RelationshipNaming;
+    MapSelection(options.Renaming, generator.Renaming);
+
+    options.Variables.ShouldEvaluate = true;
+
+    return options;
+  }
+  private static void MapSelection(SelectionOptions option, SelectionModel? selection)
+  {
+    if (selection == null)
+      return;
+
+    MapList(option.Entities, selection.Entities, (match) =>
+    {
+      var prefix = OptionsBase.AppendPrefix(option.Prefix, $"Entity{option.Entities.Count:0000}");
+      return MapMatch(option.Variables, match, prefix);
+    });
+
+    MapList(option.Properties, selection.Properties, (match) =>
+    {
+      var prefix = OptionsBase.AppendPrefix(option.Prefix, $"Property{option.Properties.Count:0000}");
+      return MapMatch(option.Variables, match, prefix);
+    });
+  }
+  private static void MapList<T>(IList<T> targetList, IList<T>? sourceList)
+  {
+    if (sourceList == null || sourceList.Count == 0)
+      return;
+
+    foreach (var source in sourceList)
+      targetList.Add(source);
+  }
+
+  private static void MapList<TTarget, TSource>(IList<TTarget> targetList, IList<TSource>? sourceList, Func<TSource, TTarget> factory)
+  {
+    if (sourceList == null || sourceList.Count == 0)
+      return;
+
+    foreach (var source in sourceList)
+    {
+      var target = factory(source);
+      targetList.Add(target);
+    }
+  }
+
+  private static MatchOptions MapMatch(VariableDictionary variables, MatchModel match, string? prefix)
+  {
+    return new MatchOptions()
+    {
+      Exact = match.Exact,
+      Expression = match.Expression
+    };
+  }
+
+  private static void MapDatabaseMatch(DatabaseMatchOptions option, DatabaseMatchModel? match)
+  {
+    if (match == null)
+      return;
+
+    MapList(option.Tables, match.Tables, (match) =>
+    {
+      var prefix = OptionsBase.AppendPrefix(option.Prefix, $"Table{option.Tables?.Count:0000}");
+      return MapMatch(option.Variables, match, prefix);
+    });
+
+    MapList(option.Columns, match.Columns, (match) =>
+    {
+      var prefix = OptionsBase.AppendPrefix(option.Prefix, $"Column{option.Columns?.Count:0000}");
+      return MapMatch(option.Variables, match, prefix);
+    });
+  }
+}
diff --git a/src/DbApiBuilderEntityGenerator.Core/Options/DatabaseMatchOptions.cs b/src/DbApiBuilderEntityGenerator.Core/Options/DatabaseMatchOptions.cs
@@ -12,8 +12,7 @@ public class DatabaseMatchOptions : OptionsBase
   /// </summary>
   /// <param name="variables">A dictionary of variables used to configure the matching options. Cannot be null.</param>
   /// <param name="prefix">An optional prefix used to filter or qualify the matching criteria. Can be null.</param>
-  public DatabaseMatchOptions(VariableDictionary variables, string? prefix)
-      : base(variables, prefix)
+  public DatabaseMatchOptions()
   {
     Tables = [];
     Columns = [];
diff --git a/src/DbApiBuilderEntityGenerator.Core/Options/GeneratorOptions.cs b/src/DbApiBuilderEntityGenerator.Core/Options/GeneratorOptions.cs
@@ -11,17 +11,17 @@ public class GeneratorOptions : OptionsBase
   /// <summary>
   /// Initializes a new instance of the <see cref="GeneratorOptions"/> class.
   /// </summary>
-  public GeneratorOptions(VariableDictionary variables,
-    string? prefix) : base(variables, null)
+  public GeneratorOptions()
   {
-    Variables = variables;
+    Variables = new VariableDictionary();
     Provider = DatabaseProviders.SqlServer;
     Directory = @".\";
     Tables = [];
     Schemas = [];
-    Exclude = new DatabaseMatchOptions(Variables, Prefix);
+    Exclude = new DatabaseMatchOptions();
     EntityNaming = EntityNaming.Singular;
     RelationshipNaming = RelationshipNaming.Plural;
+    Renaming = new SelectionOptions();
   }
 
   [YamlIgnore]
diff --git a/src/DbApiBuilderEntityGenerator.Core/Options/MatchOptions.cs b/src/DbApiBuilderEntityGenerator.Core/Options/MatchOptions.cs
@@ -15,8 +15,7 @@ public class MatchOptions : OptionsBase
   /// </summary>
   /// <param name="variables">The shared variables dictionary.</param>
   /// <param name="prefix">The variable key prefix.</param>
-  public MatchOptions(VariableDictionary variables, string? prefix)
-      : base(variables, prefix)
+  public MatchOptions()
   {
   }
 
diff --git a/src/DbApiBuilderEntityGenerator.Core/Options/OptionsBase.cs b/src/DbApiBuilderEntityGenerator.Core/Options/OptionsBase.cs
@@ -12,12 +12,11 @@ public class OptionsBase
   /// </summary>
   /// <param name="variables">The shared variables dictionary.</param>
   /// <param name="prefix">The variable key prefix.</param>
-  public OptionsBase(VariableDictionary variables, string? prefix)
+  public OptionsBase()
   {
-    ArgumentNullException.ThrowIfNull(variables);
 
   }
-  public VariableDictionary Variables { get; }
+  public VariableDictionary Variables { get; } = new VariableDictionary();
 
   public string? Prefix { get; }
 
diff --git a/src/DbApiBuilderEntityGenerator.Core/Options/SelectionOptions.cs b/src/DbApiBuilderEntityGenerator.Core/Options/SelectionOptions.cs
@@ -10,8 +10,7 @@ public class SelectionOptions : OptionsBase
   /// <summary>
   /// Initializes a new instance of the <see cref="SelectionOptions"/> class.
   /// </summary>
-  public SelectionOptions(VariableDictionary variables, string? prefix)
-      : base(variables, prefix)
+  public SelectionOptions()
   {
     Entities = [];
     Properties = [];
diff --git a/src/DbApiBuilderEntityGenerator.Core/SecretsStore.cs b/src/DbApiBuilderEntityGenerator.Core/SecretsStore.cs
@@ -0,0 +1,79 @@
+using System;
+using System.Text.Json;
+using DbApiBuilderEntityGenerator.Core.Extensions;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Configuration.UserSecrets;
+
+namespace DbApiBuilderEntityGenerator.Core;
+
+public class SecretsStore
+{
+  private readonly string _secretsFilePath;
+  private readonly IDictionary<string, string?> _secrets;
+
+  public SecretsStore(string userSecretsId)
+  {
+    if (string.IsNullOrEmpty(userSecretsId))
+      throw new ArgumentException("Value cannot be null or empty.", nameof(userSecretsId));
+
+    _secretsFilePath = PathHelper.GetSecretsPathFromSecretsId(userSecretsId);
+
+    // workaround bug in configuration
+    var secretDir = Path.GetDirectoryName(_secretsFilePath);
+    if (secretDir.HasValue() && !Directory.Exists(secretDir))
+      Directory.CreateDirectory(secretDir);
+
+    _secrets = Load(userSecretsId);
+  }
+
+  public string? this[string key] => _secrets[key];
+
+  public int Count => _secrets.Count;
+
+  public bool ContainsKey(string key) => _secrets.ContainsKey(key);
+
+  public IEnumerable<KeyValuePair<string, string?>> AsEnumerable() => _secrets;
+
+  public void Clear() => _secrets.Clear();
+
+  public void Set(string key, string value) => _secrets[key] = value;
+
+  public void Remove(string key)
+  {
+    _secrets.Remove(key);
+  }
+
+  public virtual void Save()
+  {
+    var secretDir = Path.GetDirectoryName(_secretsFilePath);
+    if (secretDir.HasValue() && !Directory.Exists(secretDir))
+      Directory.CreateDirectory(secretDir);
+
+    var options = new JsonWriterOptions
+    {
+      Indented = true
+    };
+
+    using var stream = File.Create(_secretsFilePath);
+    using var writer = new Utf8JsonWriter(stream, options);
+
+    writer.WriteStartObject();
+
+    foreach (var secret in _secrets.AsEnumerable())
+      writer.WriteString(secret.Key, secret.Value);
+
+    writer.WriteEndObject();
+    writer.Flush();
+  }
+
+  protected virtual IDictionary<string, string?> Load(string userSecretsId)
+  {
+    return new ConfigurationBuilder()
+        .AddJsonFile(_secretsFilePath, optional: true)
+        .Build()
+        .AsEnumerable()
+        .Where(i => i.Value != null)
+        .ToDictionary(i => i.Key, i => i.Value, StringComparer.OrdinalIgnoreCase);
+  }
+
+}
diff --git a/src/DbApiBuilderEntityGenerator/CommandBase.cs b/src/DbApiBuilderEntityGenerator/CommandBase.cs
@@ -0,0 +1,23 @@
+using System;
+using McMaster.Extensions.CommandLineUtils;
+using Microsoft.Extensions.Logging;
+
+namespace DbApiBuilderEntityGenerator;
+
+[HelpOption("--help")]
+public abstract class CommandBase
+{
+
+  protected CommandBase(ILoggerFactory logger, IConsole console)
+  {
+    Logger = logger.CreateLogger(GetType());
+    Console = console;
+  }
+
+  protected ILogger Logger { get; }
+
+  protected IConsole Console { get; }
+
+  protected abstract int OnExecute(CommandLineApplication application);
+
+}
diff --git a/src/DbApiBuilderEntityGenerator/DbApiBuilderEntityGenerator.csproj b/src/DbApiBuilderEntityGenerator/DbApiBuilderEntityGenerator.csproj
@@ -37,12 +37,18 @@
     <PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="4.1.1" />
     <PackageReference Include="Serilog.Extensions.Hosting" Version="10.0.0" />
     <PackageReference Include="Serilog.Sinks.Console" Version="6.1.1" />
+    <PackageReference Include="AssemblyMetadata.Generators" Version="2.1.0" PrivateAssets="All" />
+    <PackageReference Include="MinVer" Version="6.0.0" PrivateAssets="All" />
   </ItemGroup>
 
   <ItemGroup>
     <ExeFiles Include="$(TargetDir)\**\*"/>
   </ItemGroup>
 
+  <ItemGroup Condition="'$(Configuration)' == 'Debug'">
+    <None Update="sample.yaml" CopyToOutputDirectory="PreserveNewest" />
+  </ItemGroup>
+
   <Target Name="CopyDLLs" AfterTargets="Build">
     <Message Text="Executing CopyDLLs task" Importance="High" />
 
diff --git a/src/DbApiBuilderEntityGenerator/GenerateCommand.cs b/src/DbApiBuilderEntityGenerator/GenerateCommand.cs
@@ -0,0 +1,53 @@
+using System;
+using DbApiBuilderEntityGenerator.Core;
+using DbApiBuilderEntityGenerator.Core.Extensions;
+using DbApiBuilderEntityGenerator.Core.Options;
+using DbApiBuilderEntityGenerator.Core.Serialization;
+using McMaster.Extensions.CommandLineUtils;
+using Microsoft.Extensions.Logging;
+
+namespace DbApiBuilderEntityGenerator;
+
+[Command("generate", "gen")]
+public class GenerateCommand : OptionsCommandBase
+{
+  public GenerateCommand(ILoggerFactory logger, IConsole console, IConfigurationSerializer serializer) : base(logger, console, serializer)
+  {
+  }
+
+  [Option("-p <Provider>", Description = "Database provider to reverse engineer")]
+  public DatabaseProviders? Provider { get; set; }
+
+  [Option("-c <ConnectionString>", Description = "Database connection string to reverse engineer")]
+  public string? ConnectionString { get; set; }
+
+
+  protected override int OnExecute(CommandLineApplication application)
+  {
+    var workingDirectory = OutputDirectory ?? Environment.CurrentDirectory;
+    var configurationFile = OptionsFile ?? ConfigurationSerializer.OptionsFileName;
+
+    var configuration = Serializer.Load(workingDirectory, configurationFile);
+    if (configuration == null)
+    {
+      Logger.LogInformation("Using default options");
+      configuration = new GeneratorModel();
+    }
+
+    // override options
+    if (ConnectionString.HasValue())
+      configuration.ConnectionString = ConnectionString;
+
+    if (Provider.HasValue)
+      configuration.Provider = Provider.Value;
+
+
+    // convert to options format to support variables
+    var options = OptionMapper.Map(configuration);
+
+    //    var result = _codeGenerator.Generate(options);
+
+    return 0;
+
+  }
+}
diff --git a/src/DbApiBuilderEntityGenerator/InitializeCommand.cs b/src/DbApiBuilderEntityGenerator/InitializeCommand.cs
diff --git a/src/DbApiBuilderEntityGenerator/OptionsCommandBase.cs b/src/DbApiBuilderEntityGenerator/OptionsCommandBase.cs
diff --git a/src/DbApiBuilderEntityGenerator/Program.cs b/src/DbApiBuilderEntityGenerator/Program.cs

Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,7 @@ public class MatchOptions : OptionsBase`
`15`	`15`	`/// </summary>`
`16`	`16`	`/// <param name="variables">The shared variables dictionary.</param>`
`17`	`17`	`/// <param name="prefix">The variable key prefix.</param>`
`18`		`- public MatchOptions(VariableDictionary variables, string? prefix)`
`19`		`- : base(variables, prefix)`
	`18`	`+ public MatchOptions()`
`20`	`19`	`{`
`21`	`20`	`}`
`22`	`21`
Original file line number	Diff line number	Diff line change
`@@ -12,12 +12,11 @@ public class OptionsBase`
`12`	`12`	`/// </summary>`
`13`	`13`	`/// <param name="variables">The shared variables dictionary.</param>`
`14`	`14`	`/// <param name="prefix">The variable key prefix.</param>`
`15`		`- public OptionsBase(VariableDictionary variables, string? prefix)`
	`15`	`+ public OptionsBase()`
`16`	`16`	`{`
`17`		`- ArgumentNullException.ThrowIfNull(variables);`
`18`	`17`
`19`	`18`	`}`
`20`		`- public VariableDictionary Variables { get; }`
	`19`	`+ public VariableDictionary Variables { get; } = new VariableDictionary();`
`21`	`20`
`22`	`21`	`public string? Prefix { get; }`
`23`	`22`