Compare commits

..

No commits in common. "master" and "v2.5.4" have entirely different histories.

8 changed files with 29 additions and 126 deletions

View File

@ -129,8 +129,7 @@ Then you can add the configuration:
"DefaultPageSize": "int number: optional number to fallback to when no page argument is given. Set <=0 to disable paging if no pageSize is specified (default).", "DefaultPageSize": "int number: optional number to fallback to when no page argument is given. Set <=0 to disable paging if no pageSize is specified (default).",
"MaxPageSize": "int number: maximum allowed page size. Set <=0 to make infinite (default)", "MaxPageSize": "int number: maximum allowed page size. Set <=0 to make infinite (default)",
"ThrowExceptions": "boolean: should Sieve throw exceptions instead of silently failing? Defaults to false", "ThrowExceptions": "boolean: should Sieve throw exceptions instead of silently failing? Defaults to false",
"IgnoreNullsOnNotEqual": "boolean: ignore null values when filtering using is not equal operator? Defaults to true", "IgnoreNullsOnNotEqual": "boolean: ignore null values when filtering using is not equal operator? Default to true"
"DisableNullableTypeExpressionForSorting": "boolean: disable the creation of nullable type expression for sorting. Some databases do not handle it (yet). Defaults to false"
} }
} }
``` ```
@ -208,13 +207,10 @@ You can replace this DSL with your own (eg. use JSON instead) by implementing an
| `<=` | Less than or equal to | | `<=` | Less than or equal to |
| `@=` | Contains | | `@=` | Contains |
| `_=` | Starts with | | `_=` | Starts with |
| `_-=` | Ends with |
| `!@=` | Does not Contains | | `!@=` | Does not Contains |
| `!_=` | Does not Starts with | | `!_=` | Does not Starts with |
| `!_-=` | Does not Ends with |
| `@=*` | Case-insensitive string Contains | | `@=*` | Case-insensitive string Contains |
| `_=*` | Case-insensitive string Starts with | | `_=*` | Case-insensitive string Starts with |
| `_-=*` | Case-insensitive string Ends with |
| `==*` | Case-insensitive string Equals | | `==*` | Case-insensitive string Equals |
| `!=*` | Case-insensitive string Not equals | | `!=*` | Case-insensitive string Not equals |
| `!@=*` | Case-insensitive string does not Contains | | `!@=*` | Case-insensitive string does not Contains |
@ -235,7 +231,7 @@ It is recommended that you write exception-handling middleware to globally handl
You can find an example project incorporating most Sieve concepts in [SieveTests](https://github.com/Biarity/Sieve/tree/master/SieveTests). You can find an example project incorporating most Sieve concepts in [SieveTests](https://github.com/Biarity/Sieve/tree/master/SieveTests).
## Fluent API ## Fluent API
To use the Fluent API instead of attributes in marking properties, setup an alternative `SieveProcessor` that overrides `MapProperties`. For [example](https://github.com/Biarity/Sieve/blob/master/Sieve.Sample/Services/ApplicationSieveProcessor.cs): To use the Fluent API instead of attributes in marking properties, setup an alternative `SieveProcessor` that overrides `MapProperties`. For example:
```C# ```C#
public class ApplicationSieveProcessor : SieveProcessor public class ApplicationSieveProcessor : SieveProcessor
@ -282,7 +278,7 @@ To enable functional grouping of mappings the `ISieveConfiguration` interface wa
```C# ```C#
public class SieveConfigurationForPost : ISieveConfiguration public class SieveConfigurationForPost : ISieveConfiguration
{ {
public void Configure(SievePropertyMapper mapper) protected override SievePropertyMapper Configure(SievePropertyMapper mapper)
{ {
mapper.Property<Post>(p => p.Title) mapper.Property<Post>(p => p.Title)
.CanFilter() .CanFilter()
@ -334,7 +330,7 @@ public class ApplicationSieveProcessor : SieveProcessor
protected override SievePropertyMapper MapProperties(SievePropertyMapper mapper) protected override SievePropertyMapper MapProperties(SievePropertyMapper mapper)
{ {
return mapper.ApplyConfigurationsFromAssembly(typeof(ApplicationSieveProcessor).Assembly); return mapper.ApplyConfigurationForAssembly(typeof(ApplicationSieveProcessor).Assembly);
} }
} }
``` ```

View File

@ -12,10 +12,9 @@ namespace Sieve.Extensions
string fullPropertyName, string fullPropertyName,
PropertyInfo propertyInfo, PropertyInfo propertyInfo,
bool desc, bool desc,
bool useThenBy, bool useThenBy)
bool disableNullableTypeExpression = false)
{ {
var lambda = GenerateLambdaWithSafeMemberAccess<TEntity>(fullPropertyName, propertyInfo, disableNullableTypeExpression); var lambda = GenerateLambdaWithSafeMemberAccess<TEntity>(fullPropertyName, propertyInfo);
var command = desc var command = desc
? (useThenBy ? "ThenByDescending" : "OrderByDescending") ? (useThenBy ? "ThenByDescending" : "OrderByDescending")
@ -34,8 +33,7 @@ namespace Sieve.Extensions
private static Expression<Func<TEntity, object>> GenerateLambdaWithSafeMemberAccess<TEntity> private static Expression<Func<TEntity, object>> GenerateLambdaWithSafeMemberAccess<TEntity>
( (
string fullPropertyName, string fullPropertyName,
PropertyInfo propertyInfo, PropertyInfo propertyInfo
bool disableNullableTypeExpression
) )
{ {
var parameter = Expression.Parameter(typeof(TEntity), "e"); var parameter = Expression.Parameter(typeof(TEntity), "e");
@ -54,7 +52,7 @@ namespace Sieve.Extensions
propertyValue = Expression.MakeMemberAccess(propertyValue, propertyInfo); propertyValue = Expression.MakeMemberAccess(propertyValue, propertyInfo);
} }
if (propertyValue.Type.IsNullable() && !disableNullableTypeExpression) if (propertyValue.Type.IsNullable())
{ {
nullCheck = GenerateOrderNullCheckExpression(propertyValue, nullCheck); nullCheck = GenerateOrderNullCheckExpression(propertyValue, nullCheck);
} }

View File

@ -10,6 +10,5 @@
LessThanOrEqualTo, LessThanOrEqualTo,
Contains, Contains,
StartsWith, StartsWith,
EndsWith,
} }
} }

