Merge pull request #19 from beheshty/feature/immutable-models

beheshty · web-flow · commit 47284f7bcf33 · 2025-07-16T14:19:45.000+03:30
Feature/immutable models
diff --git a/src/SetSharp/CodeGeneration/PocoGenerator.cs b/src/SetSharp/CodeGeneration/PocoGenerator.cs
@@ -12,7 +12,10 @@ internal static string Generate(List<SettingClassInfo> classes, string @namespac
             var sb = new StringBuilder();
 
             sb.AppendLine("// <auto-generated/>");
+            sb.AppendLine("#nullable enable");
+            sb.AppendLine();
             sb.AppendLine("using System.Collections.Generic;");
+            sb.AppendLine("using System.Collections.Immutable;");
             sb.AppendLine();
             sb.AppendLine($"namespace {@namespace}");
             sb.AppendLine("{");
@@ -22,7 +25,7 @@ internal static string Generate(List<SettingClassInfo> classes, string @namespac
                 sb.AppendLine();
                 AddClassSummary(sb, SettingClassInfo);
                 sb.AppendLine($"    [System.CodeDom.Compiler.GeneratedCode(\"SetSharp\", \"{assemblyVersion}\")]");
-                sb.AppendLine($"    public partial class {SettingClassInfo.ClassName}");
+                sb.AppendLine($"    public partial record {SettingClassInfo.ClassName}");
                 sb.AppendLine("    {");
 
                 AddSectionNameConstant(sb, SettingClassInfo);
@@ -63,11 +66,12 @@ private static void AddSectionNameConstant(StringBuilder sb, SettingClassInfo Se
 
         private static void AddProperty(StringBuilder sb, SettingPropertyInfo property)
         {
+            sb.AppendLine($"        /// <summary>Maps to the '{property.OriginalJsonKey}' configuration key.</summary>");
             if (property.PropertyName != property.OriginalJsonKey)
             {
                 sb.AppendLine($"        [Microsoft.Extensions.Configuration.ConfigurationKeyName(\"{property.OriginalJsonKey}\")]");
             }
-            sb.AppendLine($"        public {property.PropertyType} {property.PropertyName} {{ get; set; }}");
+            sb.AppendLine($"        public {property.PropertyType} {property.PropertyName} {{ get; init; }}");
             sb.AppendLine();
         }
     }
diff --git a/src/SetSharp/Diagnostics/DiagnosticDescriptors.cs b/src/SetSharp/Diagnostics/DiagnosticDescriptors.cs
@@ -8,9 +8,11 @@ internal static class DiagnosticDescriptors
            "SSG001", "App settings parsing failed", "{0}", "Error", DiagnosticSeverity.Error, true);
 
         internal static readonly DiagnosticDescriptor MissingOptionsDependencyError = new(
-            "SSG002", "Missing Dependencies", "To generate IOptions extensions, the project must reference 'Microsoft.Extensions.Options.ConfigurationExtensions'. Please install the corresponding NuGet package.", "Usage", DiagnosticSeverity.Error, true);
+            "SSG002", "Missing Dependencies", "To generate IOptions extensions, the project must reference 'Microsoft.Extensions.Options.ConfigurationExtensions'. " +
+            "Please install the corresponding NuGet package.", "Usage", DiagnosticSeverity.Error, true);
 
         internal static readonly DiagnosticDescriptor MissingBaseDependencyError = new(
-            "SSG003", "Missing Dependency", "The project must reference 'Microsoft.Extensions.Configuration.Abstractions' for basic functionality. Please install the corresponding NuGet package.", "Usage", DiagnosticSeverity.Error, true);
+            "SSG003", "Missing Dependency", "The project must reference 'Microsoft.Extensions.Configuration.Abstractions' and 'System.Collections.Immutable' " +
+            "for basic functionality. Please install the corresponding NuGet package.", "Usage", DiagnosticSeverity.Error, true);
     }
 }
diff --git a/src/SetSharp/ModelBuilder/ConfigurationModelBuilder.cs b/src/SetSharp/ModelBuilder/ConfigurationModelBuilder.cs
@@ -57,7 +57,7 @@ string HandleNestedObject(Dictionary<string, object> obj)
 
         private string InferListType(string parentSectionPath, string key, List<object> list)
         {
-            if (list.Count == 0) return "List<object>";
+            if (list.Count == 0) return "ImmutableList<object>";
 
             string HandleListItemObject(Dictionary<string, object> obj)
             {
@@ -79,7 +79,7 @@ string HandleListItemObject(Dictionary<string, object> obj)
                 _ => "object"
             };
 
-            return $"List<{listTypeName}>";
+            return $"ImmutableList<{listTypeName}>";
         }
 
         private string CreateNestedClass(string sectionPath, string classNameKey, Dictionary<string, object> obj, bool isFromCollection = false)
diff --git a/src/SetSharp/SetSharp.csproj b/src/SetSharp/SetSharp.csproj
@@ -10,7 +10,7 @@
 		<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
 
 		<PackageId>SetSharp</PackageId>
