Fixed comment of explicit conversion

PawelGerr · Jan 17, 2025 · 2d443db · 2d443db
1 parent f0c3849
commit 2d443db
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 11 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <Copyright>(c) $([System.DateTime]::Now.Year), Pawel Gerr. All rights reserved.</Copyright>
-    <VersionPrefix>8.0.2</VersionPrefix>
+    <VersionPrefix>8.1.0</VersionPrefix>
     <Authors>Pawel Gerr</Authors>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageProjectUrl>https://github.com/PawelGerr/Thinktecture.Runtime.Extensions</PackageProjectUrl>

diff --git a/...ime.Extensions.SourceGenerator/CodeAnalysis/ValueObjects/KeyedValueObjectCodeGenerator.cs b/...ime.Extensions.SourceGenerator/CodeAnalysis/ValueObjects/KeyedValueObjectCodeGenerator.cs
@@ -248,7 +248,8 @@ private void GenerateExplicitConversionToKey()
       /// Explicit conversion to the type ").AppendTypeForXmlComment(keyMember).Append(@".
       /// </summary>
       /// <param name=""obj"">Object to covert.</param>
-      /// <returns>The <see cref=""").Append(keyMember.Name).Append(@"""/> of provided <paramref name=""obj""/> or <c>default</c> if <paramref name=""obj""/> is <c>null</c>.</returns>
+      /// <returns>The <see cref=""").Append(keyMember.Name).Append(@"""/> of provided <paramref name=""obj""/>.</returns>
+      /// <exception cref=""System.NullReferenceException"">If <paramref name=""obj""/> is <c>null</c>.</exception>
       [return: global::System.Diagnostics.CodeAnalysis.NotNullIfNotNull(""obj"")]
       public static explicit operator ").AppendTypeFullyQualified(keyMember).Append("(").AppendTypeFullyQualified(_state).Append(@" obj)
       {

diff --git a/.../ValueObjectSourceGeneratorTests.Should_generate_DateOnly_based_keyed_class_0.verified.cs b/.../ValueObjectSourceGeneratorTests.Should_generate_DateOnly_based_keyed_class_0.verified.cs
@@ -103,7 +103,8 @@ public static bool TryCreate(
       /// Explicit conversion to the type <see cref="global::System.DateOnly"/>.
       /// </summary>
       /// <param name="obj">Object to covert.</param>
-      /// <returns>The <see cref="_value"/> of provided <paramref name="obj"/> or <c>default</c> if <paramref name="obj"/> is <c>null</c>.</returns>
+      /// <returns>The <see cref="_value"/> of provided <paramref name="obj"/>.</returns>
+      /// <exception cref="System.NullReferenceException">If <paramref name="obj"/> is <c>null</c>.</exception>
       [return: global::System.Diagnostics.CodeAnalysis.NotNullIfNotNull("obj")]
       public static explicit operator global::System.DateOnly(global::Thinktecture.Tests.TestValueObject obj)
       {

diff --git a/...Should_generate_DateOnly_based_keyed_class_with_DefaultWithKeyTypeOverloads_0.verified.cs b/...Should_generate_DateOnly_based_keyed_class_with_DefaultWithKeyTypeOverloads_0.verified.cs
@@ -103,7 +103,8 @@ public static bool TryCreate(
       /// Explicit conversion to the type <see cref="global::System.DateOnly"/>.
       /// </summary>
       /// <param name="obj">Object to covert.</param>
-      /// <returns>The <see cref="_value"/> of provided <paramref name="obj"/> or <c>default</c> if <paramref name="obj"/> is <c>null</c>.</returns>
+      /// <returns>The <see cref="_value"/> of provided <paramref name="obj"/>.</returns>
+      /// <exception cref="System.NullReferenceException">If <paramref name="obj"/> is <c>null</c>.</exception>
       [return: global::System.Diagnostics.CodeAnalysis.NotNullIfNotNull("obj")]
       public static explicit operator global::System.DateOnly(global::Thinktecture.Tests.TestValueObject obj)
       {

diff --git a/...shots/ValueObjectSourceGeneratorTests.Should_generate_int_based_keyed_class_0.verified.cs b/...shots/ValueObjectSourceGeneratorTests.Should_generate_int_based_keyed_class_0.verified.cs
@@ -103,7 +103,8 @@ public static bool TryCreate(
       /// Explicit conversion to the type <see cref="int"/>.
       /// </summary>
       /// <param name="obj">Object to covert.</param>
-      /// <returns>The <see cref="_value"/> of provided <paramref name="obj"/> or <c>default</c> if <paramref name="obj"/> is <c>null</c>.</returns>
+      /// <returns>The <see cref="_value"/> of provided <paramref name="obj"/>.</returns>
+      /// <exception cref="System.NullReferenceException">If <paramref name="obj"/> is <c>null</c>.</exception>
       [return: global::System.Diagnostics.CodeAnalysis.NotNullIfNotNull("obj")]
       public static explicit operator int(global::Thinktecture.Tests.TestValueObject obj)
       {

diff --git a/...ests.Should_generate_int_based_keyed_class_with_DefaultWithKeyTypeOverloads_0.verified.cs b/...ests.Should_generate_int_based_keyed_class_with_DefaultWithKeyTypeOverloads_0.verified.cs
@@ -103,7 +103,8 @@ public static bool TryCreate(
       /// Explicit conversion to the type <see cref="int"/>.
       /// </summary>
       /// <param name="obj">Object to covert.</param>
-      /// <returns>The <see cref="_value"/> of provided <paramref name="obj"/> or <c>default</c> if <paramref name="obj"/> is <c>null</c>.</returns>
+      /// <returns>The <see cref="_value"/> of provided <paramref name="obj"/>.</returns>
+      /// <exception cref="System.NullReferenceException">If <paramref name="obj"/> is <c>null</c>.</exception>
       [return: global::System.Diagnostics.CodeAnalysis.NotNullIfNotNull("obj")]
       public static explicit operator int(global::Thinktecture.Tests.TestValueObject obj)
       {

diff --git a/...atorTests.Should_not_generate_factory_methods_if_SkipFactoryMethods_is_true_0.verified.cs b/...atorTests.Should_not_generate_factory_methods_if_SkipFactoryMethods_is_true_0.verified.cs
@@ -54,7 +54,8 @@ internal static void ModuleInit()
       /// Explicit conversion to the type <see cref="int"/>.
       /// </summary>
       /// <param name="obj">Object to covert.</param>
-      /// <returns>The <see cref="_value"/> of provided <paramref name="obj"/> or <c>default</c> if <paramref name="obj"/> is <c>null</c>.</returns>
+      /// <returns>The <see cref="_value"/> of provided <paramref name="obj"/>.</returns>
+      /// <exception cref="System.NullReferenceException">If <paramref name="obj"/> is <c>null</c>.</exception>
       [return: global::System.Diagnostics.CodeAnalysis.NotNullIfNotNull("obj")]
       public static explicit operator int(global::Thinktecture.Tests.TestValueObject obj)
       {

diff --git a/test/Thinktecture.Runtime.Extensions.Tests/ValueObjectTests/ImplicitConversion.cs b/test/Thinktecture.Runtime.Extensions.Tests/ValueObjectTests/ImplicitConversion.cs
@@ -5,14 +5,14 @@ namespace Thinktecture.Runtime.Tests.ValueObjectTests;
 public class ImplicitConversion
 {
    [Fact]
-   public void Should_return_nullable_key_if_value_type_is_reference_type_and_key_is_struct()
+   public void Should_return_nullable_key_if_value_object_is_reference_type_and_key_is_struct()
    {
       int? value = IntBasedReferenceValueObject.Create(42);
       value.Should().Be(42);
    }
 
    [Fact]
-   public void Should_return_null_if_value_type_is_reference_type_and_null_and_key_is_struct()
+   public void Should_return_null_if_value_object_is_reference_type_and_null_and_key_is_struct()
    {
       IntBasedReferenceValueObject obj = null;
       int? value = obj;
@@ -21,17 +21,38 @@ public void Should_return_null_if_value_type_is_reference_type_and_null_and_key_
    }
 
    [Fact]
-   public void Should_return_key_if_value_type_is_reference_type_and_key_is_reference_type()
+   public void Should_return_key_if_value_object_is_reference_type_and_key_is_reference_type()
    {
       string value = StringBasedReferenceValueObject.Create("value");
       value.Should().Be("value");
    }
 
    [Fact]
-   public void Should_return_null_if_value_type_is_reference_type_and_null_and_key_is_reference_type()
+   public void Should_return_null_if_value_object_is_reference_type_and_null_and_key_is_reference_type()
    {
       StringBasedReferenceValueObject obj = null;
       string value = obj;
       value.Should().BeNull();
    }
+
+   [Fact]
+   public void Should_return_key_if_value_object_is_struct_and_key_is_struct()
+   {
+      int value = IntBasedStructValueObject.Create(42);
+      value.Should().Be(42);
+   }
+
+   [Fact]
+   public void Should_return_nullable_key_if_value_object_is_nullable_struct_and_key_is_struct()
+   {
+      int? value = (IntBasedStructValueObject?)IntBasedStructValueObject.Create(42);
+      value.Should().Be(42);
+   }
+
+   [Fact]
+   public void Should_return_null_if_value_object_is_nullable_struct_and_null_and_key_is_struct()
+   {
+      int? value = (IntBasedStructValueObject?)null;
+      value.Should().BeNull();
+   }
 }