Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -186,10 +212,27 @@ public void FiltersShouldWork()
}
}).ToList();

var resultOfNameNullAsString = queryable.ApplyFilters(new DynamicQueryOptions
{
Filters = new List<Filter>
{
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")]
Expand All @@ -200,7 +243,7 @@ public void PaginationShouldWork()
PaginationOption = new PaginationOption
{
Count = 1,
Offset = 2
Offset = 3
},
UsesCaseInsensitiveSource = true,
IgnorePredefinedOrders = true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
Expand Down
1 change: 1 addition & 0 deletions DynamicQueryBuilder/DynamicQueryAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
8 changes: 5 additions & 3 deletions DynamicQueryBuilder/ExpressionBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ public static IQueryable ApplyFilters(this IQueryable currentSet, DynamicQueryOp
List<Filter> 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
Expand Down Expand Up @@ -431,7 +431,7 @@ internal static void PopulateDynamicQueryOptions(
/// <param name="filter">Filter instance to build.</param>
/// <param name="usesCaseInsensitiveSource">Flag to detect if the query is going to run on a SQL database.</param>
/// <returns>Built query expression.</returns>
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");
Expand Down Expand Up @@ -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);
Expand Down
6 changes: 6 additions & 0 deletions DynamicQueryBuilder/Models/DynamicQueryBuilderSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ public class DynamicQueryBuilderSettings
/// </summary>
public bool IgnorePredefinedOrders { get; set; }

/// <summary>
/// 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.
/// </summary>
public bool IsNullValueString { get; set; } = false;

/// <summary>
/// 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.
Expand Down
2 changes: 2 additions & 0 deletions DynamicQueryBuilder/Models/DynamicQueryOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ public sealed class DynamicQueryOptions

public bool UsesCaseInsensitiveSource { get; set; }

public bool IsNullValueString { get; set; }

public bool IgnorePredefinedOrders { get; set; }
}
}
27 changes: 25 additions & 2 deletions docs/dqb.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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<Filter>()
{
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
Expand Down