-		<Version>1.3.2</Version>
+		<Version>2.0.0</Version>
 		<PackageIcon>icon.png</PackageIcon>
 		<Authors>Amirhossein Beheshti</Authors>
 		<Description>Generates strongly typed settings classes from appsettings.json using Source Generators.</Description>
diff --git a/src/SetSharp/SetSharpSourceGenerator.cs b/src/SetSharp/SetSharpSourceGenerator.cs
@@ -5,7 +5,6 @@
 using SetSharp.ModelBuilder;
 using SetSharp.Models;
 using System.Text;
-using Microsoft.CodeAnalysis.Diagnostics;
 using SetSharp.Diagnostics;
 
 namespace SetSharp
@@ -119,6 +118,11 @@ private static SetSharpSettings ReadSetSharpSettings(Dictionary<string, object>
                 return Diagnostic.Create(DiagnosticDescriptors.MissingBaseDependencyError, Location.None);
             }
 
+            if (compilation.GetTypeByMetadataName("System.Collections.Immutable.ImmutableList") == null)
+            {
+                return Diagnostic.Create(DiagnosticDescriptors.MissingBaseDependencyError, Location.None);
+            }
+
             if (!checkForOptionsPattern)
             {
                 return null;
diff --git a/tests/SetSharp.Tests/CodeGeneration/PocoGeneratorTests.cs b/tests/SetSharp.Tests/CodeGeneration/PocoGeneratorTests.cs
@@ -37,8 +37,8 @@ public void Generate_WithMultipleClasses_ShouldGenerateAllClasses()
             var result = PocoGenerator.Generate(classes);
 
             // Assert
-            Assert.Contains("public partial class FirstSettings", result);
-            Assert.Contains("public partial class SecondSettings", result);
+            Assert.Contains("public partial record FirstSettings", result);
+            Assert.Contains("public partial record SecondSettings", result);
         }
 
         [Fact]
@@ -62,7 +62,7 @@ public void Generate_WithDifferentPropertyAndJsonKey_ShouldAddConfigurationKeyNa
 
             // Assert
             Assert.Contains("[Microsoft.Extensions.Configuration.ConfigurationKeyName(\"Logging:LogLevel:Default\")]", result);
-            Assert.Contains("public string LogLevel { get; set; }", result);
+            Assert.Contains("public string LogLevel { get; init; }", result);
         }
 
         [Fact]
@@ -92,7 +92,10 @@ public void Generate_WithEmptyClassList_ShouldGenerateEmptyNamespace()
             // Arrange
             var classes = new List<SettingClassInfo>();
             var expected = @"// <auto-generated/>
+#nullable enable
+
 using System.Collections.Generic;
+using System.Collections.Immutable;
 
 namespace SetSharp.Configuration
 {
diff --git a/tests/SetSharp.Tests/ModelBuilder/ConfigurationModelBuilderTests.cs b/tests/SetSharp.Tests/ModelBuilder/ConfigurationModelBuilderTests.cs
@@ -106,7 +106,7 @@ public void BuildFrom_WithListOfPrimitives_ShouldInferListType()
             var rootModel = Assert.Single(result);
             var listProperty = Assert.Single(rootModel.Properties);
             Assert.Equal("AllowedHosts", listProperty.PropertyName);
-            Assert.Equal("List<string>", listProperty.PropertyType);
+            Assert.Equal("ImmutableList<string>", listProperty.PropertyType);
         }
 
         [Fact]
@@ -126,7 +126,7 @@ public void BuildFrom_WithEmptyList_ShouldDefaultToListOfObject()
             var rootModel = Assert.Single(result);
             var listProperty = Assert.Single(rootModel.Properties);
             Assert.Equal("EmptyList", listProperty.PropertyName);
-            Assert.Equal("List<object>", listProperty.PropertyType);
+            Assert.Equal("ImmutableList<object>", listProperty.PropertyType);
         }
 
         [Fact]
@@ -154,7 +154,7 @@ public void BuildFrom_WithListOfObjects_ShouldCreateSeparateClassForListItems()
             var rootModel = result.First(c => c.ClassName == "RootOptions");
             var listProperty = Assert.Single(rootModel.Properties);
             Assert.Equal("Endpoints", listProperty.PropertyName);
-            Assert.Equal("List<EndpointsItemOptions>", listProperty.PropertyType);
+            Assert.Equal("ImmutableList<EndpointsItemOptions>", listProperty.PropertyType);
 
             // Test Nested List Item Class
             var endpointItemModel = result.First(c => c.ClassName == "EndpointsItemOptions");
