Added combination out of AllowNull and NotNull to not-nullable reference parameters of ValidateFactoryArguments

PawelGerr · PawelGerr · commit de423844b661 · 2023-11-06T22:44:11.000+01:00
* Ensures that the value is validated/handled by the developer, if not then a compiler warning is emitted.
diff --git a/samples/Thinktecture.Runtime.Extensions.Benchmarking/Database/Description.cs b/samples/Thinktecture.Runtime.Extensions.Benchmarking/Database/Description.cs
@@ -12,6 +12,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes
    {
       if (String.IsNullOrWhiteSpace(value))
       {
+         value = null!;
          validationResult = new ValidationResult("Description cannot be empty.");
          return;
       }
diff --git a/samples/Thinktecture.Runtime.Extensions.Benchmarking/Database/DescriptionStruct.cs b/samples/Thinktecture.Runtime.Extensions.Benchmarking/Database/DescriptionStruct.cs
@@ -12,6 +12,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes
    {
       if (String.IsNullOrWhiteSpace(value))
       {
+         value = null!;
          validationResult = new ValidationResult("Description cannot be empty.");
          return;
       }
diff --git a/samples/Thinktecture.Runtime.Extensions.Benchmarking/Database/Name.cs b/samples/Thinktecture.Runtime.Extensions.Benchmarking/Database/Name.cs
@@ -12,6 +12,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes
    {
       if (String.IsNullOrWhiteSpace(value))
       {
+         value = null!;
          validationResult = new ValidationResult("Name cannot be empty.");
          return;
       }
diff --git a/samples/Thinktecture.Runtime.Extensions.Benchmarking/Database/NameStruct.cs b/samples/Thinktecture.Runtime.Extensions.Benchmarking/Database/NameStruct.cs
@@ -12,6 +12,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes
    {
       if (String.IsNullOrWhiteSpace(value))
       {
+         value = null!;
          validationResult = new ValidationResult("Name cannot be empty.");
          return;
       }
diff --git a/samples/Thinktecture.Runtime.Extensions.MessagePack.Samples/ProductNameWithMessagePackFormatter.cs b/samples/Thinktecture.Runtime.Extensions.MessagePack.Samples/ProductNameWithMessagePackFormatter.cs
@@ -13,6 +13,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes
    {
       if (String.IsNullOrWhiteSpace(value))
       {
+         value = null!;
          validationResult = new ValidationResult("Product name cannot be empty.");
          return;
       }
diff --git a/samples/Thinktecture.Runtime.Extensions.Samples/ValueObjects/OtherProductName.cs b/samples/Thinktecture.Runtime.Extensions.Samples/ValueObjects/OtherProductName.cs
@@ -13,6 +13,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes
    {
       if (String.IsNullOrWhiteSpace(value))
       {
+         value = null!;
          validationResult = new ValidationResult("Product name cannot be empty.");
          return;
       }
diff --git a/samples/Thinktecture.Runtime.Extensions.Samples/ValueObjects/ProductName.cs b/samples/Thinktecture.Runtime.Extensions.Samples/ValueObjects/ProductName.cs
@@ -14,6 +14,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes
    {
       if (String.IsNullOrWhiteSpace(value))
       {
+         value = null!;
          validationResult = new ValidationResult("Product name cannot be empty.");
          return;
       }
diff --git a/samples/Thinktecture.Runtime.Extensions.Samples/ValueObjects/ProductNameStruct.cs b/samples/Thinktecture.Runtime.Extensions.Samples/ValueObjects/ProductNameStruct.cs
@@ -14,6 +14,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes
    {
       if (String.IsNullOrWhiteSpace(value))
       {
+         value = null!;
          validationResult = new ValidationResult("Product name cannot be empty.");
          return;
       }
diff --git a/src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/ValueObjects/ValueObjectCodeGenerator.cs b/src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/ValueObjects/ValueObjectCodeGenerator.cs
@@ -555,7 +555,7 @@ private void GenerateValidateFactoryArguments()
 
       _sb.Append("static partial ").Append(_state.FactoryValidationReturnType ?? "void").Append(" ").Append(Constants.Methods.VALIDATE_FACTORY_ARGUMENTS).Append("(ref global::System.ComponentModel.DataAnnotations.ValidationResult? validationResult");
 
-      _sb.RenderArgumentsWithType(fieldsAndProperties, "ref ", leadingComma: true);
+      _sb.RenderArgumentsWithType(fieldsAndProperties, "ref ", leadingComma: true, addAllowNullNotNullCombi: true);
 
       _sb.Append(");");
    }
diff --git a/src/Thinktecture.Runtime.Extensions.SourceGenerator/Extensions/StringBuilderExtensions.cs b/src/Thinktecture.Runtime.Extensions.SourceGenerator/Extensions/StringBuilderExtensions.cs
@@ -1,4 +1,5 @@
 using System.Text;
+using Microsoft.CodeAnalysis;
 using Thinktecture.CodeAnalysis;
 using Thinktecture.CodeAnalysis.SmartEnums;
 
@@ -38,14 +39,19 @@ public static void RenderArgumentsWithType(
       string comma = ", ",
       bool leadingComma = false,
       bool trailingComma = false,
-      bool useNullableTypes = false)
+      bool useNullableTypes = false,
+      bool addAllowNullNotNullCombi = false)
    {
       for (var i = 0; i < members.Count; i++)
       {
          if (leadingComma || i > 0)
             sb.Append(comma);
 
          var member = members[i];
+
+         if (addAllowNullNotNullCombi && member.IsReferenceType && member.NullableAnnotation != NullableAnnotation.Annotated)
+            sb.Append("[global::System.Diagnostics.CodeAnalysis.AllowNullAttribute, global::System.Diagnostics.CodeAnalysis.NotNullAttribute] ");
+
          sb.Append(prefix).Append(member.TypeFullyQualifiedWithNullability);
 
          if (useNullableTypes && !member.IsNullableStruct)
diff --git a/test/Thinktecture.Runtime.Extensions.Tests.Shared/TestValueObjects/BoundaryWithStrings.cs b/test/Thinktecture.Runtime.Extensions.Tests.Shared/TestValueObjects/BoundaryWithStrings.cs
@@ -0,0 +1,26 @@
+using System.ComponentModel.DataAnnotations;
+using System.Diagnostics.CodeAnalysis;
+
+namespace Thinktecture.Runtime.Tests.TestValueObjects;
+
+[ValueObject]
+public sealed partial class BoundaryWithStrings
+{
+   public string Lower { get; }
+   public string? Upper { get; }
+
+   static partial void ValidateFactoryArguments(ref ValidationResult? validationResult, ref string lower, ref string? upper)
+   {
+      if (lower is null)
+      {
+         lower = null!;
+         validationResult = new ValidationResult("Lower boundary must not be null.");
+         return;
+      }
+
+      if (upper is null || lower.Length <= upper.Length)
+         return;
+
+      validationResult = new ValidationResult($"The length of lower boundary '{lower}' must be less than the length of the upper boundary '{upper}'");
+   }
+}
diff --git a/test/Thinktecture.Runtime.Extensions.Tests.Shared/TestValueObjects/StringBasedReferenceValueObject.cs b/test/Thinktecture.Runtime.Extensions.Tests.Shared/TestValueObjects/StringBasedReferenceValueObject.cs
@@ -12,6 +12,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes
    {
       if (String.IsNullOrWhiteSpace(property))
       {
+         property = null!;
          validationResult = new ValidationResult("Property cannot be empty.");
          return;
       }
diff --git a/test/Thinktecture.Runtime.Extensions.Tests.Shared/TestValueObjects/StringBasedReferenceValueObjectWithEmptyStringInFactoryMethodsYieldsNull.cs b/test/Thinktecture.Runtime.Extensions.Tests.Shared/TestValueObjects/StringBasedReferenceValueObjectWithEmptyStringInFactoryMethodsYieldsNull.cs
@@ -12,6 +12,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes
    {
       if (String.IsNullOrWhiteSpace(property))
       {
+         property = null!;
          validationResult = new ValidationResult("Property cannot be empty.");
          return;
       }
diff --git a/test/Thinktecture.Runtime.Extensions.Tests.Shared/TestValueObjects/StringBasedReferenceValueObjectWithNullInFactoryMethodsYieldsNull.cs b/test/Thinktecture.Runtime.Extensions.Tests.Shared/TestValueObjects/StringBasedReferenceValueObjectWithNullInFactoryMethodsYieldsNull.cs
@@ -12,6 +12,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes
    {
       if (String.IsNullOrWhiteSpace(property))
       {
+         property = null!;
          validationResult = new ValidationResult("Property cannot be empty.");
          return;
       }

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes`
`12`	`12`	`{`
`13`	`13`	`if (String.IsNullOrWhiteSpace(value))`
`14`	`14`	`{`
	`15`	`+ value = null!;`
`15`	`16`	`validationResult = new ValidationResult("Description cannot be empty.");`
`16`	`17`	`return;`
`17`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes`
`13`	`13`	`{`
`14`	`14`	`if (String.IsNullOrWhiteSpace(value))`
`15`	`15`	`{`
	`16`	`+ value = null!;`
`16`	`17`	`validationResult = new ValidationResult("Product name cannot be empty.");`
`17`	`18`	`return;`
`18`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes`
`14`	`14`	`{`
`15`	`15`	`if (String.IsNullOrWhiteSpace(value))`
`16`	`16`	`{`
	`17`	`+ value = null!;`
`17`	`18`	`validationResult = new ValidationResult("Product name cannot be empty.");`
`18`	`19`	`return;`
`19`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -555,7 +555,7 @@ private void GenerateValidateFactoryArguments()`
`555`	`555`
`556`	`556`	`_sb.Append("static partial ").Append(_state.FactoryValidationReturnType ?? "void").Append(" ").Append(Constants.Methods.VALIDATE_FACTORY_ARGUMENTS).Append("(ref global::System.ComponentModel.DataAnnotations.ValidationResult? validationResult");`
`557`	`557`
`558`		`- _sb.RenderArgumentsWithType(fieldsAndProperties, "ref ", leadingComma: true);`
	`558`	`+ _sb.RenderArgumentsWithType(fieldsAndProperties, "ref ", leadingComma: true, addAllowNullNotNullCombi: true);`
`559`	`559`
`560`	`560`	`_sb.Append(");");`
`561`	`561`	`}`