created new serialization model for better yaml support, add regex name cleaning

Author: pwelter34

docs/configuration.md

@@ -86,6 +86,16 @@ data:
     # Generate class names with prefixed schema name eg. dbo.MyTable = DboMyTable
     prefixWithSchemaName: false
 
+    # Rename entities and properties with regular expressions
+    renaming:
+      # list of regular expressions to clean entity names
+      entities:
+        - ^(sp|tbl|udf|vw)_
+
+      # list of regular expressions to clean property names
+      properties:
+        - ^{Table.Name}(?=Id|Name)
+
   # mapping class file configuration
   mapping:
     namespace: '{Project.Namespace}.Data.Mapping'   # the mapping class namespace

…rator.Core/GeneratorOptionsSerializer.cs …enerator.Core/ConfigurationSerializer.cssrc/EntityFrameworkCore.Generator.Core/GeneratorOptionsSerializer.cs renamed to src/EntityFrameworkCore.Generator.Core/ConfigurationSerializer.cs src/EntityFrameworkCore.Generator.Core/GeneratorOptionsSerializer.cs renamed to src/EntityFrameworkCore.Generator.Core/ConfigurationSerializer.cs

@@ -1,7 +1,7 @@
 using System;
 using System.IO;
 
-using EntityFrameworkCore.Generator.Options;
+using EntityFrameworkCore.Generator.Serialization;
 
 using Microsoft.Extensions.Logging;
 
@@ -11,17 +11,17 @@
 namespace EntityFrameworkCore.Generator;
 
 /// <summary>
-/// Serialization and Deserialization for the <see cref="GeneratorOptions"/> class
+/// Serialization and Deserialization for the <see cref="Generator"/> class
 /// </summary>