@@ -167,8 +167,6 @@ public void BuildFrom_WithListOfObjects_ShouldCreateSeparateClassForListItems()
         [Fact]
         public void NormalizeName_WithInvalidChars_ShouldSanitizeName()
         {
-            // This test calls a private method. To test it directly, you could make it internal
-            // or use a PrivateObject accessor. Here, we test it indirectly via its effect in BuildFrom.
             // Arrange
             var builder = new ConfigurationModelBuilder();
             var root = new Dictionary<string, object>

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,10 @@ internal static string Generate(List<SettingClassInfo> classes, string @namespac`
`12`	`12`	`var sb = new StringBuilder();`
`13`	`13`
`14`	`14`	`sb.AppendLine("// <auto-generated/>");`
	`15`	`+ sb.AppendLine("#nullable enable");`
	`16`	`+ sb.AppendLine();`
`15`	`17`	`sb.AppendLine("using System.Collections.Generic;");`
	`18`	`+ sb.AppendLine("using System.Collections.Immutable;");`
`16`	`19`	`sb.AppendLine();`
`17`	`20`	`sb.AppendLine($"namespace {@namespace}");`
`18`	`21`	`sb.AppendLine("{");`
`@@ -22,7 +25,7 @@ internal static string Generate(List<SettingClassInfo> classes, string @namespac`
`22`	`25`	`sb.AppendLine();`
`23`	`26`	`AddClassSummary(sb, SettingClassInfo);`
`24`	`27`	`sb.AppendLine($" [System.CodeDom.Compiler.GeneratedCode(\"SetSharp\", \"{assemblyVersion}\")]");`
`25`		`- sb.AppendLine($" public partial class {SettingClassInfo.ClassName}");`
	`28`	`+ sb.AppendLine($" public partial record {SettingClassInfo.ClassName}");`
`26`	`29`	`sb.AppendLine(" {");`
`27`	`30`
`28`	`31`	`AddSectionNameConstant(sb, SettingClassInfo);`
`@@ -63,11 +66,12 @@ private static void AddSectionNameConstant(StringBuilder sb, SettingClassInfo Se`
`63`	`66`
`64`	`67`	`private static void AddProperty(StringBuilder sb, SettingPropertyInfo property)`
`65`	`68`	`{`
	`69`	`+ sb.AppendLine($" /// <summary>Maps to the '{property.OriginalJsonKey}' configuration key.</summary>");`
`66`	`70`	`if (property.PropertyName != property.OriginalJsonKey)`
`67`	`71`	`{`
`68`	`72`	`sb.AppendLine($" [Microsoft.Extensions.Configuration.ConfigurationKeyName(\"{property.OriginalJsonKey}\")]");`
`69`	`73`	`}`
`70`		`- sb.AppendLine($" public {property.PropertyType} {property.PropertyName} {{ get; set; }}");`
	`74`	`+ sb.AppendLine($" public {property.PropertyType} {property.PropertyName} {{ get; init; }}");`
`71`	`75`	`sb.AppendLine();`
`72`	`76`	`}`
`73`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,11 @@ internal static class DiagnosticDescriptors`
`8`	`8`	`"SSG001", "App settings parsing failed", "{0}", "Error", DiagnosticSeverity.Error, true);`
`9`	`9`
`10`	`10`	`internal static readonly DiagnosticDescriptor MissingOptionsDependencyError = new(`
`11`		`- "SSG002", "Missing Dependencies", "To generate IOptions extensions, the project must reference 'Microsoft.Extensions.Options.ConfigurationExtensions'. Please install the corresponding NuGet package.", "Usage", DiagnosticSeverity.Error, true);`
	`11`	`+ "SSG002", "Missing Dependencies", "To generate IOptions extensions, the project must reference 'Microsoft.Extensions.Options.ConfigurationExtensions'. " +`
	`12`	`+ "Please install the corresponding NuGet package.", "Usage", DiagnosticSeverity.Error, true);`
`12`	`13`
`13`	`14`	`internal static readonly DiagnosticDescriptor MissingBaseDependencyError = new(`
`14`		`- "SSG003", "Missing Dependency", "The project must reference 'Microsoft.Extensions.Configuration.Abstractions' for basic functionality. Please install the corresponding NuGet package.", "Usage", DiagnosticSeverity.Error, true);`
	`15`	`+ "SSG003", "Missing Dependency", "The project must reference 'Microsoft.Extensions.Configuration.Abstractions' and 'System.Collections.Immutable' " +`
	`16`	`+ "for basic functionality. Please install the corresponding NuGet package.", "Usage", DiagnosticSeverity.Error, true);`
`15`	`17`	`}`
`16`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ string HandleNestedObject(Dictionary<string, object> obj)`
`57`	`57`
`58`	`58`	`private string InferListType(string parentSectionPath, string key, List<object> list)`
`59`	`59`	`{`
`60`		`- if (list.Count == 0) return "List<object>";`
	`60`	`+ if (list.Count == 0) return "ImmutableList<object>";`
`61`	`61`
`62`	`62`	`string HandleListItemObject(Dictionary<string, object> obj)`
`63`	`63`	`{`
`@@ -79,7 +79,7 @@ string HandleListItemObject(Dictionary<string, object> obj)`
`79`	`79`	`_ => "object"`
`80`	`80`	`};`
`81`	`81`
`82`		`- return $"List<{listTypeName}>";`
	`82`	`+ return $"ImmutableList<{listTypeName}>";`
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`private string CreateNestedClass(string sectionPath, string classNameKey, Dictionary<string, object> obj, bool isFromCollection = false)`