Value object ctor visibility can be changed via "ConstructorAccessModifier"

Author: PawelGerr

Directory.Build.props

@@ -2,7 +2,7 @@
 
    <PropertyGroup>
       <Copyright>(c) $([System.DateTime]::Now.Year), Pawel Gerr. All rights reserved.</Copyright>
-      <VersionPrefix>7.0.0</VersionPrefix>
+      <VersionPrefix>7.1.0</VersionPrefix>
       <Authors>Pawel Gerr</Authors>
       <GenerateDocumentationFile>true</GenerateDocumentationFile>
       <PackageProjectUrl>https://github.com/PawelGerr/Thinktecture.Runtime.Extensions</PackageProjectUrl>

src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/Constants.cs

@@ -12,6 +12,7 @@ public static class ValueObject
    {
       public const ValueObjectAccessModifier DEFAULT_KEY_MEMBER_ACCESS_MODIFIER = ValueObjectAccessModifier.Private;
       public const ValueObjectMemberKind DEFAULT_KEY_MEMBER_KIND = ValueObjectMemberKind.Field;
+      public const ValueObjectAccessModifier DEFAULT_CONSTRUCTOR_ACCESS_MODIFIER = ValueObjectAccessModifier.Private;
    }
 
    public static class Modules
@@ -50,6 +51,7 @@ public static class Properties
          public const string SKIP_KEY_MEMBER = "SkipKeyMember";
          public const string KEY_MEMBER_ACCESS_MODIFIER = "KeyMemberAccessModifier";
          public const string KEY_MEMBER_KIND = "KeyMemberKind";
+         public const string CONSTRUCTOR_ACCESS_MODIFIER = "ConstructorAccessModifier";
       }
 
       public static class ValueObject

src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/ValueObjects/AllValueObjectSettings.cs

@@ -7,6 +7,7 @@ public sealed class AllValueObjectSettings : IEquatable<AllValueObjectSettings>,
    public string KeyMemberName { get; }
    public bool SkipKeyMember { get; }
    public bool SkipFactoryMethods { get; }
+   public ValueObjectAccessModifier ConstructorAccessModifier { get; }
    public string CreateFactoryMethodName { get; }
    public string TryCreateFactoryMethodName { get; }
    public bool EmptyStringInFactoryMethodsYieldsNull { get; }
@@ -30,6 +31,7 @@ public AllValueObjectSettings(AttributeData valueObjectAttribute)
       KeyMemberName = valueObjectAttribute.FindKeyMemberName() ?? Helper.GetDefaultValueObjectKeyMemberName(KeyMemberAccessModifier, KeyMemberKind);
       SkipKeyMember = valueObjectAttribute.FindSkipKeyMember() ?? false;
       SkipFactoryMethods = valueObjectAttribute.FindSkipFactoryMethods() ?? false;
+      ConstructorAccessModifier = valueObjectAttribute.FindConstructorAccessModifier() ?? Constants.ValueObject.DEFAULT_CONSTRUCTOR_ACCESS_MODIFIER;
       CreateFactoryMethodName = valueObjectAttribute.FindCreateFactoryMethodName() ?? "Create";
       TryCreateFactoryMethodName = valueObjectAttribute.FindTryCreateFactoryMethodName() ?? "TryCreate";
       EmptyStringInFactoryMethodsYieldsNull = valueObjectAttribute.FindEmptyStringInFactoryMethodsYieldsNull() ?? false;
@@ -68,6 +70,7 @@ public bool Equals(AllValueObjectSettings? other)
              && KeyMemberName == other.KeyMemberName
              && SkipKeyMember == other.SkipKeyMember
              && SkipFactoryMethods == other.SkipFactoryMethods
+             && ConstructorAccessModifier == other.ConstructorAccessModifier
              && CreateFactoryMethodName == other.CreateFactoryMethodName
              && TryCreateFactoryMethodName == other.TryCreateFactoryMethodName
              && EmptyStringInFactoryMethodsYieldsNull == other.EmptyStringInFactoryMethodsYieldsNull