-public class GeneratorOptionsSerializer : IGeneratorOptionsSerializer
+public class ConfigurationSerializer : IConfigurationSerializer
 {
-    private readonly ILogger<GeneratorOptionsSerializer> _logger;
+    private readonly ILogger<ConfigurationSerializer> _logger;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="GeneratorOptionsSerializer"/> class.
+    /// Initializes a new instance of the <see cref="ConfigurationSerializer"/> class.
     /// </summary>
     /// <param name="logger">The logger.</param>
-    public GeneratorOptionsSerializer(ILogger<GeneratorOptionsSerializer> logger)
+    public ConfigurationSerializer(ILogger<ConfigurationSerializer> logger)
     {
         _logger = logger;
     }
@@ -36,8 +36,8 @@ public GeneratorOptionsSerializer(ILogger<GeneratorOptionsSerializer> logger)
     /// </summary>
     /// <param name="directory">The directory where the file is located.</param>
     /// <param name="file">The name of the options file.</param>
-    /// <returns>An instance of <see cref="GeneratorOptions"/> if the file exists; otherwise <c>null</c>.</returns>
-    public GeneratorOptions Load(string directory = null, string file = OptionsFileName)
+    /// <returns>An instance of <see cref="Generator"/> if the file exists; otherwise <c>null</c>.</returns>
+    public GeneratorModel Load(string directory = null, string file = OptionsFileName)
     {
         var path = GetPath(directory, file);
         if (!File.Exists(path))
@@ -46,20 +46,30 @@ public GeneratorOptions Load(string directory = null, string file = OptionsFileN
             return null;
         }
 
-        var factory = new GeneratorOptionsFactory();
+        _logger.LogInformation($"Loading options file: {file}");
+        using var reader = File.OpenText(path);
+
+        return Load(reader);
+    }
+
+    /// <summary>
+    /// Loads the options using the specified <paramref name="reader" />
+    /// </summary>
+    /// <param name="reader">The reader.</param>
+    /// <returns>
+    /// An instance of <see cref="Generator" />.
+    /// </returns>
+    public GeneratorModel Load(TextReader reader)
+    {
+        if (reader == null)
+            return null;
 
         var deserializer = new DeserializerBuilder()
             .WithNamingConvention(CamelCaseNamingConvention.Instance)
-            .WithObjectFactory(factory)
             .Build();
 
-        _logger.LogInformation($"Loading options file: {file}");
-        GeneratorOptions generatorOptions;
-        using (var streamReader = File.OpenText(path))
-            generatorOptions = deserializer.Deserialize<GeneratorOptions>(streamReader);
-
-        generatorOptions.Variables.ShouldEvaluate = true;
-        return generatorOptions;
+        // use Serialization model for better yaml support
+        return deserializer.Deserialize<GeneratorModel>(reader);
     }
 
     /// <summary>
@@ -69,7 +79,7 @@ public GeneratorOptions Load(string directory = null, string file = OptionsFileN
     /// <param name="directory">The directory where the file is located.</param>
     /// <param name="file">The name of the options file.</param>
     /// <returns>The full path of the options file.</returns>
-    public string Save(GeneratorOptions generatorOptions, string directory = null, string file = OptionsFileName)
+    public string Save(GeneratorModel generatorOptions, string directory = null, string file = OptionsFileName)
     {
         if (string.IsNullOrWhiteSpace(directory))
             directory = Environment.CurrentDirectory;
@@ -88,17 +98,13 @@ public string Save(GeneratorOptions generatorOptions, string directory = null, s
         var path = Path.Combine(directory, file);
 
         var serializer = new SerializerBuilder()
-            .ConfigureDefaultValuesHandling(DefaultValuesHandling.OmitNull)
+            .ConfigureDefaultValuesHandling(DefaultValuesHandling.OmitDefaults)
             .WithNamingConvention(CamelCaseNamingConvention.Instance)
             .Build();
 
-        generatorOptions.Variables.ShouldEvaluate = false;
-
         using (var streamWriter = File.CreateText(path))
             serializer.Serialize(streamWriter, generatorOptions);
 
-        generatorOptions.Variables.ShouldEvaluate = true;
-
         return path;
     }
 

src/EntityFrameworkCore.Generator.Core/GeneratorOptionsFactory.cs

@@ -1,19 +1,28 @@
-using EntityFrameworkCore.Generator.Options;
+using System.IO;
 
 namespace EntityFrameworkCore.Generator;
 
 /// <summary>
-/// <c>interface</c> for serialization and deserialization of <see cref="GeneratorOptions"/> class
+/// <c>interface</c> for serialization and deserialization of <see cref="Serialization.GeneratorModel"/> class
 /// </summary>
-public interface IGeneratorOptionsSerializer
+public interface IConfigurationSerializer
 {
     /// <summary>
     /// Loads the options file using the specified <paramref name="directory"/> and <paramref name="file"/>.
     /// </summary>
     /// <param name="directory">The directory where the file is located.</param>
     /// <param name="file">The name of the options file.</param>
-    /// <returns>An instance of <see cref="GeneratorOptions"/> if the file exists; otherwise <c>null</c>.</returns>
-    GeneratorOptions Load(string directory = null, string file = GeneratorOptionsSerializer.OptionsFileName);
+    /// <returns>An instance of <see cref="Serialization.GeneratorModel"/> if the file exists; otherwise <c>null</c>.</returns>
+    Serialization.GeneratorModel Load(string directory = null, string file = ConfigurationSerializer.OptionsFileName);
+
+    /// <summary>
+    /// Loads the options using the specified <paramref name="reader" />
+    /// </summary>
+    /// <param name="reader">The reader.</param>
+    /// <returns>
+    /// An instance of <see cref="Generator" />.
+    /// </returns>
+    Serialization.GeneratorModel Load(TextReader reader);
 
     /// <summary>
     /// Saves the generator options to the specified <paramref name="directory"/> and <paramref name="file"/>.
@@ -22,13 +31,13 @@ public interface IGeneratorOptionsSerializer
     /// <param name="directory">The directory where the file is located.</param>
     /// <param name="file">The name of the options file.</param>
     /// <returns>The full path of the options file.</returns>
-    string Save(GeneratorOptions generatorOptions, string directory = null, string file = GeneratorOptionsSerializer.OptionsFileName);
+    string Save(Serialization.GeneratorModel generatorOptions, string directory = null, string file = ConfigurationSerializer.OptionsFileName);
 
     /// <summary>
     /// Determines if the specified options file exists.
     /// </summary>
     /// <param name="directory">The directory where the file is located.</param>
     /// <param name="file">The name of the options file.</param>
     /// <returns><c>true</c> if options file exits; otherwise <c>false</c>.</returns>
-    bool Exists(string directory = null, string file = GeneratorOptionsSerializer.OptionsFileName);
-}
+    bool Exists(string directory = null, string file = ConfigurationSerializer.OptionsFileName);
+}

…ator.Core/IGeneratorOptionsSerializer.cs …nerator.Core/IConfigurationSerializer.cssrc/EntityFrameworkCore.Generator.Core/IGeneratorOptionsSerializer.cs renamed to src/EntityFrameworkCore.Generator.Core/IConfigurationSerializer.cs src/EntityFrameworkCore.Generator.Core/IGeneratorOptionsSerializer.cs renamed to src/EntityFrameworkCore.Generator.Core/IConfigurationSerializer.cs

@@ -195,7 +195,16 @@ private void CreateProperties(Entity entity, IEnumerable<DatabaseColumn> columns
                 entity.Properties.Add(property);
             }
 
-            string propertyName = ToPropertyName(entity.EntityClass, column.Name);
+            string name = ToPropertyName(entity.EntityClass, column.Name);
+            string propertyName = name;
+
+            foreach (var selection in _options.Data.Entity.Renaming.Properties.Where(p => p.Expression.HasValue()))
+                propertyName = Regex.Replace(propertyName, selection.Expression, string.Empty);
+
+            // make sure regex doesn't remove everything
+            if (propertyName.IsNullOrEmpty())
+                propertyName = name;
+
             propertyName = _namer.UniqueName(entity.EntityClass, propertyName);
 
             property.PropertyName = propertyName;
@@ -590,7 +599,12 @@ private string EntityName(string name)
         else if (tableNaming != TableNaming.Singular && entityNaming == EntityNaming.Singular)
             name = name.Singularize(false);
 
-        return name;
+        var rename = name;
+        foreach (var selection in _options.Data.Entity.Renaming.Entities.Where(p => p.Expression.HasValue()))
+            rename = Regex.Replace(rename, selection.Expression, string.Empty);
+
+        // make sure regex doesn't remove everything
+        return rename.HasValue() ? rename : name;
     }