View File

@ -8,7 +8,7 @@ namespace Sieve.Models
public class FilterTerm : IFilterTerm, IEquatable<FilterTerm> public class FilterTerm : IFilterTerm, IEquatable<FilterTerm>
{ {
private const string EscapedPipePattern = @"(?<!($|[^\\]|^)(\\\\)*?\\)\|"; private const string EscapedPipePattern = @"(?<!($|[^\\]|^)(\\\\)*?\\)\|";
private const string OperatorsRegEx = @"(!@=\*|!_=\*|!_-=\*|!=\*|!@=|!_=|!_-=|==\*|@=\*|_=\*|_-=\*|==|!=|>=|<=|>|<|@=|_=|_-=)"; private const string OperatorsRegEx = @"(!@=\*|!_=\*|!=\*|!@=|!_=|==\*|@=\*|_=\*|==|!=|>=|<=|>|<|@=|_=)";
private const string EscapeNegPatternForOper = @"(?<!\\)" + OperatorsRegEx; private const string EscapeNegPatternForOper = @"(?<!\\)" + OperatorsRegEx;
private const string EscapePosPatternForOper = @"(?<=\\)" + OperatorsRegEx; private const string EscapePosPatternForOper = @"(?<=\\)" + OperatorsRegEx;
@ -22,13 +22,13 @@ namespace Sieve.Models
{ {
set set
{ {
var filterSplits = Regex.Split(value, EscapeNegPatternForOper).Select(t => t.Trim()).ToArray(); var filterSplits = Regex.Split(value,EscapeNegPatternForOper).Select(t => t.Trim()).ToArray();
Names = Regex.Split(filterSplits[0], EscapedPipePattern).Select(t => t.Trim()).ToArray(); Names = Regex.Split(filterSplits[0], EscapedPipePattern).Select(t => t.Trim()).ToArray();
if (filterSplits.Length > 2) if (filterSplits.Length > 2)
{ {
foreach (var match in Regex.Matches(filterSplits[2], EscapePosPatternForOper)) foreach (var match in Regex.Matches(filterSplits[2],EscapePosPatternForOper))
{ {
var matchStr = match.ToString(); var matchStr = match.ToString();
filterSplits[2] = filterSplits[2].Replace('\\' + matchStr, matchStr); filterSplits[2] = filterSplits[2].Replace('\\' + matchStr, matchStr);
@ -38,8 +38,8 @@ namespace Sieve.Models
.Select(UnEscape) .Select(UnEscape)
.ToArray(); .ToArray();
} }
Operator = Regex.Match(value, EscapeNegPatternForOper).Value; Operator = Regex.Match(value,EscapeNegPatternForOper).Value;
OperatorParsed = GetOperatorParsed(Operator); OperatorParsed = GetOperatorParsed(Operator);
OperatorIsCaseInsensitive = Operator.EndsWith("*"); OperatorIsCaseInsensitive = Operator.EndsWith("*");
OperatorIsNegated = OperatorParsed != FilterOperator.NotEquals && Operator.StartsWith("!"); OperatorIsNegated = OperatorParsed != FilterOperator.NotEquals && Operator.StartsWith("!");
@ -80,9 +80,6 @@ namespace Sieve.Models
case "_=": case "_=":
case "!_=": case "!_=":
return FilterOperator.StartsWith; return FilterOperator.StartsWith;
case "_-=":
case "!_-=":
return FilterOperator.EndsWith;
default: default:
return FilterOperator.Equals; return FilterOperator.Equals;
} }

View File

@ -11,7 +11,5 @@
public bool ThrowExceptions { get; set; } = false; public bool ThrowExceptions { get; set; } = false;
public bool IgnoreNullsOnNotEqual { get; set; } = true; public bool IgnoreNullsOnNotEqual { get; set; } = true;
public bool DisableNullableTypeExpressionForSorting { get; set; } = false;
} }
} }

View File

@ -339,9 +339,6 @@ namespace Sieve.Services
FilterOperator.StartsWith => Expression.Call(propertyValue, FilterOperator.StartsWith => Expression.Call(propertyValue,
typeof(string).GetMethods().First(m => m.Name == "StartsWith" && m.GetParameters().Length == 1), typeof(string).GetMethods().First(m => m.Name == "StartsWith" && m.GetParameters().Length == 1),
filterValue), filterValue),
FilterOperator.EndsWith => Expression.Call(propertyValue,
typeof(string).GetMethods().First(m => m.Name == "EndsWith" && m.GetParameters().Length == 1),
filterValue),
_ => Expression.Equal(propertyValue, filterValue) _ => Expression.Equal(propertyValue, filterValue)
}; };
} }
@ -368,7 +365,7 @@ namespace Sieve.Services
if (property != null) if (property != null)
{ {
result = result.OrderByDynamic(fullName, property, sortTerm.Descending, useThenBy, Options.Value.DisableNullableTypeExpressionForSorting); result = result.OrderByDynamic(fullName, property, sortTerm.Descending, useThenBy);
} }
else else
{ {

View File

@ -73,16 +73,6 @@ namespace SieveUnitTests
CategoryId = 2, CategoryId = 2,
TopComment = new Comment { Id = 1, Text = "D1" }, TopComment = new Comment { Id = 1, Text = "D1" },
FeaturedComment = new Comment { Id = 7, Text = "D2" } FeaturedComment = new Comment { Id = 7, Text = "D2" }
},
new Post
{
Id = 4,
Title = "Yen",
LikeCount = 5,
IsDraft = true,
CategoryId = 5,
TopComment = new Comment { Id = 4, Text = "Yen3" },
FeaturedComment = new Comment { Id = 8, Text = "Yen4" }
} }
}.AsQueryable(); }.AsQueryable();
@ -134,43 +124,7 @@ namespace SieveUnitTests
var result = _processor.Apply(model, _posts); var result = _processor.Apply(model, _posts);
Assert.Equal(1, result.First().Id); Assert.Equal(1, result.First().Id);
Assert.True(result.Count() == 4); Assert.True(result.Count() == 3);
}
[Fact]
public void EndsWithWorks()
{
var model = new SieveModel
{
Filters = "Title_-=n"
};
_testOutputHelper.WriteLine(model.GetFiltersParsed()[0].Values.ToString());
_testOutputHelper.WriteLine(model.GetFiltersParsed()[0].Operator);
_testOutputHelper.WriteLine(model.GetFiltersParsed()[0].OperatorParsed.ToString());
var result = _processor.Apply(model, _posts);
Assert.Equal(4, result.First().Id);
Assert.True(result.Count() == 1);
}
[Fact]
public void EndsWithCanBeCaseInsensitive()
{
var model = new SieveModel
{
Filters = "Title_-=*N"
};
_testOutputHelper.WriteLine(model.GetFiltersParsed()[0].Values.ToString());
_testOutputHelper.WriteLine(model.GetFiltersParsed()[0].Operator);
_testOutputHelper.WriteLine(model.GetFiltersParsed()[0].OperatorParsed.ToString());
var result = _processor.Apply(model, _posts);
Assert.Equal(4, result.First().Id);
Assert.True(result.Count() == 1);
} }
[Fact] [Fact]
@ -196,7 +150,7 @@ namespace SieveUnitTests
var result = _processor.Apply(model, _posts); var result = _processor.Apply(model, _posts);
Assert.True(result.Count() == 4); Assert.True(result.Count() == 3);
} }
[Fact] [Fact]
@ -251,8 +205,8 @@ namespace SieveUnitTests
var result = _processor.Apply(model, _posts); var result = _processor.Apply(model, _posts);
var nullableResult = _nullableProcessor.Apply(model, _posts); var nullableResult = _nullableProcessor.Apply(model, _posts);
Assert.True(result.Count() == 2); Assert.True(result.Count() == 1);
Assert.True(nullableResult.Count() == 3); Assert.True(nullableResult.Count() == 2);
} }
[Theory] [Theory]
@ -301,7 +255,7 @@ namespace SieveUnitTests
var result = _processor.Apply(model, _posts); var result = _processor.Apply(model, _posts);
Assert.False(result.Any(p => p.Id == 0)); Assert.False(result.Any(p => p.Id == 0));
Assert.True(result.Count() == 4); Assert.True(result.Count() == 3);
} }
[Fact] [Fact]
@ -520,12 +474,11 @@ namespace SieveUnitTests
}; };
var result = _processor.Apply(model, _posts); var result = _processor.Apply(model, _posts);
Assert.Equal(4, result.Count()); Assert.Equal(3, result.Count());
var posts = result.ToList(); var posts = result.ToList();
Assert.Contains("B", posts[0].TopComment.Text); Assert.Contains("B", posts[0].TopComment.Text);
Assert.Contains("C", posts[1].TopComment.Text); Assert.Contains("C", posts[1].TopComment.Text);
Assert.Contains("D", posts[2].TopComment.Text); Assert.Contains("D", posts[2].TopComment.Text);
Assert.Contains("Yen", posts[3].TopComment.Text);
} }
[Fact] [Fact]
@ -537,13 +490,12 @@ namespace SieveUnitTests
}; };
var result = _processor.Apply(model, _posts); var result = _processor.Apply(model, _posts);
Assert.Equal(5, result.Count()); Assert.Equal(4, result.Count());
var posts = result.ToList(); var posts = result.ToList();
Assert.Equal(0, posts[0].Id); Assert.Equal(0, posts[0].Id);
Assert.Equal(3, posts[1].Id); Assert.Equal(3, posts[1].Id);
Assert.Equal(2, posts[2].Id); Assert.Equal(2, posts[2].Id);
Assert.Equal(1, posts[3].Id); Assert.Equal(1, posts[3].Id);
Assert.Equal(4, posts[4].Id);
} }
[Fact] [Fact]
@ -678,15 +630,13 @@ namespace SieveUnitTests
}; };
var result = _processor.Apply(model, _posts); var result = _processor.Apply(model, _posts);
Assert.Equal(5, result.Count()); Assert.Equal(4, result.Count());
var posts = result.ToList(); var posts = result.ToList();
Assert.Equal(4, posts[0].Id); Assert.Equal(3,posts[0].Id);
Assert.Equal(3,posts[1].Id); Assert.Equal(2,posts[1].Id);
Assert.Equal(2,posts[2].Id); Assert.Equal(1,posts[2].Id);
Assert.Equal(1,posts[3].Id); Assert.Equal(0,posts[3].Id);
Assert.Equal(0,posts[4].Id);
} }
[Fact] [Fact]
@ -809,13 +759,10 @@ namespace SieveUnitTests
[InlineData(@"Title@=\>= ")] [InlineData(@"Title@=\>= ")]
[InlineData(@"Title@=\@= ")] [InlineData(@"Title@=\@= ")]
[InlineData(@"Title@=\_= ")] [InlineData(@"Title@=\_= ")]
[InlineData(@"Title@=\_-= ")]
[InlineData(@"Title@=!\@= ")] [InlineData(@"Title@=!\@= ")]
[InlineData(@"Title@=!\_= ")] [InlineData(@"Title@=!\_= ")]
[InlineData(@"Title@=!\_-= ")]
[InlineData(@"Title@=\@=* ")] [InlineData(@"Title@=\@=* ")]
[InlineData(@"Title@=\_=* ")] [InlineData(@"Title@=\_=* ")]
[InlineData(@"Title@=\_-=* ")]
[InlineData(@"Title@=\==* ")] [InlineData(@"Title@=\==* ")]
[InlineData(@"Title@=\!=* ")] [InlineData(@"Title@=\!=* ")]
[InlineData(@"Title@=!\@=* ")] [InlineData(@"Title@=!\@=* ")]
@ -826,7 +773,7 @@ namespace SieveUnitTests
new Post new Post
{ {
Id = 1, Id = 1,
Title = @"Operators: == != > < >= <= @= _= _-= !@= !_= !_-= @=* _=* ==* !=* !@=* !_=* !_-=* ", Title = @"Operators: == != > < >= <= @= _= !@= !_= @=* _=* ==* !=* !@=* !_=* ",
LikeCount = 1, LikeCount = 1,
IsDraft = true, IsDraft = true,
CategoryId = 1, CategoryId = 1,

View File

@ -31,7 +31,7 @@ namespace SieveUnitTests
{ {
Id = 1, Id = 1,
DateCreated = DateTimeOffset.UtcNow, DateCreated = DateTimeOffset.UtcNow,
Text = "null is here twice in the text ending by null", Text = "null is here in the text",
Author = "Cat", Author = "Cat",
}, },
new Comment new Comment
@ -136,21 +136,6 @@ namespace SieveUnitTests
Assert.Equal(new[] {1}, result.Select(p => p.Id)); Assert.Equal(new[] {1}, result.Select(p => p.Id));
} }
[Theory]
[InlineData("Text_-=null")]
[InlineData("Text_-=*null")]
[InlineData("Text_-=*NULL")]
[InlineData("Text_-=*NulL")]
[InlineData("Text_-=*null|text")]
public void Filter_EndsWith_NullString(string filter)
{
var model = new SieveModel { Filters = filter };
var result = _processor.Apply(model, _comments);
Assert.Equal(new[] { 1 }, result.Select(p => p.Id));
}
[Theory] [Theory]
[InlineData("Text!@=null")] [InlineData("Text!@=null")]
[InlineData("Text!@=*null")] [InlineData("Text!@=*null")]
@ -179,19 +164,5 @@ namespace SieveUnitTests
Assert.Equal(new[] {0, 2}, result.Select(p => p.Id)); Assert.Equal(new[] {0, 2}, result.Select(p => p.Id));
} }
[Theory]
[InlineData("Text!_-=null")]
[InlineData("Text!_-=*null")]
[InlineData("Text!_-=*NULL")]
[InlineData("Text!_-=*NulL")]
public void Filter_DoesNotEndsWith_NullString(string filter)
{
var model = new SieveModel { Filters = filter };
var result = _processor.Apply(model, _comments);
Assert.Equal(new[] { 0, 2 }, result.Select(p => p.Id));
}
} }
} }