Removed "validatable" smart enums

Author: PawelGerr

README.md

@@ -34,6 +34,7 @@ See [wiki](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki) fo
 
 # Migrations
 
+* [Migration from v8 to v9](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Migration-from-v8-to-v9)
 * [Migration from v7 to v8](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Migration-from-v7-to-v8)
 * [Migration from v6 to v7](https://github.com/PawelGerr/Thinktecture.Runtime.Extensions/wiki/Migration-from-v6-to-v7)
 

docs

@@ -26,7 +26,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/ProductCategoryBoolean<>f__AnonymousType0"
+                  "$ref": "#/components/schemas/ProductCategory"
                 }
               }
             }
@@ -55,7 +55,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/ProductGroupBoolean<>f__AnonymousType0"
+                  "$ref": "#/components/schemas/ProductGroup"
                 }
               }
             }
@@ -575,18 +575,6 @@
           "Dairy"
         ]
       },
-      "ProductCategoryBoolean<>f__AnonymousType0": {
-        "type": "object",
-        "properties": {
-          "value": {
-            "$ref": "#/components/schemas/ProductCategory"
-          },
-          "isValid": {
-            "type": "boolean"
-          }
-        },
-        "additionalProperties": false
-      },
       "ProductGroup": {
         "enum": [
           1,
@@ -599,18 +587,6 @@
           "Orange"
         ]
       },
-      "ProductGroupBoolean<>f__AnonymousType0": {
-        "type": "object",
-        "properties": {
-          "value": {
-            "$ref": "#/components/schemas/ProductGroup"
-          },
-          "isValid": {
-            "type": "boolean"
-          }
-        },
-        "additionalProperties": false
-      },
       "ProductName": {
         "type": "string"
       },

samples/AspNetCore.Samples/AspNetCore.Samples_demo.json

@@ -22,13 +22,13 @@ public DemoController(ILogger<DemoController> logger)
    [HttpGet("category/{category}")]
    public IActionResult RoundTrip(ProductCategory category)
    {
-      return RoundTripValidatableEnum(category);
+      return RoundTripInternal(category);
    }
 
    [HttpGet("group/{group}")]
    public IActionResult RoundTrip(ProductGroup group)
    {
-      return RoundTripValidatableEnum(group);
+      return RoundTripInternal(group);
    }
 
    [HttpGet("productType/{productType}")]
@@ -143,17 +143,6 @@ public IActionResult RoundTrip(TextOrNumberSerializable textOrNumber)
       return Json(textOrNumber);
    }
 