@@ -94,6 +97,7 @@ public override int GetHashCode()
          hashCode = (hashCode * 397) ^ KeyMemberName.GetHashCode();
          hashCode = (hashCode * 397) ^ SkipKeyMember.GetHashCode();
          hashCode = (hashCode * 397) ^ SkipFactoryMethods.GetHashCode();
+         hashCode = (hashCode * 397) ^ ConstructorAccessModifier.GetHashCode();
          hashCode = (hashCode * 397) ^ CreateFactoryMethodName.GetHashCode();
          hashCode = (hashCode * 397) ^ TryCreateFactoryMethodName.GetHashCode();
          hashCode = (hashCode * 397) ^ EmptyStringInFactoryMethodsYieldsNull.GetHashCode();

src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/ValueObjects/ComplexValueObjectCodeGenerator.cs

@@ -326,7 +326,7 @@ private void GenerateConstructor()
 
       _sb.Append(@"
 
-      private ").Append(_state.Name).Append("(");
+      ").RenderAccessModifier(_state.Settings.ConstructorAccessModifier).Append(" ").Append(_state.Name).Append("(");
 
       _sb.RenderArgumentsWithType(fieldsAndProperties);
 

src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/ValueObjects/KeyedValueObjectCodeGenerator.cs

@@ -434,7 +434,7 @@ private void GenerateConstructor()
    {
       _sb.Append(@"
 
-      private ").Append(_state.Name).Append("(").RenderArgumentWithType(_state.KeyMember).Append(@")
+      ").RenderAccessModifier(_state.Settings.ConstructorAccessModifier).Append(" ").Append(_state.Name).Append("(").RenderArgumentWithType(_state.KeyMember).Append(@")
       {
          ValidateConstructorArguments(").RenderArgument(_state.KeyMember, "ref ").Append(@");
 

src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/ValueObjects/ValueObjectSettings.cs

@@ -6,6 +6,7 @@ namespace Thinktecture.CodeAnalysis.ValueObjects;
    private readonly AttributeInfo _attributeInfo;
 
    public bool SkipFactoryMethods => _allSettings.SkipFactoryMethods;
+   public ValueObjectAccessModifier ConstructorAccessModifier => _allSettings.ConstructorAccessModifier;
    public bool SkipKeyMember => _allSettings.SkipKeyMember;
    public string CreateFactoryMethodName => _allSettings.CreateFactoryMethodName;
    public string TryCreateFactoryMethodName => _allSettings.TryCreateFactoryMethodName;
@@ -28,6 +29,7 @@ public ValueObjectSettings(
    public bool Equals(ValueObjectSettings other)
    {
       return SkipFactoryMethods == other.SkipFactoryMethods
+             && ConstructorAccessModifier == other.ConstructorAccessModifier
              && SkipKeyMember == other.SkipKeyMember
              && CreateFactoryMethodName == other.CreateFactoryMethodName
              && TryCreateFactoryMethodName == other.TryCreateFactoryMethodName
@@ -50,6 +52,7 @@ public override int GetHashCode()
       unchecked
       {
          var hashCode = SkipFactoryMethods.GetHashCode();
+         hashCode = (hashCode * 397) ^ (int)ConstructorAccessModifier;
          hashCode = (hashCode * 397) ^ SkipKeyMember.GetHashCode();
          hashCode = (hashCode * 397) ^ CreateFactoryMethodName.GetHashCode();
          hashCode = (hashCode * 397) ^ TryCreateFactoryMethodName.GetHashCode();

src/Thinktecture.Runtime.Extensions.SourceGenerator/Extensions/AttributeDataExtensions.cs

@@ -21,7 +21,17 @@ public static class AttributeDataExtensions
 
    public static ValueObjectAccessModifier? FindKeyMemberAccessModifier(this AttributeData attributeData)
    {
-      var modifier = (ValueObjectAccessModifier?)GetIntegerParameterValue(attributeData, Constants.Attributes.Properties.KEY_MEMBER_ACCESS_MODIFIER);
+      return attributeData.FindAccessModifier(Constants.Attributes.Properties.KEY_MEMBER_ACCESS_MODIFIER);
+   }
+
+   public static ValueObjectAccessModifier? FindConstructorAccessModifier(this AttributeData attributeData)
+   {
+      return attributeData.FindAccessModifier(Constants.Attributes.Properties.CONSTRUCTOR_ACCESS_MODIFIER);
+   }
+
+   private static ValueObjectAccessModifier? FindAccessModifier(this AttributeData attributeData, string propertyName)
+   {
+      var modifier = (ValueObjectAccessModifier?)GetIntegerParameterValue(attributeData, propertyName);
 
       if (modifier is null || !modifier.Value.IsValid())
          return null;

src/Thinktecture.Runtime.Extensions/ComplexValueObjectAttribute.cs

@@ -13,6 +13,12 @@ public sealed class ComplexValueObjectAttribute : Attribute
    /// </summary>
    public bool SkipFactoryMethods { get; set; }
 
+   /// <summary>
+   /// Access modifier of the constructor.
+   /// Default is <see cref="ValueObjectAccessModifier.Private"/>.
+   /// </summary>
+   public ValueObjectAccessModifier ConstructorAccessModifier { get; set; }
+
    private string? _createFactoryMethodName;
 
    /// <summary>
@@ -63,4 +69,12 @@ public string DefaultInstancePropertyName
       get => _defaultInstancePropertyName ?? "Empty";
       set => _defaultInstancePropertyName = value;
    }
+
+   /// <summary>
+   /// Initializes new instance of <see cref="ComplexValueObjectAttribute"/>.
+   /// </summary>
+   public ComplexValueObjectAttribute()
+   {
+      ConstructorAccessModifier = ValueObjectAccessModifier.Private;
+   }
 }

src/Thinktecture.Runtime.Extensions/ValueObjectAttribute.cs

@@ -51,6 +51,12 @@ public string KeyMemberName
    /// </summary>
    public bool SkipFactoryMethods { get; set; }
 
+   /// <summary>
+   /// Access modifier of the constructor.
+   /// Default is <see cref="ValueObjectAccessModifier.Private"/>.
+   /// </summary>
+   public ValueObjectAccessModifier ConstructorAccessModifier { get; set; }
+
    private string? _createFactoryMethodName;
 
    /// <summary>
@@ -215,5 +221,6 @@ public ValueObjectAttribute()
    {
       KeyMemberType = typeof(TKey);
       KeyMemberAccessModifier = ValueObjectAccessModifier.Private;
+      ConstructorAccessModifier = ValueObjectAccessModifier.Private;
    }
 }

test/Thinktecture.Runtime.Extensions.Tests.Shared/TestValueObjects/ComplexValueObjectWithPublicCtor.cs

@@ -0,0 +1,8 @@
+namespace Thinktecture.Runtime.Tests.TestValueObjects;
+
+[ComplexValueObject(ConstructorAccessModifier = ValueObjectAccessModifier.Public)]
+public sealed partial class ComplexValueObjectWithPublicCtor
+{
+   public decimal Lower { get; }
+   public decimal Upper { get; }
+}

test/Thinktecture.Runtime.Extensions.Tests.Shared/TestValueObjects/KeyedValueObjectWithPublicCtor.cs

@@ -0,0 +1,6 @@
+namespace Thinktecture.Runtime.Tests.TestValueObjects;
+
+[ValueObject<int>(ConstructorAccessModifier = ValueObjectAccessModifier.Public)]
+public sealed partial class KeyedValueObjectWithPublicCtor
+{
+}

test/Thinktecture.Runtime.Extensions.Tests/ValueObjectTests/ConstructorTests.cs

@@ -0,0 +1,18 @@
+using Thinktecture.Runtime.Tests.TestValueObjects;
+
+namespace Thinktecture.Runtime.Tests.ValueObjectTests;
+
+public class ConstructorTests
+{
+   [Fact]
+   public void Keyed_value_object_with_public_ctor()
+   {
+      var obj = new KeyedValueObjectWithPublicCtor(42);
+   }
+
+   [Fact]
+   public void Complex_value_object_with_public_ctor()
+   {
+      var obj = new ComplexValueObjectWithPublicCtor(1, 2);
+   }
+}