Moved default comparer accessor to TT.Runtime.Extensions

PawelGerr · PawelGerr · commit c149d44e4729 · 2023-03-05T17:36:36.000+01:00
diff --git a/README.md b/README.md
@@ -38,23 +38,148 @@ Features:
 * Provides appropriate constructor, based on the specified properties/fields
 * Provides means for lookup, cast and type conversion from key-type to Smart Enum and vice versa
 * Provides proper implementation of `Equals`, `GetHashCode`, `ToString` and equality comparison via `==` and `!=`
+* Provides implementation of `IComparable`, `IComparable<T>`, `IFormattable`, `IParsable<T>` and comparison operators `<`, `<=`, `>`, `>=` (if applicable to the underlying type)
 * [Choice between always-valid `IEnum<T>` and maybe-valid `IValidatableEnum<T>`](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Smart-Enums#ienumt-vs-ivalidatableenumt)
+* [Makes use of abstract static members](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Smart-Enums#make-use-of-abstract-static-members)
+* [Derived types can be generic](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Smart-Enums#generic-derived-types)
 * [Allows custom validation of constructor arguments](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Smart-Enums#validation-of-the-constructor-arguments)
 * [Allows changing the property name `Key`](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Smart-Enums#changing-the-key-property-name), which holds the underlying value - thanks to [Roslyn Source Generator](https://docs.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/source-generators-overview)
 * [Allows custom key comparer](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Smart-Enums#custom-key-comparer)
 * [JSON support](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Smart-Enums#json-serialization) (`System.Text.Json` and `Newtonsoft.Json`)
-* [ASP.NET Core support](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Smart-Enums#support-for-aspnet-core-model-binding) (model binding and model validation)
+* [Support for Minimal Web Api Parameter Binding and ASP.NET Core Model Binding](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Smart-Enums#support-for-minimal-web-api-parameter-binding-and-aspnet-core-model-binding)
 * [Entity Framework Core support](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Smart-Enums#support-for-entity-framework-core) (`ValueConverter`)
 * [MessagePack support](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Smart-Enums#messagepack-serialization) (`IMessagePackFormatter`)
 
-Definition of a new Smart Enum without any custom properties and methods. All other features mentioned above are generated by the [Roslyn Source Generators](https://docs.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/source-generators-overview) in the background.
+Definition of a 2 Smart Enums without any custom properties and methods. All other features mentioned above are generated by the [Roslyn Source Generators](https://docs.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/source-generators-overview) in the background.
 
 ```C#
-public partial class ProductType : IEnum<string>
+// Smart Enum with a string as the underlying type
+public sealed partial class ProductType : IEnum<string>
 {
    public static readonly ProductType Groceries = new("Groceries");
    public static readonly ProductType Housewares = new("Housewares");
 }
+
+// Smart Enum with an int as the underlying type
+public sealed partial class ProductGroup : IEnum<int>
+{
+   public static readonly ProductGroup Apple = new(1);
+   public static readonly ProductGroup Orange = new(2);
+}
+```
+
+Behind the scenes a Roslyn Source Generator, which comes with the library, generates additional code. Some of the features that are now available are ...
+
+```C#
+// a private constructor which takes the key and additional members (if we had any)
+public sealed partial class ProductType : IEnum<string>
+{
+   public static readonly ProductType Groceries = new("Groceries");
+   ...
+
+------------
+
+// a property for iteration over all items
+IReadOnlyList<ProductType> allTypes = ProductType.Items;
+
+------------
+
+// getting the item with specific name, i.e. its key
+// throw UnknownEnumIdentifierException if the provided key doesn't match to any item
+ProductType productType = ProductType.Get("Groceries");
+
+// Alternatively, using an explicit cast (behaves the same as with Get)
+ProductType productType = (ProductType)"Groceries";
+
+------------
+
+// the same as above but returns a bool instead of throwing an exception (dictionary-style)
+bool found = ProductType.TryGet("Groceries", out ProductType productType);
+
+------------
+
+// similar to TryGet but returns a ValidationResult instead of a boolean.
+ValidationResult? validationResult = ProductType.Validate("Groceries", out productType);
+
+if (validationResult == ValidationResult.Success)
+{
+    logger.Information("Product type {Type} found with Validate", productType);
+}
+else
+{
+    logger.Warning("Failed to fetch the product type with Validate. Validation result: {ValidationResult}", validationResult.ErrorMessage);
+}
+
+------------
+
+// implicit conversion to the type of the key
+string key = ProductType.Groceries; // "Groceries"
+
+------------
+
+// Equality comparison with 'Equals' 
+// which compares the keys using default or custom 'IEqualityComparer<T>'
+bool equal = ProductType.Groceries.Equals(ProductType.Groceries);
+
+------------
+
+// Equality comparison with '==' and '!='
+bool equal = ProductType.Groceries == ProductType.Groceries;
+bool notEqual = ProductType.Groceries != ProductType.Groceries;
+
+------------
+
+// Hash code
+int hashCode = ProductType.Groceries.GetHashCode();
+
+------------
+
+// 'ToString' implementation
+string key = ProductType.Groceries.ToString(); // "Groceries"
+
+------------
+
+ILogger logger = ...;
+
+// Switch-case (Action)
+productType.Switch(ProductType.Groceries, () => logger.Information("Switch with Action: Groceries"),
+                   ProductType.Housewares, () => logger.Information("Switch with Action: Housewares"));
+                   
+// Switch-case with parameter (Action<TParam>) to prevent closures
+productType.Switch(logger,
+                   ProductType.Groceries, static l => l.Information("Switch with Action: Groceries"),
+                   ProductType.Housewares, static l => l.Information("Switch with Action: Housewares"));
+
+// Switch case returning a value (Func<TResult>)
+var returnValue = productType.Switch(ProductType.Groceries, static () => "Switch with Func<T>: Groceries",
+                                     ProductType.Housewares, static () => "Switch with Func<T>: Housewares");
+
+// Switch case with parameter returning a value (Func<TParam, TResult>) to prevent closures
+returnValue = productType.Switch(logger,
+                                 ProductType.Groceries, static l => "Switch with Func<T>: Groceries",
+                                 ProductType.Housewares, static l => "Switch with Func<T>: Housewares");
+
+------------
+
+// Implements IParsable<T> which is especially helpful with minimal web apis.
+// This feature can be disabled if it doesn't make sense (see EnumGenerationAttribute).
+bool parsed = ProductType.TryParse("Groceries", null, out var parsedProductType);
+
+------------
+
+// Implements IFormattable if the underlyng type (like int) is an IFormattable itself.
+// This feature can be disabled if it doesn't make sense (see EnumGenerationAttribute).
+var formatted = ProductGroup.Apple.ToString("000", CultureInfo.InvariantCulture); // 001
+
+------------
+
+// Implements IComparable and IComparable<T> if the underlyng type (like int) is an IComparable itself.
+// This feature can be disabled if it doesn't make sense (see EnumGenerationAttribute).
+var comparison = ProductGroup.Apple.CompareTo(ProductGroup.Orange); // -1
+
+// Implements comparison operators (<,<=,>,>=) if the underlyng type (like int) has comparison operators itself.
+// This feature can be disabled if it doesn't make sense (see EnumGenerationAttribute).
+var isBigger = ProductGroup.Apple > ProductGroup.Orange;       
 ```
 
 Definition of a new Smart Enum with 1 custom property `RequiresFoodVendorLicense` and 1 method `Do` with different behaviors for different enum items.
@@ -91,24 +216,24 @@ public partial class ProductType : IEnum<string>
 
 Install: `Install-Package Thinktecture.Runtime.Extensions`
 
-Documentation: [Immutable Value Objects](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Immutable-Value-Objects)
+Documentation: [Value Objects](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Value-Objects)
 
 Features:
 * Roslyn Analyzers and CodeFixes help the developers to implement the Value Objects correctly
 * Allows custom properties and methods
 * Provides appropriate factory methods for creation of new value objects based on the specified properties/fields
-* Allows custom validation of [constructor](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Immutable-Value-Objects#validation-of-the-constructor-arguments) and [factory method](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Immutable-Value-Objects#validation-of-the-factory-method-arguments) arguments
-* Additional features for [simple Value Objects (1 "key"-property/field)](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Immutable-Value-Objects#simple-value-objects) and [complex Value Objects (2 properties/fields or more)](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Immutable-Value-Objects#complex-value-objects)
+* Allows custom validation of [constructor](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Value-Objects#validation-of-the-constructor-arguments) and [factory method](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Value-Objects#validation-of-the-factory-method-arguments) arguments
+* Additional features for [simple Value Objects (1 "key"-property/field)](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Value-Objects#simple-value-objects) and [complex Value Objects (2 properties/fields or more)](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Value-Objects#complex-value-objects)
 * Simple Value Objects: allows cast and type conversion from key-type to Value Object and vice versa
 * Simple Value Objects: provides an implementation of `IComparable<T>` if the key-property/field is an `IComparable<T>` or has an `IComparer<T>`
 * Simple Value Objects: provides an implementation of `IFormattable` if the key-property/field is an `IFormattable`
 * Provides proper implementation of `Equals`, `GetHashCode`, `ToString` and equality comparison via `==` and `!=`
-* [Allows custom equality comparison](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Immutable-Value-Objects#custom-comparer)
-* Handling of [null](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Immutable-Value-Objects#null-in-factory-methods-yields-null) and [empty strings](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Immutable-Value-Objects#empty-string-in-factory-methods-yields-null)
-* [JSON support](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Immutable-Value-Objects#json-serialization) (`System.Text.Json` and `Newtonsoft.Json`)
-* [ASP.NET Core support](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Immutable-Value-Objects#support-for-aspnet-core-model-binding) (model binding and model validation)
-* [Entity Framework Core support](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Immutable-Value-Objects#support-for-entity-framework-core) (`ValueConverter`)
-* [MessagePack support](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Immutable-Value-Objects#messagepack-serialization) (`IMessagePackFormatter`)
+* [Allows custom equality comparison](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Value-Objects#custom-comparer)
+* Handling of [null](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Value-Objects#null-in-factory-methods-yields-null) and [empty strings](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Value-Objects#empty-string-in-factory-methods-yields-null)
+* [JSON support](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Value-Objects#json-serialization) (`System.Text.Json` and `Newtonsoft.Json`)
+* [ASP.NET Core support](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Value-Objects#support-for-aspnet-core-model-binding) (model binding and model validation)
+* [Entity Framework Core support](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Value-Objects#support-for-entity-framework-core) (`ValueConverter`)
+* [MessagePack support](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Value-Objects#messagepack-serialization) (`IMessagePackFormatter`)
 
 Definition of a value object with 1 custom property `Value`. All other features mentioned above are generated by the [Roslyn Source Generators](https://docs.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/source-generators-overview) in the background.
 
diff --git a/samples/Thinktecture.Runtime.Extensions.EntityFrameworkCore.Samples/ProductsDbContext.cs b/samples/Thinktecture.Runtime.Extensions.EntityFrameworkCore.Samples/ProductsDbContext.cs
@@ -1,4 +1,5 @@
 ﻿using Microsoft.EntityFrameworkCore;
+using Thinktecture.SmartEnums;
 
 namespace Thinktecture;
 
@@ -26,9 +27,11 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
                                    });
 
       // Alternative way to apply ValueConverters to Smart Enums and Value Objects
-      // modelBuilder.AddEnumAndValueObjectConverters(true, property =>
-      //                                                    {
-      //
-      //                                                    });
+      // modelBuilder.AddEnumAndValueObjectConverters(validateOnWrite: true,
+      //                                              configureEnumsAndKeyedValueObjects: property =>
+      //                                                                                  {
+      //                                                                                     if (property.ClrType == typeof(ProductType))
+      //                                                                                        property.SetMaxLength(20);
+      //                                                                                  });
    }
 }
diff --git a/samples/Thinktecture.Runtime.Extensions.EntityFrameworkCore.Samples/Program.cs b/samples/Thinktecture.Runtime.Extensions.EntityFrameworkCore.Samples/Program.cs
@@ -85,7 +85,7 @@ private static IServiceProvider CreateServiceProvider(LoggingLevelSwitch logging
 
                             builder.AddSerilog(serilogLogger);
                          })
-             .AddDbContext<ProductsDbContext>(builder => builder.UseSqlServer("Server=localhost;Database=TT-Runtime-Extensions-Demo;Integrated Security=true")
+             .AddDbContext<ProductsDbContext>(builder => builder.UseSqlServer("Server=localhost;Database=TT-Runtime-Extensions-Demo;Integrated Security=true;TrustServerCertificate=true")
                                                                 .EnableSensitiveDataLogging()
                                                                 .UseValueObjectValueConverter(configureEnumsAndKeyedValueObjects: property =>
                                                                                                                                   {
diff --git a/samples/Thinktecture.Runtime.Extensions.Samples/SmartEnums/SmartEnumDemos.cs b/samples/Thinktecture.Runtime.Extensions.Samples/SmartEnums/SmartEnumDemos.cs
@@ -68,6 +68,9 @@ private static void DemoForNonValidatableEnum(ILogger logger)
 
       logger.Information(returnValue);
 
+      var parsed = ProductType.TryParse("Groceries", null, out var parsedProductType);
+      logger.Information("Parsed: {Parsed}", parsedProductType);
+
       var formatted = ProductGroup.Apple.ToString("000", CultureInfo.InvariantCulture); // 001
       logger.Information("Formatted: {Formatted}", formatted);
 
diff --git a/samples/Thinktecture.Runtime.Extensions.Samples/ValueObjects/Boundary.cs b/samples/Thinktecture.Runtime.Extensions.Samples/ValueObjects/Boundary.cs
@@ -13,6 +13,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes
       if (lower <= upper)
          return;
 
-      validationResult = new ValidationResult($"Lower boundary '{lower}' must be less than upper boundary '{upper}'");
+      validationResult = new ValidationResult($"Lower boundary '{lower}' must be less than upper boundary '{upper}'",
+                                              new[] { nameof(Lower), nameof(Upper) });
    }
 }
diff --git a/samples/Thinktecture.Runtime.Extensions.Samples/ValueObjects/ValueObjectDemos.cs b/samples/Thinktecture.Runtime.Extensions.Samples/ValueObjects/ValueObjectDemos.cs
@@ -1,4 +1,5 @@
 using System.ComponentModel.DataAnnotations;
+using System.Globalization;
 using Serilog;
 
 namespace Thinktecture.ValueObjects;
@@ -7,7 +8,13 @@ public class ValueObjectDemos
 {
    public static void Demo(ILogger logger)
    {
-      logger.Information("==== Demo for ValueObjectAttribute ====");
+      DemoForSimpleValueObjects(logger);
+      DemoForComplexValueObjects(logger);
+   }
+
+   private static void DemoForSimpleValueObjects(ILogger logger)
+   {
+      logger.Information("==== Demo for Simple Value Objects ====");
 
       var bread = ProductName.Create("Bread");
       logger.Information("Product name: {Bread}", bread);
@@ -51,12 +58,47 @@ public static void Demo(ILogger logger)
       if (ProductName.TryCreate(null, out nullProduct))
          logger.Information("Null-Product name: {NullProduct}", nullProduct);
 
-      // Addition / subtraction / multiplication / division / comparison
+      if (ProductName.TryParse("New product name", null, out var productName))
+         logger.Information("Parsed name: {ParsedProductName}", productName);
+
+      var formattedValue = Amount.Create(42).ToString("000", CultureInfo.InvariantCulture); // "042"
+      logger.Information("Formatted: {Formatted}", formattedValue);
+
       var amount = Amount.Create(1);
       var otherAmount = Amount.Create(2);
+
+      var comparison = amount.CompareTo(otherAmount);
+      logger.Information("Comparison: {Comparison}", comparison);
+
+      // Addition / subtraction / multiplication / division / comparison
       var sum = amount + otherAmount;
       logger.Information("{Amount} + {Other} = {Sum}", amount, otherAmount, sum);
 
       logger.Information("{Amount} > {Other} = {Result}", amount, otherAmount, amount > otherAmount);
    }
+
+   private static void DemoForComplexValueObjects(ILogger logger)
+   {
+      logger.Information("==== Demo for Complex Value Objects ====");
+
+      Boundary boundaryWithCreate = Boundary.Create(lower: 1, upper: 2);
+      logger.Information("Boundary with Create: {Boundary}", boundaryWithCreate);
+
+      if (Boundary.TryCreate(lower: 1, upper: 2, out var boundaryWithTryCreate))
+         logger.Information("Boundary with TryCreate: {Boundary}", boundaryWithTryCreate);
+
+      var validationResult = Boundary.Validate(lower: 1, upper: 2, out var boundaryWithValidate);
+
+      if (validationResult == ValidationResult.Success)
+      {
+         logger.Information("Boundary {Boundary} created via Validate", boundaryWithValidate);
+      }
+      else
+      {
+         logger.Warning("Failed to create boundary. Validation result: {ValidationResult}", validationResult!.ErrorMessage);
+      }
+
+      var equal = boundaryWithCreate.Equals(boundaryWithCreate);
+      logger.Information("Boundaries are equal: {Equal}", equal);
+   }
 }
diff --git a/src/Thinktecture.Runtime.Extensions/ComparerAccessors.cs b/src/Thinktecture.Runtime.Extensions/ComparerAccessors.cs
@@ -28,4 +28,17 @@ public class StringOrdinalIgnoreCase : IEqualityComparerAccessor<string>, ICompa
       /// <inheritdoc />
       public static IComparer<string> Comparer => StringComparer.OrdinalIgnoreCase;
    }
+
+   /// <summary>
+   /// Provides the default comparers.
+   /// </summary>
+   /// <typeparam name="T"></typeparam>
+   public class Default<T> : IEqualityComparerAccessor<T>, IComparerAccessor<T>
+   {
+      /// <inheritdoc />
+      public static IEqualityComparer<T> EqualityComparer => EqualityComparer<T>.Default;
+
+      /// <inheritdoc />
+      public static IComparer<T> Comparer => Comparer<T>.Default;
+   }
 }
diff --git a/test/Thinktecture.Runtime.Extensions.SourceGenerator.Tests/AnalyzerAndCodeFixTests/TTRESG031_ComparerApplicableOnKeyMemberOnly.cs b/test/Thinktecture.Runtime.Extensions.SourceGenerator.Tests/AnalyzerAndCodeFixTests/TTRESG031_ComparerApplicableOnKeyMemberOnly.cs
diff --git a/test/Thinktecture.Runtime.Extensions.SourceGenerator.Tests/AnalyzerAndCodeFixTests/TTRESG041_ComparerTypeMustMatchMemberType.cs b/test/Thinktecture.Runtime.Extensions.SourceGenerator.Tests/AnalyzerAndCodeFixTests/TTRESG041_ComparerTypeMustMatchMemberType.cs
diff --git a/test/Thinktecture.Runtime.Extensions.Tests.Shared/DefaultComparerAccessor.cs b/test/Thinktecture.Runtime.Extensions.Tests.Shared/DefaultComparerAccessor.cs

Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ private static IServiceProvider CreateServiceProvider(LoggingLevelSwitch logging`
`85`	`85`
`86`	`86`	`builder.AddSerilog(serilogLogger);`
`87`	`87`	`})`
`88`		`- .AddDbContext<ProductsDbContext>(builder => builder.UseSqlServer("Server=localhost;Database=TT-Runtime-Extensions-Demo;Integrated Security=true")`
	`88`	`+ .AddDbContext<ProductsDbContext>(builder => builder.UseSqlServer("Server=localhost;Database=TT-Runtime-Extensions-Demo;Integrated Security=true;TrustServerCertificate=true")`
`89`	`89`	`.EnableSensitiveDataLogging()`
`90`	`90`	`.UseValueObjectValueConverter(configureEnumsAndKeyedValueObjects: property =>`
`91`	`91`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ static partial void ValidateFactoryArguments(ref ValidationResult? validationRes`
`13`	`13`	`if (lower <= upper)`
`14`	`14`	`return;`
`15`	`15`
`16`		`- validationResult = new ValidationResult($"Lower boundary '{lower}' must be less than upper boundary '{upper}'");`
	`16`	`+ validationResult = new ValidationResult($"Lower boundary '{lower}' must be less than upper boundary '{upper}'",`
	`17`	`+ new[] { nameof(Lower), nameof(Upper) });`
`17`	`18`	`}`
`18`	`19`	`}`