Adds new option to code-generation to allow for setting the classes t…

…hat are generated for Stored Procedures and Functions as internal.
ErikEJ · Jan 6, 2025 · 853a016 · 853a016
1 parent 7a6c91d
commit 853a016
Show file tree

Hide file tree

Showing 18 changed files with 67 additions and 28 deletions.
diff --git a/samples/efcpt-config.schema.json b/samples/efcpt-config.schema.json
@@ -272,6 +272,11 @@
           "type": "boolean",
           "title": "Use stored procedure, stored procedure result and function names from the database",
           "default": true
+        },
+        "use-internal-access-modifiers-for-sprocs-and-functions": {
+          "type": "boolean",
+          "title": "When generating the stored procedure classes and helpers, set them to internal instead of public.",
+          "default": false
         }
       }
     },

diff --git a/samples/efcpt-schema.json b/samples/efcpt-schema.json
@@ -461,6 +461,14 @@
                     "examples": [
                         false
                     ]
+                },
+                "use-internal-access-modifiers-for-sprocs-and-functions": {
+                  "type": "boolean",
+                  "title": "When generating the stored procedure classes and helpers, set them to internal instead of public.",
+                  "default": false,
+                  "examples": [
+                      true
+                  ]
                 }
             },
             "examples": [{

diff --git a/src/Core/RevEng.Core.80/DbContextExtensionsSqlQuery b/src/Core/RevEng.Core.80/DbContextExtensionsSqlQuery
@@ -11,7 +11,7 @@ using System.Threading.Tasks;
 
 namespace #NAMESPACE#
 {
-    public static class DbContextExtensions
+    #ACCESSMODIFIER# static class DbContextExtensions
     {
         public static async Task<List<T>> SqlQueryAsync<T>(this DbContext db, string sql, object[] parameters = null, CancellationToken cancellationToken = default)
            where T : class
@@ -35,7 +35,7 @@ namespace #NAMESPACE#
         }
     }
 
-    public class OutputParameter<TValue>
+    #ACCESSMODIFIER# class OutputParameter<TValue>
     {
         private bool _valueSet = false;
 

diff --git a/src/Core/RevEng.Core.80/ReverseEngineerRunner.cs b/src/Core/RevEng.Core.80/ReverseEngineerRunner.cs
@@ -274,26 +274,36 @@ private static void ValidateOptions(ReverseEngineerCommandOptions options, List<
         {
             if (options.UseDatabaseNames && options.CustomReplacers?.Count > 0)
             {
-                warnings.Add($"'use-database-names' / 'UseDatabaseNames' has been set to true, but a '{Constants.RenamingFileName}' file was also found. This prevents '{Constants.RenamingFileName}' from functioning.");
+                warnings.Add(
+                    $"'use-database-names' / 'UseDatabaseNames' has been set to true, but a '{Constants.RenamingFileName}' file was also found. This prevents '{Constants.RenamingFileName}' from functioning.");
             }
 
             if (options.UseT4 && options.UseT4Split)
             {
-                warnings.Add("Both UseT4 and UseT4Split are set to true.  Only one of these should be used, UseT4Split will be used.");
+                warnings.Add(
+                    "Both UseT4 and UseT4Split are set to true.  Only one of these should be used, UseT4Split will be used.");
                 options.UseT4 = false;
             }
 
             if (options.UseDbContextSplitting)
             {
-                warnings.Add("UseDbContextSplitting (preview) is obsolete, please switch to the T4 split DbContext template.");
+                warnings.Add(
+                    "UseDbContextSplitting (preview) is obsolete, please switch to the T4 split DbContext template.");
             }
 
             if (options.UseT4Split && options.UseDbContextSplitting)
             {
-                warnings.Add("Both UseDbContextSplitting (preview) and UseT4Split are set to true. Only one of these should be used, UseT4Split will be used.");
+                warnings.Add(
+                    "Both UseDbContextSplitting (preview) and UseT4Split are set to true. Only one of these should be used, UseT4Split will be used.");
                 options.UseDbContextSplitting = false;
             }
-        }
+
+            if (options.UseInternalAccessModifiersForSprocsAndFunctions && !(options.UseT4 || options.UseT4Split))
+            {
+                warnings.Add("UseInternalAccessModifiersForSprocsAndFunctions is set to true, but UseT4 or UseT4Split are not true.  This will result in conflicting access modifiers for the partial DBContext class.  This option is intended for when the T4 templates have been used and are setting the DBContext class to internal rather than public.  UseInternalAccessModifiersForSprocsAndFunctions will be reset to false to ensure a valid DBContext is generated.");
+                options.UseInternalAccessModifiersForSprocsAndFunctions = false;
+            }
+    }
 
         private static SavedModelFiles CreateCleanupPaths(SavedModelFiles procedurePaths, SavedModelFiles functionPaths, SavedModelFiles filePaths)
         {

diff --git a/src/Core/RevEng.Core.80/ReverseEngineerScaffolder.cs b/src/Core/RevEng.Core.80/ReverseEngineerScaffolder.cs
@@ -146,6 +146,7 @@ public SavedModelFiles GenerateFunctions(
                     UseAsyncCalls = options.UseAsyncCalls,
                     UsePascalIdentifiers = !options.UseDatabaseNamesForRoutines,
                     UseDecimalDataAnnotation = options.UseDecimalDataAnnotation,
+                    UseInternalAccessModifier = options.UseInternalAccessModifiersForSprocsAndFunctions,
                 };
 
                 var functionScaffoldedModel = functionModelScaffolder.ScaffoldModel(functionModel, functionOptions, schemas, ref errors);
@@ -156,7 +157,8 @@ public SavedModelFiles GenerateFunctions(
                         functionScaffoldedModel,
                         Path.GetFullPath(Path.Combine(options.ProjectPath, options.OutputPath ?? string.Empty)),
                         contextNamespace,
-                        options.UseAsyncCalls);
+                        options.UseAsyncCalls,
+                        functionOptions.UseInternalAccessModifier);
                 }
             }
 
@@ -212,6 +214,7 @@ public SavedModelFiles GenerateStoredProcedures(
                     UseSchemaNamespaces = options.UseSchemaNamespaces,
                     UseDecimalDataAnnotation = options.UseDecimalDataAnnotation,
                     UsePascalIdentifiers = !options.UseDatabaseNamesForRoutines,
+                    UseInternalAccessModifier = options.UseInternalAccessModifiersForSprocsAndFunctions,
                 };
 
                 var procedureScaffoldedModel = procedureScaffolder.ScaffoldModel(procedureModel, procedureOptions, schemas, ref errors);
@@ -222,7 +225,8 @@ public SavedModelFiles GenerateStoredProcedures(
                         procedureScaffoldedModel,
                         Path.GetFullPath(Path.Combine(options.ProjectPath, options.OutputPath ?? string.Empty)),
                         contextNamespace,
-                        options.UseAsyncCalls);
+                        options.UseAsyncCalls,
+                        procedureOptions.UseInternalAccessModifier);
                 }
             }
 

