license, comments, refactor

Author: tibitoth

LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2022 AutSoft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

src/.editorconfig

@@ -68,6 +68,9 @@ csharp_style_expression_bodied_indexers = true:suggestion
 csharp_style_expression_bodied_accessors = true:suggestion
 csharp_style_expression_bodied_lambdas = true:suggestion
 csharp_style_expression_bodied_local_functions = true:suggestion
+csharp_style_throw_expression = true:warning
+csharp_style_prefer_null_check_over_type_check = true:warning
+csharp_prefer_simple_default_expression = true:warning
 
 ##########################################
 # File Extension Settings
@@ -577,3 +580,6 @@ dotnet_diagnostic.IDE0022.severity = suggestion
 dotnet_diagnostic.CA1848.severity = suggestion
 tab_width = 4
 end_of_line = crlf
+
+# SA1615: Element return value should be documented
+dotnet_diagnostic.SA1615.severity = suggestion

…g.Identity/IdentityScaffoldingOptions.cs …figuration/IdentityScaffoldingOptions.cssrc/AutSoft.DbScaffolding.Identity/IdentityScaffoldingOptions.cs renamed to src/AutSoft.DbScaffolding.Identity/Configuration/IdentityScaffoldingOptions.cs src/AutSoft.DbScaffolding.Identity/IdentityScaffoldingOptions.cs renamed to src/AutSoft.DbScaffolding.Identity/Configuration/IdentityScaffoldingOptions.cs

@@ -1,12 +1,20 @@
+using AutSoft.DbScaffolding.Configuration;
+
 using Microsoft.AspNetCore.Identity;
 
 using System;
 using System.Collections.Generic;
 
-namespace AutSoft.DbScaffolding.Identity;
+namespace AutSoft.DbScaffolding.Identity.Configuration;
 
