feat: enum handling with tests

Author: pdevito3

QueryKit.IntegrationTests/Tests/DatabaseFilteringTests.cs

@@ -501,21 +501,21 @@ public async Task can_filter_complex_expression()
         var fakePersonOne = new FakeTestingPersonBuilder()
             .WithTitle("Waffle & Chicken")
             .WithAge(35)
-            .WithBirthMonth("January")
+            .WithBirthMonth(BirthMonthEnum.January)
             .WithRating(4.0M)
             .WithSpecificDate(new DateTime(2022, 07, 01, 00, 00, 03, DateTimeKind.Utc))
             .WithDate(DateOnly.FromDateTime(new DateTime(2022, 07, 01)))
             .Build();
         var fakePersonTwo = new FakeTestingPersonBuilder()
             .WithTitle("Lamb")
             .WithAge(17)
-            .WithBirthMonth("February")
+            .WithBirthMonth(BirthMonthEnum.February)
             .WithRating(3.4M)
             .WithSpecificDate(new DateTime(2022, 07, 01, 00, 00, 03, DateTimeKind.Utc))
             .Build();
         await testingServiceScope.InsertAsync(fakePersonOne, fakePersonTwo);
 
-        var input = $"""""((Title @=* "waffle & chicken" && Age > 30) || Id == "{fakePersonOne.Id}" || Title == "lamb" || Title == null) && (Age < 18 || (BirthMonth == "January" && Title _= "ally")) || Rating > 3.5 || SpecificDate == 2022-07-01T00:00:03Z && (Date == 2022-07-01 || Time == 00:00:03)""""";
+        var input = $"""""((Title @=* "waffle & chicken" && Age > 30) || Id == "{fakePersonOne.Id}" || Title == "lamb" || Title == null) && (Age < 18 || (BirthMonth == 1 && Title _= "ally")) || Rating > 3.5 || SpecificDate == 2022-07-01T00:00:03Z && (Date == 2022-07-01 || Time == 00:00:03)""""";
 
         // Act
         var queryablePeople = testingServiceScope.DbContext().People;

QueryKit.IntegrationTests/Tests/DatabaseSortingTests.cs

@@ -16,22 +16,22 @@ public async Task can_sort_items_with_mixed_order_directions()
         var fakePersonOne = new FakeTestingPersonBuilder()
             .WithTitle("alpha")
             .WithAge(10)
-            .WithBirthMonth("January")
+            .WithBirthMonth(BirthMonthEnum.January)
             .Build();
         var fakePersonTwo = new FakeTestingPersonBuilder()
             .WithTitle("beta")
             .WithAge(100)
-            .WithBirthMonth("February")
+            .WithBirthMonth(BirthMonthEnum.February)
             .Build();
         var fakePersonThree = new FakeTestingPersonBuilder()
             .WithTitle("beta")
             .WithAge(50)
-            .WithBirthMonth("March")
+            .WithBirthMonth(BirthMonthEnum.March)
             .Build();
         var fakePersonFour = new FakeTestingPersonBuilder()
             .WithTitle("beta")
             .WithAge(20)
-            .WithBirthMonth("April")
+            .WithBirthMonth(BirthMonthEnum.April)
             .Build();
         await testingServiceScope.InsertAsync(fakePersonOne, fakePersonTwo, fakePersonThree, fakePersonFour);
 
@@ -177,12 +177,12 @@ public async Task can_sort_multiple_items_with_same_order_direction()
         var fakePersonOne = new FakeTestingPersonBuilder()
             .WithTitle("alpha")
             .WithAge(10)
-            .WithBirthMonth("January")
+            .WithBirthMonth(BirthMonthEnum.January)
             .Build();
         var fakePersonTwo = new FakeTestingPersonBuilder()
             .WithTitle("beta")
             .WithAge(100)
-            .WithBirthMonth("February")
+            .WithBirthMonth(BirthMonthEnum.February)
             .Build();
         await testingServiceScope.InsertAsync(fakePersonOne, fakePersonTwo);
 
@@ -213,17 +213,17 @@ public async Task can_sort_items_with_null_value_property()
         var fakePersonTwo = new FakeTestingPersonBuilder()
             .WithTitle("alpha")
             .WithAge(100)
-            .WithBirthMonth("January")
+            .WithBirthMonth(BirthMonthEnum.January)
             .Build();
         var fakePersonThree = new FakeTestingPersonBuilder()
             .WithTitle("beta")
             .WithAge(50)
-            .WithBirthMonth("March")
+            .WithBirthMonth(BirthMonthEnum.March)
             .Build();
         var fakePersonFour = new FakeTestingPersonBuilder()
             .WithTitle("beta")
             .WithAge(20)
-            .WithBirthMonth("February")
+            .WithBirthMonth(BirthMonthEnum.February)
             .Build();
         await testingServiceScope.InsertAsync(fakePersonOne, fakePersonTwo, fakePersonThree, fakePersonFour);
 

QueryKit.WebApiTestProject/Entities/TestingPerson.cs