diff --git a/src/Core/RevEng.Core.80/Routines/Functions/FunctionScaffolder.cs b/src/Core/RevEng.Core.80/Routines/Functions/FunctionScaffolder.cs
@@ -29,7 +29,7 @@ protected FunctionScaffolder([System.Diagnostics.CodeAnalysis.NotNull] ICSharpHe
 
         public string FileNameSuffix { get; set; }
 
-        public SavedModelFiles Save(ScaffoldedModel scaffoldedModel, string outputDir, string nameSpaceValue, bool useAsyncCalls)
+        public SavedModelFiles Save(ScaffoldedModel scaffoldedModel, string outputDir, string nameSpaceValue, bool useAsyncCalls, bool useInternalAccessModifier)
         {
             return ScaffoldHelper.Save(scaffoldedModel, outputDir, nameSpaceValue, useAsyncCalls);
         }

diff --git a/src/Core/RevEng.Core.80/Routines/Functions/NotImplementedFunctionScaffolder.cs b/src/Core/RevEng.Core.80/Routines/Functions/NotImplementedFunctionScaffolder.cs
@@ -8,7 +8,7 @@ namespace RevEng.Core.Routines.Functions
 {
     public class NotImplementedFunctionScaffolder : IFunctionScaffolder
     {
-        public SavedModelFiles Save(ScaffoldedModel scaffoldedModel, string outputDir, string nameSpaceValue, bool useAsyncCalls)
+        public SavedModelFiles Save(ScaffoldedModel scaffoldedModel, string outputDir, string nameSpaceValue, bool useAsyncCalls, bool useInternalAccessModifier)
         {
             throw new NotSupportedException();
         }

diff --git a/src/Core/RevEng.Core.80/Routines/Functions/SqlServerFunctionScaffolder.cs b/src/Core/RevEng.Core.80/Routines/Functions/SqlServerFunctionScaffolder.cs
@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Data;
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using Microsoft.EntityFrameworkCore.Design;
@@ -27,6 +26,8 @@ protected override string WriteDbContext(ModuleScaffolderOptions scaffolderOptio
 
             ArgumentNullException.ThrowIfNull(model);
 
+            string accessModifier = scaffolderOptions.UseInternalAccessModifier ? "internal" : "public";
+
             Sb = new IndentedStringBuilder();
 
             Sb.AppendLine(PathHelper.Header);
@@ -53,7 +54,7 @@ protected override string WriteDbContext(ModuleScaffolderOptions scaffolderOptio
 
             using (Sb.Indent())
             {
-                Sb.AppendLine($"public partial class {scaffolderOptions.ContextName}");
+                Sb.AppendLine($"{accessModifier} partial class {scaffolderOptions.ContextName}");
 
                 Sb.AppendLine("{");
 

diff --git a/src/Core/RevEng.Core.80/Routines/IRoutineScaffolder.cs b/src/Core/RevEng.Core.80/Routines/IRoutineScaffolder.cs
@@ -7,7 +7,7 @@ namespace RevEng.Core.Routines
 {
     public interface IRoutineScaffolder
     {
-        SavedModelFiles Save(ScaffoldedModel scaffoldedModel, string outputDir, string nameSpaceValue, bool useAsyncCalls);
+        SavedModelFiles Save(ScaffoldedModel scaffoldedModel, string outputDir, string nameSpaceValue, bool useAsyncCalls, bool useInternalAccessModifier);
         ScaffoldedModel ScaffoldModel(RoutineModel model, ModuleScaffolderOptions scaffolderOptions, List<string> schemas, ref List<string> errors);
     }
 }
diff --git a/src/Core/RevEng.Core.80/Routines/Procedures/NotImplementedProcedureScaffolder.cs b/src/Core/RevEng.Core.80/Routines/Procedures/NotImplementedProcedureScaffolder.cs
@@ -8,7 +8,7 @@ namespace RevEng.Core.Routines.Procedures
 {
     public class NotImplementedProcedureScaffolder : IProcedureScaffolder
     {
-        public SavedModelFiles Save(ScaffoldedModel scaffoldedModel, string outputDir, string nameSpaceValue, bool useAsyncCalls)
+        public SavedModelFiles Save(ScaffoldedModel scaffoldedModel, string outputDir, string nameSpaceValue, bool useAsyncCalls, bool useInternalAccessModifier)
         {
             throw new NotSupportedException();
         }

diff --git a/src/Core/RevEng.Core.80/Routines/Procedures/PostgresStoredProcedureScaffolder.cs b/src/Core/RevEng.Core.80/Routines/Procedures/PostgresStoredProcedureScaffolder.cs
@@ -1,10 +1,8 @@
 using System;
 using System.Collections.Generic;
-using System.Data;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
-using System.Reflection;
 using System.Text;
 using Microsoft.EntityFrameworkCore.Design;
 using Microsoft.EntityFrameworkCore.Scaffolding;
@@ -24,17 +22,18 @@ public PostgresStoredProcedureScaffolder([NotNull] ICSharpHelper code, IClrTypeM
             ProviderUsing = "using Npgsql";
         }
 
-        public new SavedModelFiles Save(ScaffoldedModel scaffoldedModel, string outputDir, string nameSpaceValue, bool useAsyncCalls)
+        public new SavedModelFiles Save(ScaffoldedModel scaffoldedModel, string outputDir, string nameSpaceValue, bool useAsyncCalls, bool useInternalAccessModifier)
         {
             ArgumentNullException.ThrowIfNull(scaffoldedModel);
 
-            var files = base.Save(scaffoldedModel, outputDir, nameSpaceValue, useAsyncCalls);
+            var files = base.Save(scaffoldedModel, outputDir, nameSpaceValue, useAsyncCalls, useInternalAccessModifier);
+            var accessModifier = useInternalAccessModifier ? "internal" : "public";
 
             var contextDir = Path.GetDirectoryName(Path.Combine(outputDir, scaffoldedModel.ContextFile.Path));
             var dbContextExtensionsText = ScaffoldHelper.GetDbContextExtensionsText(useAsyncCalls);
             var dbContextExtensionsName = useAsyncCalls ? "DbContextExtensions.cs" : "DbContextExtensions.Sync.cs";
             var dbContextExtensionsPath = Path.Combine(contextDir ?? string.Empty, dbContextExtensionsName);
-            File.WriteAllText(dbContextExtensionsPath, dbContextExtensionsText.Replace("#NAMESPACE#", nameSpaceValue, StringComparison.OrdinalIgnoreCase), Encoding.UTF8);
+            File.WriteAllText(dbContextExtensionsPath, dbContextExtensionsText.Replace("#NAMESPACE#", nameSpaceValue, StringComparison.OrdinalIgnoreCase).Replace("#ACCESSMODIFIER#", accessModifier, StringComparison.OrdinalIgnoreCase), Encoding.UTF8);
             files.AdditionalFiles.Add(dbContextExtensionsPath);
 
             return files;

diff --git a/src/Core/RevEng.Core.80/Routines/Procedures/ProcedureScaffolder.cs b/src/Core/RevEng.Core.80/Routines/Procedures/ProcedureScaffolder.cs
@@ -25,7 +25,6 @@ public abstract class ProcedureScaffolder : IRoutineScaffolder
         protected ProcedureScaffolder([System.Diagnostics.CodeAnalysis.NotNull] ICSharpHelper code, IClrTypeMapper typeMapper)
         {
             ArgumentNullException.ThrowIfNull(code);
-
             Code = code;
             this.typeMapper = typeMapper;
             scaffolder = new Scaffolder(code, typeMapper);
@@ -35,7 +34,7 @@ protected ProcedureScaffolder([System.Diagnostics.CodeAnalysis.NotNull] ICSharpH
 
         public string ProviderUsing { get; set; }
 
-        public SavedModelFiles Save(ScaffoldedModel scaffoldedModel, string outputDir, string nameSpaceValue, bool useAsyncCalls)
+        public SavedModelFiles Save(ScaffoldedModel scaffoldedModel, string outputDir, string nameSpaceValue, bool useAsyncCalls, bool useInternalAccessModifier)
         {
             return ScaffoldHelper.Save(scaffoldedModel, outputDir, nameSpaceValue, useAsyncCalls);
         }
@@ -175,6 +174,7 @@ private string WriteDbContextInterface(ModuleScaffolderOptions scaffolderOptions
             ArgumentNullException.ThrowIfNull(scaffolderOptions);
 
             ArgumentNullException.ThrowIfNull(model);
+            string accessModifier = scaffolderOptions.UseInternalAccessModifier ? "internal" : "public";
 
             Sb = new IndentedStringBuilder();
 
@@ -194,7 +194,7 @@ private string WriteDbContextInterface(ModuleScaffolderOptions scaffolderOptions
 
             using (Sb.Indent())
             {
-                Sb.AppendLine($"public partial interface I{scaffolderOptions.ContextName}{FileNameSuffix}");
+                Sb.AppendLine($"{accessModifier} partial interface I{scaffolderOptions.ContextName}{FileNameSuffix}");
                 Sb.AppendLine("{");
                 using (Sb.Indent())
                 {
@@ -219,6 +219,8 @@ private string WriteDbContext(ModuleScaffolderOptions scaffolderOptions, Routine
 
             ArgumentNullException.ThrowIfNull(model);
 
+            string accessModifier = scaffolderOptions.UseInternalAccessModifier ? "internal" : "public";
+
             Sb = new IndentedStringBuilder();
 
             Sb.AppendLine(PathHelper.Header);
@@ -237,7 +239,7 @@ private string WriteDbContext(ModuleScaffolderOptions scaffolderOptions, Routine
 
             using (Sb.Indent())
             {
-                Sb.AppendLine($"public partial class {scaffolderOptions.ContextName}");
+                Sb.AppendLine($"{accessModifier} partial class {scaffolderOptions.ContextName}");
                 Sb.AppendLine("{");
                 using (Sb.Indent())
                 {
@@ -281,7 +283,7 @@ private string WriteDbContext(ModuleScaffolderOptions scaffolderOptions, Routine
                 Sb.AppendLine("}");
                 Sb.AppendLine();
 
-                Sb.AppendLine($"public partial class {scaffolderOptions.ContextName}{FileNameSuffix} : I{scaffolderOptions.ContextName}{FileNameSuffix}");
+                Sb.AppendLine($"{accessModifier} partial class {scaffolderOptions.ContextName}{FileNameSuffix} : I{scaffolderOptions.ContextName}{FileNameSuffix}");
                 Sb.AppendLine("{");
 
                 using (Sb.Indent())

diff --git a/src/Core/RevEng.Core.80/Routines/Procedures/SqlServerStoredProcedureScaffolder.cs b/src/Core/RevEng.Core.80/Routines/Procedures/SqlServerStoredProcedureScaffolder.cs
@@ -23,17 +23,18 @@ public SqlServerStoredProcedureScaffolder([NotNull] ICSharpHelper code, IClrType
             ProviderUsing = "using Microsoft.Data.SqlClient";
         }
 
-        public new SavedModelFiles Save(ScaffoldedModel scaffoldedModel, string outputDir, string nameSpaceValue, bool useAsyncCalls)
+        public new SavedModelFiles Save(ScaffoldedModel scaffoldedModel, string outputDir, string nameSpaceValue, bool useAsyncCalls, bool useInternalAccessModifier)
         {
             ArgumentNullException.ThrowIfNull(scaffoldedModel);
 
-            var files = base.Save(scaffoldedModel, outputDir, nameSpaceValue, useAsyncCalls);
+            var files = base.Save(scaffoldedModel, outputDir, nameSpaceValue, useAsyncCalls, useInternalAccessModifier);
+            var accessModifier = useInternalAccessModifier ? "internal" : "public";
 
             var contextDir = Path.GetDirectoryName(Path.Combine(outputDir, scaffoldedModel.ContextFile.Path));
             var dbContextExtensionsText = ScaffoldHelper.GetDbContextExtensionsText(useAsyncCalls);
             var dbContextExtensionsName = useAsyncCalls ? "DbContextExtensions.cs" : "DbContextExtensions.Sync.cs";
             var dbContextExtensionsPath = Path.Combine(contextDir ?? string.Empty, dbContextExtensionsName);
-            File.WriteAllText(dbContextExtensionsPath, dbContextExtensionsText.Replace("#NAMESPACE#", nameSpaceValue, StringComparison.OrdinalIgnoreCase), Encoding.UTF8);
+            File.WriteAllText(dbContextExtensionsPath, dbContextExtensionsText.Replace("#NAMESPACE#", nameSpaceValue, StringComparison.OrdinalIgnoreCase).Replace("#ACCESSMODIFIER#", accessModifier, StringComparison.OrdinalIgnoreCase), Encoding.UTF8);
             files.AdditionalFiles.Add(dbContextExtensionsPath);
 
             return files;

diff --git a/src/Core/RevEng.Core.Abstractions/ModuleScaffolderOptions.cs b/src/Core/RevEng.Core.Abstractions/ModuleScaffolderOptions.cs
@@ -14,5 +14,6 @@ public class ModuleScaffolderOptions
         public virtual bool UseSchemaNamespaces { get; set; }
         public virtual bool UseDecimalDataAnnotation { get; set; }
         public virtual bool UsePascalIdentifiers { get; set; }
+        public virtual bool UseInternalAccessModifier { get; set; }
     }
 }
diff --git a/src/GUI/RevEng.Shared/Cli/CliConfigMapper.cs b/src/GUI/RevEng.Shared/Cli/CliConfigMapper.cs
@@ -96,6 +96,7 @@ public static ReverseEngineerCommandOptions ToCommandOptions(
                 UseDecimalDataAnnotation = config.CodeGeneration.UseDecimalDataAnnotation,
                 UsePrefixNavigationNaming = config.CodeGeneration.UsePrefixNavigationNaming,
                 UseDatabaseNamesForRoutines = config.CodeGeneration.UseDatabaseNamesForRoutines,
+                UseInternalAccessModifiersForSprocsAndFunctions = config.CodeGeneration.UseInternalAccessModifiersForSprocsAndFunctions,
 
                 // Not supported:
                 UseHandleBars = false,
@@ -184,6 +185,7 @@ public static ReverseEngineerOptions ToOptions(this CliConfig config, string pro
                 ProjectRootNamespace = names.RootNamespace,
                 UseDecimalDataAnnotationForSprocResult = config.CodeGeneration.UseDecimalDataAnnotation,
                 UsePrefixNavigationNaming = config.CodeGeneration.UsePrefixNavigationNaming,
+                UseDatabaseNamesForRoutines = config.CodeGeneration.UseDatabaseNamesForRoutines,
 
                 // HandleBars templates are not supported:
                 UseHandleBars = false,

diff --git a/src/GUI/RevEng.Shared/Cli/Configuration/CodeGeneration.cs b/src/GUI/RevEng.Shared/Cli/Configuration/CodeGeneration.cs
@@ -93,5 +93,9 @@ public class CodeGeneration
         [JsonPropertyOrder(210)]
         [JsonPropertyName("use-t4-split")]
         public bool UseT4Split { get; set; }
+
+        [JsonPropertyOrder(220)]
+        [JsonPropertyName("use-internal-access-modifiers-for-sprocs-and-functions")]
+        public bool UseInternalAccessModifiersForSprocsAndFunctions { get; set; }
     }
 }
diff --git a/src/GUI/RevEng.Shared/ReverseEngineerCommandOptions.cs b/src/GUI/RevEng.Shared/ReverseEngineerCommandOptions.cs
@@ -62,5 +62,6 @@ public class ReverseEngineerCommandOptions
         public bool UseDateOnlyTimeOnly { get; set; }
         public bool UsePrefixNavigationNaming { get; set; }
         public bool UseDatabaseNamesForRoutines { get; set; }
+        public bool UseInternalAccessModifiersForSprocsAndFunctions { get; set; }
     }
 }
diff --git a/src/GUI/RevEng.Shared/ReverseEngineerOptions.cs b/src/GUI/RevEng.Shared/ReverseEngineerOptions.cs
@@ -64,5 +64,6 @@ public class ReverseEngineerOptions
         public bool UsePrefixNavigationNaming { get; set; }
         public bool UseAsyncStoredProcedureCalls { get; set; } = true;
         public bool UseDatabaseNamesForRoutines { get; set; } = true;
+        public bool UseInternalAccessModifiersForSprocsAndFunctions { get; set; }
     }
 }