diff --git a/DynamicQueryBuilder.IntegrationTests/EntityFramework/Tests/EFIntegrationTests.cs b/DynamicQueryBuilder.IntegrationTests/EntityFramework/Tests/EFIntegrationTests.cs index 1ddbf8a..1125edd 100644 --- a/DynamicQueryBuilder.IntegrationTests/EntityFramework/Tests/EFIntegrationTests.cs +++ b/DynamicQueryBuilder.IntegrationTests/EntityFramework/Tests/EFIntegrationTests.cs @@ -18,6 +18,32 @@ public EFIntegrationTests() _ctx.SaveChanges(); _ctx.Users.AddRange(new User[] { + new User + { + Age = 0, + Name = "null", + Orders = new Order[] + { + new Order + { + OrderRef = "REF_12", + ProductName = "GoodProd", + Quantity = 157 + }, + new Order + { + OrderRef = "REF_13", + ProductName = "BetterProd", + Quantity = 90 + }, + new Order + { + OrderRef = "REF_14", + ProductName = "AREUNUTZ?", + Quantity = 48 + } + } + }, new User { Age = 1, @@ -186,10 +212,27 @@ public void FiltersShouldWork() } }).ToList(); + var resultOfNameNullAsString = queryable.ApplyFilters(new DynamicQueryOptions + { + Filters = new List + { + new Filter + { + Operator = FilterOperation.Equals, + PropertyName = "Name", + Value = "null" + } + }, + IgnorePredefinedOrders = true, + IsNullValueString = true + }).ToList(); + Assert.True(resultOfAgeTwo.Count == 3); Assert.True(resultOfNameTestOne.Count == 1); Assert.True(resultOfStringsComparisonTest.Count == 1); Assert.Equal("Test_4", resultOfStringsComparisonTest[0].Name); + Assert.True(resultOfNameNullAsString.Count == 1); + Assert.Equal("null", resultOfNameNullAsString[0].Name); } [Fact(DisplayName = "EF_PaginationShouldWork")] @@ -200,7 +243,7 @@ public void PaginationShouldWork() PaginationOption = new PaginationOption { Count = 1, - Offset = 2 + Offset = 3 }, UsesCaseInsensitiveSource = true, IgnorePredefinedOrders = true diff --git a/DynamicQueryBuilder.UnitTests/ExpressionBuilderTests/BuildFilterExpressionTests.cs b/DynamicQueryBuilder.UnitTests/ExpressionBuilderTests/BuildFilterExpressionTests.cs index 8a5f3e5..37477ec 100644 --- a/DynamicQueryBuilder.UnitTests/ExpressionBuilderTests/BuildFilterExpressionTests.cs +++ b/DynamicQueryBuilder.UnitTests/ExpressionBuilderTests/BuildFilterExpressionTests.cs @@ -58,7 +58,20 @@ public void ShouldHandleNullParameterValues() const string resultOfQuery = "(x.Name == \"\")"; Expression result = ExpressionBuilder.BuildFilterExpression( XParam, - new Filter { Value = null, PropertyName = "Name", Operator = FilterOperation.Equals }); + new Filter { Value = null, PropertyName = "Name", Operator = FilterOperation.Equals }, + isNullValueString: false); + + Assert.Equal(result.ToString(), resultOfQuery); + } + + [Fact] + public void ShouldHandleNullAsString() + { + const string resultOfQuery = "(x.Name == \"null\")"; + Expression result = ExpressionBuilder.BuildFilterExpression( + XParam, + new Filter { Value = "null", PropertyName = "Name", Operator = FilterOperation.Equals }, + isNullValueString: true); Assert.Equal(result.ToString(), resultOfQuery); } diff --git a/DynamicQueryBuilder/DynamicQueryAttribute.cs b/DynamicQueryBuilder/DynamicQueryAttribute.cs index 0373039..514d356 100644 --- a/DynamicQueryBuilder/DynamicQueryAttribute.cs +++ b/DynamicQueryBuilder/DynamicQueryAttribute.cs @@ -100,6 +100,7 @@ public override void OnActionExecuting(ActionExecutingContext context) parsedOptions.UsesCaseInsensitiveSource = dqbSettings.UsesCaseInsensitiveSource; parsedOptions.IgnorePredefinedOrders = dqbSettings.IgnorePredefinedOrders; + parsedOptions.IsNullValueString = dqbSettings.IsNullValueString; if (parsedOptions.PaginationOption != null) { parsedOptions.PaginationOption.AssignDataSetCount = _includeDataSetCountToPagination; diff --git a/DynamicQueryBuilder/ExpressionBuilder.cs b/DynamicQueryBuilder/ExpressionBuilder.cs index 4f72e65..408f43d 100644 --- a/DynamicQueryBuilder/ExpressionBuilder.cs +++ b/DynamicQueryBuilder/ExpressionBuilder.cs @@ -104,7 +104,7 @@ public static IQueryable ApplyFilters(this IQueryable currentSet, DynamicQueryOp List dqbFilters = dynamicQueryOptions.Filters.ToList(); // Since the expression is null at this point, we should create it with our first filter. - exp = BuildFilterExpression(param, dqbFilters.FirstOrDefault(), dynamicQueryOptions.UsesCaseInsensitiveSource); + exp = BuildFilterExpression(param, dqbFilters.FirstOrDefault(), dynamicQueryOptions.UsesCaseInsensitiveSource, dynamicQueryOptions.IsNullValueString); dqbFilters.RemoveAt(0); // Remove the first since it was added already. // Append the rest @@ -431,7 +431,7 @@ internal static void PopulateDynamicQueryOptions( /// Filter instance to build. /// Flag to detect if the query is going to run on a SQL database. /// Built query expression. - internal static Expression BuildFilterExpression(ParameterExpression param, Filter filter, bool usesCaseInsensitiveSource = false) + internal static Expression BuildFilterExpression(ParameterExpression param, Filter filter, bool usesCaseInsensitiveSource = false, bool isNullValueString = false) { string stringFilterValue = filter.Value?.ToString(); Expression parentMember = ExtractMember(param, filter.PropertyName, stringFilterValue == "null"); @@ -487,7 +487,9 @@ internal static Expression BuildFilterExpression(ParameterExpression param, Filt ? stringFilterValue : stringFilterValue?.ToLowerInvariant() : stringFilterValue?.ToLowerInvariant()) - : null; + : isNullValueString + ? "null" + : null; } Expression constant = Expression.Constant(convertedValue); diff --git a/DynamicQueryBuilder/Models/DynamicQueryBuilderSettings.cs b/DynamicQueryBuilder/Models/DynamicQueryBuilderSettings.cs index 7cddfca..7dd1dee 100644 --- a/DynamicQueryBuilder/Models/DynamicQueryBuilderSettings.cs +++ b/DynamicQueryBuilder/Models/DynamicQueryBuilderSettings.cs @@ -23,6 +23,12 @@ public class DynamicQueryBuilderSettings /// public bool IgnorePredefinedOrders { get; set; } + /// + /// Boolean flag to specify if null value should be used as string or sql null keyword. + /// If set true, DQB will use null value as string. If left false, DQB will use null value as sql keyword. + /// + public bool IsNullValueString { get; set; } = false; + /// /// Query options resolver to specify where DQB should be getting query options from. /// If left null, DQB will try to resolve options from the querystring. diff --git a/DynamicQueryBuilder/Models/DynamicQueryOptions.cs b/DynamicQueryBuilder/Models/DynamicQueryOptions.cs index 97d8dd1..77f6095 100644 --- a/DynamicQueryBuilder/Models/DynamicQueryOptions.cs +++ b/DynamicQueryBuilder/Models/DynamicQueryOptions.cs @@ -12,6 +12,8 @@ public sealed class DynamicQueryOptions public bool UsesCaseInsensitiveSource { get; set; } + public bool IsNullValueString { get; set; } + public bool IgnorePredefinedOrders { get; set; } } } diff --git a/docs/dqb.org b/docs/dqb.org index e886980..ae4d66d 100644 --- a/docs/dqb.org +++ b/docs/dqb.org @@ -52,8 +52,11 @@ support ~AndAlso~ statements. You can see the object structure [[https://github. *** Filter Value Conversion Since DQB always boxes your data into an ~object~ the actual type conversion is -being handled by DQB while transforming your filters into a LINQ expression. DQB -also can handle ~null~ values as well. +being handled by DQB while transforming your filters into a LINQ expression. + +DQB also can handle ~null~ values as well. DQB can handle both filtering by sql +~null~ keyword and and "null" string value. In order to select between these +choices IsNullValueString property of DynamicQueryOptions. ** Supported Filters #+BEGIN_SRC csharp @@ -112,6 +115,26 @@ var dqbOpts = new DynamicQueryOptions // LINQ Translation: myCollection.Where(x => x.foo.Any(y => y.bar == "some_value")); #+END_SRC +An example usage of ~Filter~ using ~null~ as string: + +#+BEGIN_SRC csharp +var dqbOpts = new DynamicQueryOptions +{ + Filters = new List() + { + new Filter + { + Value = "null", + PropertyName = "name", + Operator = FilterOperation.Equals + } + }, + IsNullValueString = true +}; + +// LINQ Translation: myCollection.Where(x => x.name == "null"); +#+END_SRC + * Sorting Sorting is extremely easy with DQB. DQB currently does not support for custom