+/// <summary>
+/// Configuration of scaffolding code first model with ASP.NET Core Identity
+/// </summary>
 public class IdentityScaffoldingOptions
 {
+    /// <summary>
+    /// Initializes a new instance of the <see cref="IdentityScaffoldingOptions"/> class.
+    /// </summary>
     public IdentityScaffoldingOptions()
     {
         UserTableName = "User";
@@ -18,14 +26,44 @@ public IdentityScaffoldingOptions()
         UserTokenTableName = "UserToken";
     }
 
+    /// <summary>
+    /// Gets or sets name of identity user table
+    /// </summary>
     public string UserTableName { get; set; }
+
+    /// <summary>
+    /// Gets or sets name of identity role table
+    /// </summary>
     public string RoleTableName { get; set; }
+
+    /// <summary>
+    /// Gets or sets name of identity role-claim cross reference table
+    /// </summary>
     public string RoleClaimTableName { get; set; }
+
+    /// <summary>
+    /// Gets or sets name of identity user-claim cross reference table
+    /// </summary>
     public string UserClaimTableName { get; set; }
+
+    /// <summary>
+    /// Gets or sets name of identity user login table
+    /// </summary>
     public string UserLoginTableName { get; set; }
+
+    /// <summary>
+    /// Gets or sets name of identity user-role cross reference table
+    /// </summary>
     public string UserRoleTableName { get; set; }
+
+    /// <summary>
+    /// Gets or sets name of identity user token table
+    /// </summary>
     public string UserTokenTableName { get; set; }
 
+    /// <summary>
+    /// Gets or sets base scaffolding configuration
+    /// </summary>
     public DbScaffoldingOptions DbScaffoldingOptions { get; set; } = new DbScaffoldingOptions();
 
     internal Dictionary<string, Type> CreateIdentityTableNameLookup(Type keyType)

….Identity/Extensions/IModelExtensions.cs …g.Identity/Extensions/ModelExtensions.cssrc/AutSoft.DbScaffolding.Identity/Extensions/IModelExtensions.cs renamed to src/AutSoft.DbScaffolding.Identity/Extensions/ModelExtensions.cs src/AutSoft.DbScaffolding.Identity/Extensions/IModelExtensions.cs renamed to src/AutSoft.DbScaffolding.Identity/Extensions/ModelExtensions.cs

@@ -1,11 +1,11 @@
-using Microsoft.EntityFrameworkCore.Metadata;
+using Microsoft.EntityFrameworkCore.Metadata;
 
 using System;
 using System.Linq;
 
 namespace AutSoft.DbScaffolding.Identity.Extensions;
 
-public static class IModelExtensions
+internal static class ModelExtensions
 {
     public static Type FindIdentityKeyType(this IModel model, string userTableName)
     {

src/AutSoft.DbScaffolding.Identity/Extensions/ServiceCollectionExtensions.cs

@@ -1,3 +1,6 @@
+using AutSoft.DbScaffolding.Configuration;
+using AutSoft.DbScaffolding.Generators;
+using AutSoft.DbScaffolding.Identity.Configuration;
 using AutSoft.DbScaffolding.Identity.Extensions;
 
 using EntityFrameworkCore.Scaffolding.Handlebars;
@@ -11,10 +14,10 @@
 using System.Collections.Generic;
 using System.Linq;
 
-namespace AutSoft.DbScaffolding.Identity;
+namespace AutSoft.DbScaffolding.Identity.Generators;
 
 [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "EF1001:Internal EF Core API usage.", Justification = "We do some low level stuff, so we take the risks.")]
-public class IdentityCSharpDbContextGenerator : CSharpDbContextGenerator
+internal class IdentityCSharpDbContextGenerator : CSharpDbContextGenerator
 {
     private readonly IOptions<HandlebarsScaffoldingOptions> _options;
     private readonly IOptions<IdentityScaffoldingOptions> _identityOptions;

…tity/IdentityCSharpDbContextGenerator.cs …tors/IdentityCSharpDbContextGenerator.cssrc/AutSoft.DbScaffolding.Identity/IdentityCSharpDbContextGenerator.cs renamed to src/AutSoft.DbScaffolding.Identity/Generators/IdentityCSharpDbContextGenerator.cs src/AutSoft.DbScaffolding.Identity/IdentityCSharpDbContextGenerator.cs renamed to src/AutSoft.DbScaffolding.Identity/Generators/IdentityCSharpDbContextGenerator.cs

@@ -1,4 +1,8 @@
-using AutSoft.DbScaffolding.Identity.Extensions;
+using AutSoft.DbScaffolding.Configuration;
+using AutSoft.DbScaffolding.Generators;
+using AutSoft.DbScaffolding.Helpers;
+using AutSoft.DbScaffolding.Identity.Configuration;
+using AutSoft.DbScaffolding.Identity.Extensions;
 
 using EntityFrameworkCore.Scaffolding.Handlebars;
 
@@ -11,9 +15,9 @@
 using System.Collections.Generic;
 using System.Linq;
 
-namespace AutSoft.DbScaffolding.Identity;
+namespace AutSoft.DbScaffolding.Identity.Generators;
 
-public class IdentityCSharpEntityTypeGenerator : CSharpEntityTypeGenerator
+internal class IdentityCSharpEntityTypeGenerator : CSharpEntityTypeGenerator
 {
     private readonly IOptions<IdentityScaffoldingOptions> _identityOptions;
 
@@ -35,9 +39,7 @@ protected override void GenerateClass(IEntityType entityType)
         Check.NotNull(entityType, nameof(entityType));
 
         if (UseDataAnnotations)
-        {
             GenerateEntityTypeDataAnnotations(entityType);
-        }
 
         var identityKeyType = entityType.Model.FindIdentityKeyType(_identityOptions.Value.UserTableName);
         var lookup = _identityOptions.Value.CreateIdentityTableNameLookup(identityKeyType);

…ity/IdentityCSharpEntityTypeGenerator.cs …ors/IdentityCSharpEntityTypeGenerator.cssrc/AutSoft.DbScaffolding.Identity/IdentityCSharpEntityTypeGenerator.cs renamed to src/AutSoft.DbScaffolding.Identity/Generators/IdentityCSharpEntityTypeGenerator.cs src/AutSoft.DbScaffolding.Identity/IdentityCSharpEntityTypeGenerator.cs renamed to src/AutSoft.DbScaffolding.Identity/Generators/IdentityCSharpEntityTypeGenerator.cs

@@ -0,0 +1,30 @@
+using AutSoft.DbScaffolding.Identity.Configuration;
+using AutSoft.DbScaffolding.Identity.Generators;
+
+using Microsoft.Extensions.DependencyInjection;
+
+using System;
+
+namespace AutSoft.DbScaffolding.Identity;
+
+/// <summary>
+/// Register all relevant services into dependency injection container
+/// </summary>
+public static class ServiceCollectionExtensions
+{
+    /// <summary>
+    /// Register all relevant services into dependency injection container
+    /// </summary>
+    public static IServiceCollection AddIdentityScaffolding(this IServiceCollection services, Action<IdentityScaffoldingOptions> identityConfigureOptions)
+    {
+        services.AddDatabaseScaffoldingCore<IdentityCSharpEntityTypeGenerator, IdentityCSharpDbContextGenerator>(
+            options => identityConfigureOptions(new IdentityScaffoldingOptions
+            {
+                DbScaffoldingOptions = options,
+            }));
+
+        services.Configure(identityConfigureOptions);
+
+        return services;
+    }
+}

src/AutSoft.DbScaffolding.Identity/ServiceCollectionExtensions.cs

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>net6.0</TargetFramework>

src/AutSoft.DbScaffolding/AutSoft.DbScaffolding.csproj

@@ -1,18 +1,39 @@
-namespace AutSoft.DbScaffolding;
+namespace AutSoft.DbScaffolding.Configuration;
 
+/// <summary>
+/// Data of a database column
+/// </summary>
 public class DbColumn
 {
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DbColumn"/> class.
+    /// </summary>
+    /// <param name="schemaName">Table's containing schema</param>
+    /// <param name="tableName">Table's name</param>
+    /// <param name="columnName">Column's name</param>
     public DbColumn(string schemaName, string tableName, string columnName)
     {
         SchemaName = schemaName;
         TableName = tableName;
         ColumnName = columnName;
     }
 
+    /// <summary>
+    /// Gets or sets table's containing schema
+    /// </summary>
     public string SchemaName { get; set; }
+
+    /// <summary>
+    /// Gets or sets table's name
+    /// </summary>
     public string TableName { get; set; }
+
+    /// <summary>
+    /// Gets or sets column's name
+    /// </summary>
     public string ColumnName { get; set; }
 
+    /// <inheritdoc/>
     public override bool Equals(object obj)
     {
         if (obj is DbColumn dbColumn)
@@ -25,6 +46,7 @@ public override bool Equals(object obj)
         return false;
     }
 
+    /// <inheritdoc/>
     public override int GetHashCode()
     {
         return SchemaName.GetHashCode() ^ TableName.GetHashCode() ^ ColumnName.GetHashCode();