15 Commits

Author SHA1 Message Date
ITDancer13
aedbc1ed96 Fix broken paging (#136)
* Add unit tests
* Use calculated page size instead of page

Co-authored-by: ITDancer139 <kevinitdancersommer@gmail.com>
2021-05-16 16:34:36 +02:00
ITDancer13
2c9d907764 * Throw exceptions by default (#133)
* Doc strings for SieveOptions.cs
* Simplify MaxPageSize calculation

Co-authored-by: ITDancer139 <kevinitdancersommer@gmail.com>
2021-05-15 18:06:40 +02:00
Keivn Sommer
8bd9ce85d9 Fix nuget target path 2021-05-14 23:35:47 +02:00
Keivn Sommer
f738e3bf1e Use NUGET_API_KEY to publish first pre-release 2021-05-14 23:33:05 +02:00
Keivn Sommer
dd1b0a9edc Disable publish for master - should be activated as soon as it's merged back for the first time. 2021-05-14 23:28:18 +02:00
Keivn Sommer
27838b062c Set mode to 'ContinuousDeployment' to get unique NuGetPreReleaseTagV2 on releases/* 2021-05-14 23:28:18 +02:00
Keivn Sommer
38af9af982 Publish requires to be executed on server 2021-05-14 23:27:57 +02:00
Kevin Sommer
d188bed4f0 Setup NuGet push (without api key) 2021-05-14 23:27:57 +02:00
Kevin Sommer
1e29271fd9 Check if NUGET_API_KEY can be accessed 2021-05-14 23:27:57 +02:00
Kevin Sommer
034730bffb Use ci.yml for PRs only 2021-05-14 23:27:57 +02:00
Kevin Sommer
79c825cb7a Prepare publish on releases/* and master 2021-05-14 23:27:57 +02:00
Kevin Sommer
028ab1d196 Build an PRs to releases/* 2021-05-14 23:27:57 +02:00
ITDancer139
9277690e96 Replace features by releases 2021-05-14 23:27:57 +02:00
ITDancer139
d5474478b3 Update pipeline to build on feature branches 2021-05-14 23:27:57 +02:00
ITDancer139
4c5510772a build on feature branches 2021-05-14 23:27:57 +02:00
14 changed files with 114 additions and 346 deletions

View File

@@ -1,38 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Additional context**
Add any other context about the problem here.

View File

@@ -1,5 +0,0 @@
blank_issues_enabled: false
contact_links:
- name: Feature Request
url: https://github.com/biarity/sieve/discussions/new
about: Share your ideas on how to make Sieve better.

View File

@@ -20,8 +20,6 @@ on:
push: push:
branches: branches:
- 'releases/*' - 'releases/*'
tags:
- 'v*'
jobs: jobs:
ubuntu-latest: ubuntu-latest:

View File

@@ -2,8 +2,7 @@
⚗️ Sieve is a simple, clean, and extensible framework for .NET Core that **adds sorting, filtering, and pagination functionality out of the box**. ⚗️ Sieve is a simple, clean, and extensible framework for .NET Core that **adds sorting, filtering, and pagination functionality out of the box**.
Most common use case would be for serving ASP.NET Core GET queries. Most common use case would be for serving ASP.NET Core GET queries.
[![NuGet Release](https://img.shields.io/nuget/v/Sieve?style=for-the-badge)](https://www.nuget.org/packages/Sieve) [![NuGet Release](https://img.shields.io/nuget/v/Sieve.svg?style=flat-square)](https://www.nuget.org/packages/Sieve)
[![NuGet Pre-Release](https://img.shields.io/nuget/vpre/Sieve?style=for-the-badge)](https://www.nuget.org/packages/Sieve)
[Get Sieve on nuget](https://www.nuget.org/packages/Sieve/) [Get Sieve on nuget](https://www.nuget.org/packages/Sieve/)
@@ -75,7 +74,7 @@ Where `SieveCustomSortMethodsOfPosts` for example is:
```C# ```C#
public class SieveCustomSortMethods : ISieveCustomSortMethods public class SieveCustomSortMethods : ISieveCustomSortMethods
{ {
public IQueryable<Post> Popularity(IQueryable<Post> source, bool useThenBy, bool desc) // The method is given an indicator of whether to use ThenBy(), and if the query is descending public IQueryable<Post> Popularity(IQueryable<Post> source, bool useThenBy, bool desc) // The method is given an indicator of weather to use ThenBy(), and if the query is descending
{ {
var result = useThenBy ? var result = useThenBy ?
((IOrderedQueryable<Post>)source).ThenBy(p => p.LikeCount) : // ThenBy only works on IOrderedQueryable<TEntity> ((IOrderedQueryable<Post>)source).ThenBy(p => p.LikeCount) : // ThenBy only works on IOrderedQueryable<TEntity>
@@ -128,8 +127,7 @@ Then you can add the configuration:
"CaseSensitive": "boolean: should property names be case-sensitive? Defaults to false", "CaseSensitive": "boolean: should property names be case-sensitive? Defaults to false",
"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? Default to true"
} }
} }
``` ```
@@ -159,10 +157,7 @@ More formally:
* `pageSize` is the number of items returned per page * `pageSize` is the number of items returned per page
Notes: Notes:
* You can use backslashes to escape special characters and sequences: * You can use backslashes to escape commas and pipes within value fields
* commas: `Title@=some\,title` makes a match with "some,title"
* pipes: `Title@=some\|title` makes a match with "some|title"
* null values: `Title@=\null` will search for items with title equal to "null" (not a missing value, but "null"-string literally)
* You can have spaces anywhere except *within* `{Name}` or `{Operator}` fields * You can have spaces anywhere except *within* `{Name}` or `{Operator}` fields
* If you need to look at the data before applying pagination (eg. get total count), use the optional paramters on `Apply` to defer pagination (an [example](https://github.com/Biarity/Sieve/issues/34)) * If you need to look at the data before applying pagination (eg. get total count), use the optional paramters on `Apply` to defer pagination (an [example](https://github.com/Biarity/Sieve/issues/34))
* Here's a [good example on how to work with enumerables](https://github.com/Biarity/Sieve/issues/2) * Here's a [good example on how to work with enumerables](https://github.com/Biarity/Sieve/issues/2)

View File

@@ -1,5 +1,6 @@
{ {
"Logging": { "Logging": {
"IncludeScopes": false,
"LogLevel": { "LogLevel": {
"Default": "Debug", "Default": "Debug",
"System": "Information", "System": "Information",

View File

@@ -4,10 +4,10 @@
}, },
"Sieve": { "Sieve": {
"CaseSensitive": false, "CaseSensitive": false,
"DefaultPageSize": 10, "DefaultPageSize": 10
"IgnoreNullsOnNotEqual": true
}, },
"Logging": { "Logging": {
"IncludeScopes": false,
"Debug": { "Debug": {
"LogLevel": { "LogLevel": {
"Default": "Warning" "Default": "Warning"

View File

@@ -1,5 +1,4 @@
using System; using System;
using System.Collections.Generic;
using System.Linq; using System.Linq;
using System.Text.RegularExpressions; using System.Text.RegularExpressions;
@@ -7,48 +6,44 @@ namespace Sieve.Models
{ {
public class FilterTerm : IFilterTerm, IEquatable<FilterTerm> public class FilterTerm : IFilterTerm, IEquatable<FilterTerm>
{ {
private const string EscapedPipePattern = @"(?<!($|[^\\]|^)(\\\\)*?\\)\|"; public FilterTerm() { }
private const string OperatorsRegEx = @"(!@=\*|!_=\*|!=\*|!@=|!_=|==\*|@=\*|_=\*|==|!=|>=|<=|>|<|@=|_=)";
private const string EscapeNegPatternForOper = @"(?<!\\)" + OperatorsRegEx;
private const string EscapePosPatternForOper = @"(?<=\\)" + OperatorsRegEx;
private static readonly HashSet<string> _escapedSequences = new HashSet<string> private const string EscapedPipePattern = @"(?<!($|[^\\])(\\\\)*?\\)\|";
{
@"\|", private static readonly string[] Operators = new string[] {
@"\\" "!@=*",
"!_=*",
"!=*",
"!@=",
"!_=",
"==*",
"@=*",
"_=*",
"==",
"!=",
">=",
"<=",
">",
"<",
"@=",
"_="
}; };
public string Filter public string Filter
{ {
set set
{ {
var filterSplits = Regex.Split(value,EscapeNegPatternForOper).Select(t => t.Trim()).ToArray(); var filterSplits = value.Split(Operators, StringSplitOptions.RemoveEmptyEntries)
.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();
Values = filterSplits.Length > 1 ? Regex.Split(filterSplits[1], EscapedPipePattern).Select(t => t.Trim()).ToArray() : null;
if (filterSplits.Length > 2) Operator = Array.Find(Operators, o => value.Contains(o)) ?? "==";
{
foreach (var match in Regex.Matches(filterSplits[2],EscapePosPatternForOper))
{
var matchStr = match.ToString();
filterSplits[2] = filterSplits[2].Replace('\\' + matchStr, matchStr);
}
Values = Regex.Split(filterSplits[2], EscapedPipePattern)
.Select(UnEscape)
.ToArray();
}
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("!");
} }
}
private string UnEscape(string escapedTerm) }
=> _escapedSequences.Aggregate(escapedTerm,
(current, sequence) => Regex.Replace(current, $@"(\\)({sequence})", "$2"));
public string[] Names { get; private set; } public string[] Names { get; private set; }
@@ -95,5 +90,6 @@ namespace Sieve.Models
&& Values.SequenceEqual(other.Values) && Values.SequenceEqual(other.Values)
&& Operator == other.Operator; && Operator == other.Operator;
} }
} }
} }

View File

@@ -1,4 +1,4 @@
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations;
using System.Linq; using System.Linq;

View File

@@ -2,14 +2,27 @@
{ {
public class SieveOptions public class SieveOptions
{ {
/// <summary>
/// If flag is set, property names have to match including case sensitivity.
/// </summary>
public bool CaseSensitive { get; set; } = false; public bool CaseSensitive { get; set; } = false;
/// <summary>
/// Fallback value of no page size is specified in the request.
/// </summary>
/// <remarks>Values less or equal to 0 disable paging.</remarks>
public int DefaultPageSize { get; set; } = 0; public int DefaultPageSize { get; set; } = 0;
/// <summary>
/// Specifies the upper limit of a page size to be requested.
/// </summary>
/// <remarks>Values less or equal to 0 are ignored.</remarks>
public int MaxPageSize { get; set; } = 0; public int MaxPageSize { get; set; } = 0;
public bool ThrowExceptions { get; set; } = false; /// <summary>
/// If flag is set, Sieve throws exception otherwise exceptions are caught and the already processed
public bool IgnoreNullsOnNotEqual { get; set; } = true; /// result is returned.
/// </summary>
public bool ThrowExceptions { get; set; } = true;
} }
} }

View File

@@ -68,7 +68,7 @@ namespace Sieve.Services
where TSortTerm : ISortTerm, new() where TSortTerm : ISortTerm, new()
{ {
private const string NullFilterValue = "null"; private const string NullFilterValue = "null";
private const char EscapeChar = '\\'; private readonly IOptions<SieveOptions> _options;
private readonly ISieveCustomSortMethods _customSortMethods; private readonly ISieveCustomSortMethods _customSortMethods;
private readonly ISieveCustomFilterMethods _customFilterMethods; private readonly ISieveCustomFilterMethods _customFilterMethods;
private readonly SievePropertyMapper _mapper = new SievePropertyMapper(); private readonly SievePropertyMapper _mapper = new SievePropertyMapper();
@@ -78,7 +78,7 @@ namespace Sieve.Services
ISieveCustomFilterMethods customFilterMethods) ISieveCustomFilterMethods customFilterMethods)
{ {
_mapper = MapProperties(_mapper); _mapper = MapProperties(_mapper);
Options = options; _options = options;
_customSortMethods = customSortMethods; _customSortMethods = customSortMethods;
_customFilterMethods = customFilterMethods; _customFilterMethods = customFilterMethods;
} }
@@ -87,7 +87,7 @@ namespace Sieve.Services
ISieveCustomSortMethods customSortMethods) ISieveCustomSortMethods customSortMethods)
{ {
_mapper = MapProperties(_mapper); _mapper = MapProperties(_mapper);
Options = options; _options = options;
_customSortMethods = customSortMethods; _customSortMethods = customSortMethods;
} }
@@ -95,18 +95,16 @@ namespace Sieve.Services
ISieveCustomFilterMethods customFilterMethods) ISieveCustomFilterMethods customFilterMethods)
{ {
_mapper = MapProperties(_mapper); _mapper = MapProperties(_mapper);
Options = options; _options = options;
_customFilterMethods = customFilterMethods; _customFilterMethods = customFilterMethods;
} }
public SieveProcessor(IOptions<SieveOptions> options) public SieveProcessor(IOptions<SieveOptions> options)
{ {
_mapper = MapProperties(_mapper); _mapper = MapProperties(_mapper);
Options = options; _options = options;
} }
protected IOptions<SieveOptions> Options { get; }
/// <summary> /// <summary>
/// Apply filtering, sorting, and pagination parameters found in `model` to `source` /// Apply filtering, sorting, and pagination parameters found in `model` to `source`
/// </summary> /// </summary>
@@ -150,7 +148,7 @@ namespace Sieve.Services
} }
catch (Exception ex) catch (Exception ex)
{ {
if (!Options.Value.ThrowExceptions) if (!_options.Value.ThrowExceptions)
{ {
return result; return result;
} }
@@ -164,7 +162,7 @@ namespace Sieve.Services
} }
} }
protected virtual IQueryable<TEntity> ApplyFiltering<TEntity>(TSieveModel model, IQueryable<TEntity> result, private IQueryable<TEntity> ApplyFiltering<TEntity>(TSieveModel model, IQueryable<TEntity> result,
object[] dataForCustomMethods = null) object[] dataForCustomMethods = null)
{ {
if (model?.GetFiltersParsed() == null) if (model?.GetFiltersParsed() == null)
@@ -200,7 +198,7 @@ namespace Sieve.Services
? Expression.Constant(null, property.PropertyType) ? Expression.Constant(null, property.PropertyType)
: ConvertStringValueToConstantExpression(filterTermValue, property, converter); : ConvertStringValueToConstantExpression(filterTermValue, property, converter);
if (filterTerm.OperatorIsCaseInsensitive && !isFilterTermValueNull) if (filterTerm.OperatorIsCaseInsensitive)
{ {
propertyValue = Expression.Call(propertyValue, propertyValue = Expression.Call(propertyValue,
typeof(string).GetMethods() typeof(string).GetMethods()
@@ -218,14 +216,11 @@ namespace Sieve.Services
expression = Expression.Not(expression); expression = Expression.Not(expression);
} }
if (expression.NodeType != ExpressionType.NotEqual || Options.Value.IgnoreNullsOnNotEqual)
{
var filterValueNullCheck = GetFilterValueNullCheck(parameter, fullPropertyName, isFilterTermValueNull); var filterValueNullCheck = GetFilterValueNullCheck(parameter, fullPropertyName, isFilterTermValueNull);
if (filterValueNullCheck != null) if (filterValueNullCheck != null)
{ {
expression = Expression.AndAlso(filterValueNullCheck, expression); expression = Expression.AndAlso(filterValueNullCheck, expression);
} }
}
innerExpression = innerExpression == null innerExpression = innerExpression == null
? expression ? expression
@@ -258,7 +253,8 @@ namespace Sieve.Services
: result.Where(Expression.Lambda<Func<TEntity, bool>>(outerExpression, parameter)); : result.Where(Expression.Lambda<Func<TEntity, bool>>(outerExpression, parameter));
} }
private static Expression GetFilterValueNullCheck(Expression parameter, string fullPropertyName, bool isFilterTermValueNull) private static Expression GetFilterValueNullCheck(Expression parameter, string fullPropertyName,
bool isFilterTermValueNull)
{ {
var (propertyValue, nullCheck) = GetPropertyValueAndNullCheckExpression(parameter, fullPropertyName); var (propertyValue, nullCheck) = GetPropertyValueAndNullCheckExpression(parameter, fullPropertyName);
@@ -312,10 +308,6 @@ namespace Sieve.Services
private static Expression ConvertStringValueToConstantExpression(string value, PropertyInfo property, private static Expression ConvertStringValueToConstantExpression(string value, PropertyInfo property,
TypeConverter converter) TypeConverter converter)
{ {
// to allow user to distinguish between prop==null (as null) and prop==\null (as "null"-string)
value = value.Equals(EscapeChar + NullFilterValue, StringComparison.InvariantCultureIgnoreCase)
? value.TrimStart(EscapeChar)
: value;
dynamic constantVal = converter.CanConvertFrom(typeof(string)) dynamic constantVal = converter.CanConvertFrom(typeof(string))
? converter.ConvertFrom(value) ? converter.ConvertFrom(value)
: Convert.ChangeType(value, property.PropertyType); : Convert.ChangeType(value, property.PropertyType);
@@ -344,13 +336,15 @@ namespace Sieve.Services
} }
// Workaround to ensure that the filter value gets passed as a parameter in generated SQL from EF Core // Workaround to ensure that the filter value gets passed as a parameter in generated SQL from EF Core
// See https://github.com/aspnet/EntityFrameworkCore/issues/3361
// Expression.Constant passed the target type to allow Nullable comparison
// See http://bradwilson.typepad.com/blog/2008/07/creating-nullab.html
private static Expression GetClosureOverConstant<T>(T constant, Type targetType) private static Expression GetClosureOverConstant<T>(T constant, Type targetType)
{ {
Expression<Func<T>> hoistedConstant = () => constant; return Expression.Constant(constant, targetType);
return Expression.Convert(hoistedConstant.Body, targetType);
} }
protected virtual IQueryable<TEntity> ApplySorting<TEntity>(TSieveModel model, IQueryable<TEntity> result, private IQueryable<TEntity> ApplySorting<TEntity>(TSieveModel model, IQueryable<TEntity> result,
object[] dataForCustomMethods = null) object[] dataForCustomMethods = null)
{ {
if (model?.GetSortsParsed() == null) if (model?.GetSortsParsed() == null)
@@ -379,11 +373,15 @@ namespace Sieve.Services
return result; return result;
} }
protected virtual IQueryable<TEntity> ApplyPagination<TEntity>(TSieveModel model, IQueryable<TEntity> result) private IQueryable<TEntity> ApplyPagination<TEntity>(TSieveModel model, IQueryable<TEntity> result)
{ {
var page = model?.Page ?? 1; var page = model?.Page ?? 1;
var pageSize = model?.PageSize ?? Options.Value.DefaultPageSize; var pageSize = model?.PageSize ?? _options.Value.DefaultPageSize;
var maxPageSize = Options.Value.MaxPageSize > 0 ? Options.Value.MaxPageSize : pageSize;
if (_options.Value.MaxPageSize > 0)
{
pageSize = Math.Min(pageSize, _options.Value.MaxPageSize);
}
if (pageSize <= 0) if (pageSize <= 0)
{ {
@@ -391,7 +389,7 @@ namespace Sieve.Services
} }
result = result.Skip((page - 1) * pageSize); result = result.Skip((page - 1) * pageSize);
result = result.Take(Math.Min(pageSize, maxPageSize)); result = result.Take(pageSize);
return result; return result;
} }
@@ -405,14 +403,14 @@ namespace Sieve.Services
string name) string name)
{ {
var property = _mapper.FindProperty<TEntity>(canSortRequired, canFilterRequired, name, var property = _mapper.FindProperty<TEntity>(canSortRequired, canFilterRequired, name,
Options.Value.CaseSensitive); _options.Value.CaseSensitive);
if (property.Item1 != null) if (property.Item1 != null)
{ {
return property; return property;
} }
var prop = FindPropertyBySieveAttribute<TEntity>(canSortRequired, canFilterRequired, name, var prop = FindPropertyBySieveAttribute<TEntity>(canSortRequired, canFilterRequired, name,
Options.Value.CaseSensitive); _options.Value.CaseSensitive);
return (prop?.Name, prop); return (prop?.Name, prop);
} }
@@ -432,7 +430,7 @@ namespace Sieve.Services
{ {
var customMethod = parent?.GetType() var customMethod = parent?.GetType()
.GetMethodExt(name, .GetMethodExt(name,
Options.Value.CaseSensitive _options.Value.CaseSensitive
? BindingFlags.Default ? BindingFlags.Default
: BindingFlags.IgnoreCase | BindingFlags.Public | BindingFlags.Instance, : BindingFlags.IgnoreCase | BindingFlags.Public | BindingFlags.Instance,
typeof(IQueryable<TEntity>)); typeof(IQueryable<TEntity>));
@@ -443,7 +441,7 @@ namespace Sieve.Services
// Find generic methods `public IQueryable<T> Filter<T>(IQueryable<T> source, ...)` // Find generic methods `public IQueryable<T> Filter<T>(IQueryable<T> source, ...)`
var genericCustomMethod = parent?.GetType() var genericCustomMethod = parent?.GetType()
.GetMethodExt(name, .GetMethodExt(name,
Options.Value.CaseSensitive _options.Value.CaseSensitive
? BindingFlags.Default ? BindingFlags.Default
: BindingFlags.IgnoreCase | BindingFlags.Public | BindingFlags.Instance, : BindingFlags.IgnoreCase | BindingFlags.Public | BindingFlags.Instance,
typeof(IQueryable<>)); typeof(IQueryable<>));
@@ -487,11 +485,11 @@ namespace Sieve.Services
var incompatibleCustomMethods = var incompatibleCustomMethods =
parent? parent?
.GetType() .GetType()
.GetMethods(Options.Value.CaseSensitive .GetMethods(_options.Value.CaseSensitive
? BindingFlags.Default ? BindingFlags.Default
: BindingFlags.IgnoreCase | BindingFlags.Public | BindingFlags.Instance) : BindingFlags.IgnoreCase | BindingFlags.Public | BindingFlags.Instance)
.Where(method => string.Equals(method.Name, name, .Where(method => string.Equals(method.Name, name,
Options.Value.CaseSensitive _options.Value.CaseSensitive
? StringComparison.InvariantCulture ? StringComparison.InvariantCulture
: StringComparison.InvariantCultureIgnoreCase)) : StringComparison.InvariantCultureIgnoreCase))
.ToList() .ToList()

View File

@@ -15,24 +15,16 @@ namespace SieveUnitTests
{ {
private readonly ITestOutputHelper _testOutputHelper; private readonly ITestOutputHelper _testOutputHelper;
private readonly SieveProcessor _processor; private readonly SieveProcessor _processor;
private readonly SieveProcessor _nullableProcessor;
private readonly IQueryable<Post> _posts; private readonly IQueryable<Post> _posts;
private readonly IQueryable<Comment> _comments; private readonly IQueryable<Comment> _comments;
public General(ITestOutputHelper testOutputHelper) public General(ITestOutputHelper testOutputHelper)
{ {
var nullableAccessor = new SieveOptionsAccessor();
nullableAccessor.Value.IgnoreNullsOnNotEqual = false;
_testOutputHelper = testOutputHelper; _testOutputHelper = testOutputHelper;
_processor = new ApplicationSieveProcessor(new SieveOptionsAccessor(), _processor = new ApplicationSieveProcessor(new SieveOptionsAccessor(),
new SieveCustomSortMethods(), new SieveCustomSortMethods(),
new SieveCustomFilterMethods()); new SieveCustomFilterMethods());
_nullableProcessor = new ApplicationSieveProcessor(nullableAccessor,
new SieveCustomSortMethods(),
new SieveCustomFilterMethods());
_posts = new List<Post> _posts = new List<Post>
{ {
new Post new Post
@@ -73,7 +65,7 @@ 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" }
} },
}.AsQueryable(); }.AsQueryable();
_comments = new List<Comment> _comments = new List<Comment>
@@ -188,25 +180,8 @@ namespace SieveUnitTests
}; };
var result = _processor.Apply(model, _posts); var result = _processor.Apply(model, _posts);
var nullableResult = _nullableProcessor.Apply(model, _posts);
Assert.True(result.Count() == 2); Assert.True(result.Count() == 2);
Assert.True(nullableResult.Count() == 2);
}
[Fact]
public void CanFilterNullableIntsWithNotEqual()
{
var model = new SieveModel()
{
Filters = "CategoryId!=1"
};
var result = _processor.Apply(model, _posts);
var nullableResult = _nullableProcessor.Apply(model, _posts);
Assert.True(result.Count() == 1);
Assert.True(nullableResult.Count() == 2);
} }
[Theory] [Theory]
@@ -639,161 +614,43 @@ namespace SieveUnitTests
Assert.Equal(0,posts[3].Id); Assert.Equal(0,posts[3].Id);
} }
[Fact]
public void CanFilter_WithEscapeCharacter()
{
var comments = new List<Comment>
{
new Comment
{
Id = 0,
DateCreated = DateTimeOffset.UtcNow,
Text = "Here is, a comment"
},
new Comment
{
Id = 1,
DateCreated = DateTimeOffset.UtcNow.AddDays(-1),
Text = "Here is, another comment"
},
}.AsQueryable();
var model = new SieveModel
{
Filters = "Text==Here is\\, another comment"
};
var result = _processor.Apply(model, comments);
Assert.Equal(1, result.Count());
}
[Fact]
public void OrEscapedPipeValueFilteringWorks()
{
var comments = new List<Comment>
{
new Comment
{
Id = 0,
DateCreated = DateTimeOffset.UtcNow,
Text = "Here is | a comment"
},
new Comment
{
Id = 1,
DateCreated = DateTimeOffset.UtcNow.AddDays(-1),
Text = "Here is | another comment"
},
new Comment
{
Id = 2,
DateCreated = DateTimeOffset.UtcNow.AddDays(-1),
Text = @"Here is \| another comment(1)"
}
}.AsQueryable();
var model = new SieveModel
{
Filters = @"Text==Here is \| a comment|Here is \| another comment|Here is \\\| another comment(1)",
};
var result = _processor.Apply(model, comments);
Assert.Equal(3, result.Count());
}
[Theory] [Theory]
[InlineData("CategoryId==1,(CategoryId|LikeCount)==50")] [InlineData(1)]
[InlineData("(CategoryId|LikeCount)==50,CategoryId==1")] [InlineData(2)]
public void CanFilterWithEscape(string filter) [InlineData(3)]
[InlineData(4)]
public void Paging_DifferentPages(int page)
{ {
var model = new SieveModel var model = new SieveModel
{ {
Filters = filter Page = page,
PageSize = 1,
}; };
var result = _processor.Apply(model, _posts); var result = _processor.Apply(model, _posts);
var entry = result.FirstOrDefault(); var posts = result.ToList();
var resultCount = result.Count();
Assert.NotNull(entry); Assert.Single(posts);
Assert.Equal(1, resultCount); var expectedId = page - 1;
Assert.Equal(expectedId, posts.First().Id);
} }
[Theory] [Theory]
[InlineData(@"Title@=\\")] [InlineData(1)]
public void CanFilterWithEscapedBackSlash(string filter) [InlineData(2)]
[InlineData(3)]
[InlineData(4)]
public void Paging_DifferentPageSizes(int pageSize)
{ {
var posts = new List<Post>
{
new Post
{
Id = 1,
Title = "E\\",
LikeCount = 4,
IsDraft = true,
CategoryId = 1,
TopComment = new Comment { Id = 1, Text = "E1" },
FeaturedComment = new Comment { Id = 7, Text = "E2" }
}
}.AsQueryable();
var model = new SieveModel var model = new SieveModel
{ {
Filters = filter Page = 1,
PageSize = pageSize,
}; };
var result = _processor.Apply(model, posts); var result = _processor.Apply(model, _posts);
var entry = result.FirstOrDefault();
var resultCount = result.Count();
Assert.NotNull(entry); Assert.Equal(pageSize, result.Count());
Assert.Equal(1, resultCount);
} }
[Theory]
[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@=!\@=* ")]
public void CanFilterWithEscapedOperators(string filter)
{
var posts = new List<Post>
{
new Post
{
Id = 1,
Title = @"Operators: == != > < >= <= @= _= !@= !_= @=* _=* ==* !=* !@=* !_=* ",
LikeCount = 1,
IsDraft = true,
CategoryId = 1,
TopComment = new Comment { Id = 1, Text = "F1" },
FeaturedComment = new Comment { Id = 7, Text = "F2" }
}
}.AsQueryable();
var model = new SieveModel
{
Filters = filter,
};
var result = _processor.Apply(model, posts);
var entry = result.FirstOrDefault();
var resultCount = result.Count();
Assert.NotNull(entry);
Assert.Equal(1, resultCount);
}
} }
} }

View File

@@ -16,24 +16,16 @@ namespace SieveUnitTests
{ {
private readonly ITestOutputHelper _testOutputHelper; private readonly ITestOutputHelper _testOutputHelper;
private readonly SieveProcessor _processor; private readonly SieveProcessor _processor;
private readonly SieveProcessor _nullableProcessor;
private readonly IQueryable<IPost> _posts; private readonly IQueryable<IPost> _posts;
private readonly IQueryable<Comment> _comments; private readonly IQueryable<Comment> _comments;
public GeneralWithInterfaces(ITestOutputHelper testOutputHelper) public GeneralWithInterfaces(ITestOutputHelper testOutputHelper)
{ {
var nullableAccessor = new SieveOptionsAccessor();
nullableAccessor.Value.IgnoreNullsOnNotEqual = false;
_testOutputHelper = testOutputHelper; _testOutputHelper = testOutputHelper;
_processor = new ApplicationSieveProcessor(new SieveOptionsAccessor(), _processor = new ApplicationSieveProcessor(new SieveOptionsAccessor(),
new SieveCustomSortMethods(), new SieveCustomSortMethods(),
new SieveCustomFilterMethods()); new SieveCustomFilterMethods());
_nullableProcessor = new ApplicationSieveProcessor(nullableAccessor,
new SieveCustomSortMethods(),
new SieveCustomFilterMethods());
_posts = new List<IPost> _posts = new List<IPost>
{ {
new Post new Post
@@ -189,25 +181,8 @@ namespace SieveUnitTests
}; };
var result = _processor.Apply(model, _posts); var result = _processor.Apply(model, _posts);
var nullableResult = _nullableProcessor.Apply(model, _posts);
Assert.True(result.Count() == 2); Assert.True(result.Count() == 2);
Assert.True(nullableResult.Count() == 2);
}
[Fact]
public void CanFilterNullableIntsWithNotEqual()
{
var model = new SieveModel()
{
Filters = "CategoryId!=1"
};
var result = _processor.Apply(model, _posts);
var nullableResult = _nullableProcessor.Apply(model, _posts);
Assert.True(result.Count() == 1);
Assert.True(nullableResult.Count() == 2);
} }
[Fact] [Fact]

View File

@@ -38,7 +38,7 @@ namespace SieveUnitTests
{ {
Id = 2, Id = 2,
DateCreated = DateTimeOffset.UtcNow, DateCreated = DateTimeOffset.UtcNow,
Text = "Regular comment without n*ll", Text = "Regular comment without n*ll.",
Author = "Mouse", Author = "Mouse",
}, },
new Comment new Comment
@@ -47,28 +47,24 @@ namespace SieveUnitTests
DateCreated = DateTimeOffset.UtcNow, DateCreated = DateTimeOffset.UtcNow,
Text = null, Text = null,
Author = "null", Author = "null",
} },
}.AsQueryable(); }.AsQueryable();
} }
[Theory] [Fact]
[InlineData("Text==null")] public void Filter_Equals_Null()
[InlineData("Text==*null")]
public void Filter_Equals_Null(string filter)
{ {
var model = new SieveModel {Filters = filter}; var model = new SieveModel {Filters = "Text==null"};
var result = _processor.Apply(model, _comments); var result = _processor.Apply(model, _comments);
Assert.Equal(100, result.Single().Id); Assert.Equal(100, result.Single().Id);
} }
[Theory] [Fact]
[InlineData("Text!=null")] public void Filter_NotEquals_Null()
[InlineData("Text!=*null")]
public void Filter_NotEquals_Null(string filter)
{ {
var model = new SieveModel {Filters = filter}; var model = new SieveModel {Filters = "Text!=null"};
var result = _processor.Apply(model, _comments); var result = _processor.Apply(model, _comments);
@@ -105,22 +101,6 @@ namespace SieveUnitTests
Assert.Equal(expectedIds, result.Select(p => p.Id)); Assert.Equal(expectedIds, result.Select(p => p.Id));
} }
[Theory]
[InlineData(@"Author==\null", 100)]
[InlineData(@"Author==*\null", 100)]
[InlineData(@"Author==*\NuLl", 100)]
[InlineData(@"Author!=*\null", 0, 1, 2)]
[InlineData(@"Author!=*\NulL", 0, 1, 2)]
[InlineData(@"Author!=\null", 0, 1, 2)]
public void SingleFilter_Equals_NullStringEscaped(string filter, params int[] expectedIds)
{
var model = new SieveModel {Filters = filter};
var result = _processor.Apply(model, _comments);
Assert.Equal(expectedIds, result.Select(p => p.Id));
}
[Theory] [Theory]
[InlineData("Text_=null")] [InlineData("Text_=null")]
[InlineData("Text_=*null")] [InlineData("Text_=*null")]

View File

@@ -21,8 +21,7 @@ using static Nuke.Common.Tools.DotNet.DotNetTasks;
InvokedTargets = new[] {nameof(Ci)}, InvokedTargets = new[] {nameof(Ci)},
CacheKeyFiles = new string[0])] CacheKeyFiles = new string[0])]
[GitHubActions("ci_publish", GitHubActionsImage.UbuntuLatest, [GitHubActions("ci_publish", GitHubActionsImage.UbuntuLatest,
OnPushBranches = new[] { "releases/*" }, OnPushBranches = new[] {"releases/*"},
OnPushTags = new[] { "v*" },
AutoGenerate = true, AutoGenerate = true,
InvokedTargets = new[] {nameof(CiPublish)}, InvokedTargets = new[] {nameof(CiPublish)},
CacheKeyFiles = new string[0], CacheKeyFiles = new string[0],
@@ -84,7 +83,6 @@ class Build : NukeBuild
Target Package => _ => _ Target Package => _ => _
.DependsOn(Test) .DependsOn(Test)
.Executes(() => .Executes(() =>
{ {
DotNetPack(s => s DotNetPack(s => s
.SetProject(SieveProject) .SetProject(SieveProject)