@@ -4,7 +4,7 @@ public class TestingPerson
 {
     public string? Title { get; set; }
     public int? Age { get; set; }
-    public string? BirthMonth { get; set; }
+    public BirthMonthEnum? BirthMonth { get; set; }
     public decimal? Rating { get; set; }
     public DateOnly? Date { get; set; }
     public bool? Favorite { get; set; }
@@ -14,4 +14,20 @@ public class TestingPerson
     public Guid Id { get; set; } = Guid.NewGuid();
     public EmailAddress Email { get; set; }
     public Address PhysicalAddress { get; set; }
+}
+
+public enum BirthMonthEnum
+{
+    January = 1,
+    February = 2,
+    March = 3,
+    April = 4,
+    May = 5,
+    June = 6,
+    July = 7,
+    August = 8,
+    September = 9,
+    October = 10,
+    November = 11,
+    December = 12
 }

…4020352_BaseTestingMigration.Designer.cs …2014351_BaseTestingMigration.Designer.csQueryKit.WebApiTestProject/Migrations/20230724020352_BaseTestingMigration.Designer.cs renamed to QueryKit.WebApiTestProject/Migrations/20231222014351_BaseTestingMigration.Designer.cs QueryKit.WebApiTestProject/Migrations/20230724020352_BaseTestingMigration.Designer.cs renamed to QueryKit.WebApiTestProject/Migrations/20231222014351_BaseTestingMigration.Designer.cs

@@ -22,7 +22,7 @@ protected override void Up(MigrationBuilder migrationBuilder)
                     id = table.Column<Guid>(type: "uuid", nullable: false),
                     title = table.Column<string>(type: "text", nullable: true),
                     age = table.Column<int>(type: "integer", nullable: true),
-                    birth_month = table.Column<string>(type: "text", nullable: true),
+                    birth_month = table.Column<int>(type: "integer", nullable: true),
                     rating = table.Column<decimal>(type: "numeric", nullable: true),
                     date = table.Column<DateOnly>(type: "date", nullable: true),
                     favorite = table.Column<bool>(type: "boolean", nullable: true),

…s/20230724020352_BaseTestingMigration.cs …s/20231222014351_BaseTestingMigration.csQueryKit.WebApiTestProject/Migrations/20230724020352_BaseTestingMigration.cs renamed to QueryKit.WebApiTestProject/Migrations/20231222014351_BaseTestingMigration.cs QueryKit.WebApiTestProject/Migrations/20230724020352_BaseTestingMigration.cs renamed to QueryKit.WebApiTestProject/Migrations/20231222014351_BaseTestingMigration.cs

@@ -18,7 +18,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
         {
 #pragma warning disable 612, 618
             modelBuilder
-                .HasAnnotation("ProductVersion", "7.0.5")
+                .HasAnnotation("ProductVersion", "8.0.0")
                 .HasAnnotation("Relational:MaxIdentifierLength", 63);
 
             NpgsqlModelBuilderExtensions.HasPostgresExtension(modelBuilder, "fuzzystrmatch");
@@ -174,8 +174,8 @@ protected override void BuildModel(ModelBuilder modelBuilder)
                         .HasColumnType("integer")
                         .HasColumnName("age");
 
-                    b.Property<string>("BirthMonth")
-                        .HasColumnType("text")
+                    b.Property<int?>("BirthMonth")
+                        .HasColumnType("integer")
                         .HasColumnName("birth_month");
 
                     b.Property<DateOnly?>("Date")

QueryKit.WebApiTestProject/Migrations/TestingDbContextModelSnapshot.cs

@@ -180,7 +180,7 @@ private static Expression CreateRightExprFromType(Type leftExprType, string righ
         }
 
         var rawType = targetType;
-
+        
         targetType = TransformTargetTypeIfNullable(targetType);
 
         if (TypeConversionFunctions.TryGetValue(targetType, out var conversionFunction))
@@ -304,10 +304,22 @@ private static Expression CreateRightExprFromType(Type leftExprType, string righ
             return Expression.Constant(convertedValue, leftExprType);
         }
 
-        if (targetType.IsEnum)
+        if (rawType.IsEnum || (Nullable.GetUnderlyingType(rawType)?.IsEnum ?? false))
         {
-            var enumValue = Enum.Parse(targetType, right);
-            return Expression.Constant(enumValue, targetType);
+            var enumType = Nullable.GetUnderlyingType(rawType) ?? rawType;
+    
+            if (right == "null" && Nullable.GetUnderlyingType(rawType) != null)
+            {
+                return Expression.Constant(null, rawType);
+            }
+            
+            var enumValue = Enum.Parse(enumType, right);
+            var constant = Expression.Constant(enumValue, enumType);
+
+            if (rawType == enumType) return constant;
+            
+            var nullableCtor = rawType.GetConstructor(new[] {enumType});
+            return Expression.New(nullableCtor, constant);
         }
 
         throw new InvalidOperationException($"Unsupported value '{right}' for type '{targetType.Name}'");

QueryKit/FilterParser.cs

@@ -187,6 +187,21 @@ If you want to filter on the count of a collection, you can prefix some of the o
 var input = """"Ingredients #>= 0"""";
 ```
 
+#### Filtering Enums
+
+You can filter enums with their respective integer value:
+
+```csharp
+var input = "BirthMonth == 1";
+
+public enum BirthMonthEnum
+{
+    January = 1,
+    February = 2,
+	  //...
+}
+```
+
 ### Settings
 
 #### Property Settings

README.md

@@ -27,7 +27,7 @@ public FakeTestingPersonBuilder WithEmail(string email)
         return this;
     }
 
-    public FakeTestingPersonBuilder WithBirthMonth(string value)
+    public FakeTestingPersonBuilder WithBirthMonth(BirthMonthEnum? value)
     {
         _baseTestingPerson.BirthMonth = value;
         return this;