-   private IActionResult RoundTripValidatableEnum<T>(T value)
-      where T : IValidatableEnum
-   {
-      if (!ModelState.IsValid)
-         return BadRequest(ModelState);
-
-      _logger.LogInformation("Round trip test with {Type}: {Value}", value.GetType().Name, value);
-
-      return Json(new { Value = value, value.IsValid });
-   }
-
    private IActionResult RoundTripInternal<T>(T value)
       where T : notnull
    {

samples/AspNetCore.Samples/Controllers/DemoController.cs

@@ -173,8 +173,8 @@ private static Task StartMinimalWebApiAsync(ILoggerFactory loggerFactory)
 
       var routeGroup = app.MapGroup("/api");
 
-      routeGroup.MapGet("category/{category}", (ProductCategory category) => new { Value = category, category.IsValid });
-      routeGroup.MapGet("group/{group}", (ProductGroup group) => new { Value = group, group.IsValid });
+      routeGroup.MapGet("category/{category}", (ProductCategory category) => category);
+      routeGroup.MapGet("group/{group}", (ProductGroup group) => group);
       routeGroup.MapGet("productType/{productType}", (ProductType productType) => productType);
       routeGroup.MapGet("productType", (ProductType productType) => productType);
       routeGroup.MapGet("productTypeWithFilter", (BoundValueObject<ProductType, ProductTypeValidationError> productType) => ValueTask.FromResult(productType.Value))

samples/AspNetCore.Samples/Program.cs

@@ -33,14 +33,9 @@ public static bool TryParse(string s, IFormatProvider? formatProvider, out Bound
       {
          var validationError = T.Validate(key, formatProvider, out var item);
 
-         if (validationError is null || item is IValidatableEnum)
-         {
-            value = new BoundValueObject<T, TKey, TValidationError>(item);
-         }
-         else
-         {
-            value = new BoundValueObject<T, TKey, TValidationError>(validationError.ToString() ?? "Invalid format");
-         }
+         value = validationError is null
+                    ? new BoundValueObject<T, TKey, TValidationError>(item)
+                    : new BoundValueObject<T, TKey, TValidationError>(validationError.ToString() ?? "Invalid format");
       }
 
       return true;
@@ -70,14 +65,9 @@ public static bool TryParse(string s, IFormatProvider? formatProvider, out Bound
    {
       var validationError = T.Validate(s, formatProvider, out var item);
 
-      if (validationError is null || item is IValidatableEnum)
-      {
-         value = new BoundValueObject<T, TValidationError>(item);
-      }
-      else
-      {
-         value = new BoundValueObject<T, TValidationError>(validationError.ToString() ?? "Invalid format");
-      }
+      value = validationError is null
+                 ? new BoundValueObject<T, TValidationError>(item)
+                 : new BoundValueObject<T, TValidationError>(validationError.ToString() ?? "Invalid format");
 
       return true;
    }

samples/AspNetCore.Samples/Validation/BoundValueObject.cs

@@ -1,7 +1,6 @@
 namespace Thinktecture.SmartEnums;
 
-[SmartEnum<string>(IsValidatable = true,
-                   KeyMemberName = "Name")]
+[SmartEnum<string>(KeyMemberName = "Name")]
 public partial class ProductCategory
 {
    public static readonly ProductCategory Fruits = new("Fruits");

samples/Basic.Samples/SmartEnums/ProductCategory.cs

@@ -1,7 +1,6 @@
 namespace Thinktecture.SmartEnums;
 
-[SmartEnum<int>(IsValidatable = true,
-                ComparisonOperators = OperatorsGeneration.DefaultWithKeyTypeOverloads,
+[SmartEnum<int>(ComparisonOperators = OperatorsGeneration.DefaultWithKeyTypeOverloads,
                 SkipToString = true)]
 public partial class ProductGroup
 {
@@ -13,20 +12,11 @@ public partial class ProductGroup
 
    public int Do(string foo)
    {
-      EnsureValid(); // "Do()" is not allowed for invalid items
-
       // do something
 
       return 42;
    }
 
-   private static ProductGroup CreateInvalidItem(int key)
-   {
-      // the values can be anything besides the key,
-      // the key must not be null
-      return new(key, false, "Unknown product group", ProductCategory.Get("Unknown"));
-   }
-
    public override string ToString()
    {
       return DisplayName;

samples/Basic.Samples/SmartEnums/ProductGroup.cs

@@ -13,7 +13,6 @@ public static void Demo(ILogger logger)
    {
       DemoForSmartEnum(logger);
       DemoForSmartEnumWithCustomComparer(logger);
-      DemoForValidatableEnum(logger);
 
       DemoForDailySalesCsvImporterType(logger);
       DemoForMonthlySalesCsvImporterType(logger);
@@ -97,7 +96,10 @@ private static void DemoForSmartEnum(ILogger logger)
       isBigger = ProductGroup.Apple > 42;
       logger.Information("{Apple} > {42} = {IsBigger}", ProductGroup.Apple, 42, isBigger);
 
-      logger.Information("==== Demo for abstract static members ====");
+      logger.Information(@"
+
+==== Demo for abstract static members ====
+");
 
       Get<ProductType, string, ProductTypeValidationError>(logger, "Groceries");
    }
@@ -173,11 +175,6 @@ private static void SwitchWithAction(ILogger logger)
                          groceries: static l => l.Information("Switch with Action: Groceries"),
                          housewares: static l => l.Information("Switch with Action: Housewares"));
 
-      // Switch of a "validatable" enum
-      ProductGroupStruct.Get(42).Switch(invalid: invalidItem => Console.WriteLine($"Invalid item: {invalidItem}"),
-                                        apple: () => Console.WriteLine("apple"),
-                                        orange: () => Console.WriteLine("orange"));
-
       // SwitchPartially with Action
       productType.SwitchPartially(@default: item => logger.Information("SwitchPartially with Action: default ('{Item}')", item),
                                   groceries: () => logger.Information("SwitchPartially with Action: Groceries"));
@@ -188,11 +185,6 @@ private static void SwitchWithAction(ILogger logger)
       ProductType.Housewares.SwitchPartially(@default: item => logger.Information("SwitchPartially with Action: default ('{Item}')", item),
                                              groceries: () => logger.Information("SwitchPartially with Action: Groceries"));
 
-      // Switch of a "validatable" enum
-      ProductGroupStruct.Get(42).SwitchPartially(invalid: invalidItem => Console.WriteLine($"SwitchPartially with Action: Invalid item ({invalidItem})"),
-                                                 apple: () => Console.WriteLine("SwitchPartially with Action: apple"),
-                                                 orange: () => Console.WriteLine("SwitchPartially with Action: orange"));
-
       // SwitchPartially with Action<TState>
       productType.SwitchPartially(logger,
                                   @default: static (l, item) => l.Information("SwitchPartially with Action<TState>: default ('{Item}')", item),
@@ -242,35 +234,6 @@ private static void DemoForSmartEnumWithCustomComparer(ILogger logger)
                          lowerCased > upperCased);
    }
 
-   private static void DemoForValidatableEnum(ILogger logger)
-   {
-      logger.Information("""
-
-
-                         ==== Demo for SmartEnum<T>(IsValidatable = true) ====
-
-                         """);
-
-      var categories = ProductCategory.Items;
-      logger.Information("Categories: {Categories}", categories);
-
-      var category = ProductCategory.Get("Fruits");
-      logger.Information("Category: {Category}", category);
-
-      // Throws "InvalidOperationException" if not valid
-      category.EnsureValid();
-
-      if (ProductCategory.TryGet("fruits", out var fruits))
-         logger.Information("Category {Category} with TryGet found", fruits);
-
-      string keyOfTheCategory = category;
-      logger.Information("Implicit conversion of Category -> string: {Key}", keyOfTheCategory);
-
-      var unknownCategory = ProductCategory.Get("Grains");
-      logger.Information("unknownCategory.Key: {CategoryKey}", unknownCategory.Name);
-      logger.Information("unknownCategory.isValid: {IsValid}", unknownCategory.IsValid);
-   }
-
    private static void DemoForDailySalesCsvImporterType(ILogger logger)
    {
       logger.Information("""
@@ -350,7 +313,7 @@ private static void PrintAllItems<T, TKey, TValidationError>(ILogger logger)
 
       foreach (var item in T.Items)
       {
-         logger.Information("Item: {Item}", item);
+         logger.Information("  Item: {Item}", item);
       }
    }
 

samples/Basic.Samples/SmartEnums/ProductGroupStruct.cs

@@ -42,12 +42,8 @@ private readonly Entity_Enum_IntBased[] _Entity_Enum_IntBased
       = Enumerable.Range(1, _NUMBER_OF_ENTITIES).Select(i => new Entity_Enum_IntBased(i, _enums[i % _enums.Length]) { Enum = RealEnum.Value1 }).ToArray();
    private readonly Entity_SmartEnum_Class_StringBased[] _Entity_SmartEnum_Class_StringBased
       = Enumerable.Range(1, _NUMBER_OF_ENTITIES).Select(i => new Entity_SmartEnum_Class_StringBased(i, TestSmartEnum_Class_StringBased.Items[i % _enums.Length]) { Enum = TestSmartEnum_Class_StringBased.Value1 }).ToArray();
-   private readonly Entity_SmartEnum_Struct_StringBased[] _Entity_SmartEnum_Struct_StringBased
-      = Enumerable.Range(1, _NUMBER_OF_ENTITIES).Select(i => new Entity_SmartEnum_Struct_StringBased(i, TestSmartEnum_Struct_StringBased.Items[i % _enums.Length]) { Enum = TestSmartEnum_Struct_StringBased.Value1 }).ToArray();
    private readonly Entity_SmartEnum_Class_IntBased[] _Entity_SmartEnum_Class_IntBased
       = Enumerable.Range(1, _NUMBER_OF_ENTITIES).Select(i => new Entity_SmartEnum_Class_IntBased(i, TestSmartEnum_Class_IntBased.Items[i % _enums.Length]) { Enum = TestSmartEnum_Class_IntBased.Value1 }).ToArray();
-   private readonly Entity_SmartEnum_Struct_IntBased[] _Entity_SmartEnum_Struct_IntBased
-      = Enumerable.Range(1, _NUMBER_OF_ENTITIES).Select(i => new Entity_SmartEnum_Struct_IntBased(i, TestSmartEnum_Struct_IntBased.Items[i % _enums.Length]) { Enum = TestSmartEnum_Struct_IntBased.Value1 }).ToArray();
 
    [GlobalSetup]
    public void Initialize()
@@ -68,15 +64,9 @@ public void Initialize()
       _dbContext.RemoveRange(_dbContext.Entity_SmartEnum_Class_StringBased);
       _dbContext.Entity_SmartEnum_Class_StringBased.AddRange(_Entity_SmartEnum_Class_StringBased);
 
-      _dbContext.RemoveRange(_dbContext.Entity_SmartEnum_Struct_StringBased);
-      _dbContext.Entity_SmartEnum_Struct_StringBased.AddRange(_Entity_SmartEnum_Struct_StringBased);
-
       _dbContext.RemoveRange(_dbContext.Entity_SmartEnum_Class_IntBased);
       _dbContext.Entity_SmartEnum_Class_IntBased.AddRange(_Entity_SmartEnum_Class_IntBased);
 
-      _dbContext.RemoveRange(_dbContext.Entity_SmartEnum_Struct_IntBased);
-      _dbContext.Entity_SmartEnum_Struct_IntBased.AddRange(_Entity_SmartEnum_Struct_IntBased);
-
       _dbContext.SaveChanges();
    }
 
@@ -99,12 +89,6 @@ public async Task Real_Enum_StringConverter()
       await _dbContext!.Entity_Enum_StringConverter.ToListAsync();
    }
 
-   [Benchmark]
-   public async Task SmartEnum_Struct_StringBased()
-   {
-      await _dbContext!.Entity_SmartEnum_Struct_StringBased.ToListAsync();
-   }
-
    [Benchmark]
    public async Task SmartEnum_Class_StringBased()
    {
@@ -117,12 +101,6 @@ public async Task Real_Enum_IntBased()
       await _dbContext!.Entity_Enum_IntBased.ToListAsync();
    }
 
-   [Benchmark]
-   public async Task SmartEnum_Struct_IntBased()
-   {
-      await _dbContext!.Entity_SmartEnum_Struct_IntBased.ToListAsync();
-   }
-
    [Benchmark]
    public async Task SmartEnum_Class_IntBased()
    {

samples/Basic.Samples/SmartEnums/SmartEnumDemos.cs

@@ -8,9 +8,7 @@ public class BenchmarkDbContext : DbContext
    public DbSet<Entity_Enum_StringConverter> Entity_Enum_StringConverter { get; set; } = null!;
    public DbSet<Entity_Enum_IntBased> Entity_Enum_IntBased { get; set; } = null!;
    public DbSet<Entity_SmartEnum_Class_StringBased> Entity_SmartEnum_Class_StringBased { get; set; } = null!;
-   public DbSet<Entity_SmartEnum_Struct_StringBased> Entity_SmartEnum_Struct_StringBased { get; set; } = null!;
    public DbSet<Entity_SmartEnum_Class_IntBased> Entity_SmartEnum_Class_IntBased { get; set; } = null!;
-   public DbSet<Entity_SmartEnum_Struct_IntBased> Entity_SmartEnum_Struct_IntBased { get; set; } = null!;
 
    public DbSet<Entity_with_ValueObjects> Entity_with_ValueObjects { get; set; } = null!;
    public DbSet<Entity_without_ValueObjects> Entity_without_ValueObjects { get; set; } = null!;
@@ -37,13 +35,7 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
          builder.Property(e => e.Enum).HasMaxLength(20);
       });
 
-      modelBuilder.Entity<Entity_SmartEnum_Struct_StringBased>(builder =>
-      {
-         builder.Property(e => e.Id).ValueGeneratedNever();
-         builder.Property(e => e.Enum).HasMaxLength(20);
-      });
       modelBuilder.Entity<Entity_SmartEnum_Class_IntBased>(builder => builder.Property(e => e.Id).ValueGeneratedNever());
-      modelBuilder.Entity<Entity_SmartEnum_Struct_IntBased>(builder => builder.Property(e => e.Id).ValueGeneratedNever());
 
       modelBuilder.Entity<Entity_with_ValueObjects>(builder =>
       {