public-mirrors/Sieve
1
0
Fork 0
mirror of https://github.com/Biarity/Sieve.git synced 2024-11-22 05:22:57 +01:00
Code Issues Projects Releases Wiki Activity

Version 2.0

Browse Source
This commit is contained in:
Biarity 2018-04-20 19:27:04 +10:00
parent c861ada8fa
commit 033a920bec
5 changed files with 158 additions and 202 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Sieve/Services/ISieveProcessor.cs
View File

@ -6,9 +6,12 @@ namespace Sieve.Services
{
public interface ISieveProcessor
{
IQueryable<TEntity> ApplyAll<TEntity>(ISieveModel<IFilterTerm, ISortTerm> model, IQueryable<TEntity> source, object[] dataForCustomMethods = null);
IQueryable<TEntity> ApplySorting<TEntity>(ISieveModel<IFilterTerm, ISortTerm> model, IQueryable<TEntity> result, object[] dataForCustomMethods = null);
IQueryable<TEntity> ApplyFiltering<TEntity>(ISieveModel<IFilterTerm, ISortTerm> model, IQueryable<TEntity> result, object[] dataForCustomMethods = null);
IQueryable<TEntity> ApplyPagination<TEntity>(ISieveModel<IFilterTerm, ISortTerm> model, IQueryable<TEntity> result);
IQueryable<TEntity> Apply<TEntity>(
ISieveModel<IFilterTerm, ISortTerm> model,
IQueryable<TEntity> source,
object[] dataForCustomMethods = null,
bool applyFiltering = true,
bool applySorting = true,
bool applyPagination = true);
}
}

107
Sieve/Services/SieveProcessor.cs
View File

@ -62,43 +62,58 @@ namespace Sieve.Services
/// <param name="model">An instance of ISieveModel</param>
/// <param name="source">Data source</param>
/// <param name="dataForCustomMethods">Additional data that will be passed down to custom methods</param>
/// <param name="applyFiltering">Should the data be filtered? Defaults to true.</param>
/// <param name="applySorting">Should the data be sorted? Defaults to true.</param>
/// <param name="applyPagination">Should the data be paginated? Defaults to true.</param>
/// <returns>Returns a transformed version of `source`</returns>
public IQueryable<TEntity> ApplyAll<TEntity>(
public IQueryable<TEntity> Apply<TEntity>(
ISieveModel<IFilterTerm, ISortTerm> model,
IQueryable<TEntity> source,
object[] dataForCustomMethods = null)
object[] dataForCustomMethods = null,
bool applyFiltering = true,
bool applySorting = true,
bool applyPagination = true)
{
var result = source;
if (model == null)
return result;
try
{
// Filter
if (applyFiltering)
result = ApplyFiltering(model, result, dataForCustomMethods);
// Sort
if (applySorting)
result = ApplySorting(model, result, dataForCustomMethods);
// Paginate
if (applyPagination)
result = ApplyPagination(model, result);
return result;
}
catch (Exception ex)
{
if (_options.Value.ThrowExceptions)
{
if (ex is SieveException)
throw;
throw new SieveException(ex.Message, ex);
}
else
{
return result;
}
}
}
/// <summary>
/// Apply filtering parameters found in `model` to `source`
/// </summary>
/// <typeparam name="TEntity"></typeparam>
/// <param name="model">An instance of ISieveModel</param>
/// <param name="source">Data source</param>
/// <param name="dataForCustomMethods">Additional data that will be passed down to custom methods</param>
/// <returns>Returns a transformed version of `source`</returns>
public IQueryable<TEntity> ApplyFiltering<TEntity>(
private IQueryable<TEntity> ApplyFiltering<TEntity>(
ISieveModel<IFilterTerm, ISortTerm> model,
IQueryable<TEntity> result,
object[] dataForCustomMethods = null)
{
try
{
if (model?.FiltersParsed == null)
return result;
@ -185,35 +200,11 @@ namespace Sieve.Services
return result;
}
catch (Exception ex)
{
if (_options.Value.ThrowExceptions)
{
if (ex is SieveException)
throw;
throw new SieveException(ex.Message, ex);
}
else
{
return result;
}
}
}
/// <summary>
/// Apply sorting parameters found in `model` to `source`
/// </summary>
/// <typeparam name="TEntity"></typeparam>
/// <param name="model">An instance of ISieveModel</param>
/// <param name="source">Data source</param>
/// <param name="dataForCustomMethods">Additional data that will be passed down to custom methods</param>
/// <returns>Returns a transformed version of `source`</returns>
public IQueryable<TEntity> ApplySorting<TEntity>(
private IQueryable<TEntity> ApplySorting<TEntity>(
ISieveModel<IFilterTerm, ISortTerm> model,
IQueryable<TEntity> result,
object[] dataForCustomMethods = null)
{
try
{
if (model?.SortsParsed == null)
return result;
@ -242,34 +233,10 @@ namespace Sieve.Services
return result;
}
catch (Exception ex)
{
if (_options.Value.ThrowExceptions)
{
if (ex is SieveException)
throw;
throw new SieveException(ex.Message, ex);
}
else
{
return result;
}
}
}
/// <summary>
/// Apply pagination parameters found in `model` to `source`
/// </summary>
/// <typeparam name="TEntity"></typeparam>
/// <param name="model">An instance of ISieveModel</param>
/// <param name="source">Data source</param>
/// <param name="dataForCustomMethods">Additional data that will be passed down to custom methods</param>
/// <returns>Returns a transformed version of `source`</returns>
public IQueryable<TEntity> ApplyPagination<TEntity>(
private IQueryable<TEntity> ApplyPagination<TEntity>(
ISieveModel<IFilterTerm, ISortTerm> model,
IQueryable<TEntity> result)
{
try
{
var page = model?.Page ?? 1;
var pageSize = model?.PageSize ?? _options.Value.DefaultPageSize;
@ -282,20 +249,6 @@ namespace Sieve.Services
return result;
}
catch (Exception ex)
{
if (_options.Value.ThrowExceptions)
{
if (ex is SieveException)
throw;
throw new SieveException(ex.Message, ex);
}
else
{
return result;
}
}
}
protected virtual SievePropertyMapper MapProperties(SievePropertyMapper mapper)

2
SieveTests/Controllers/PostsController.cs
View File

@ -28,7 +28,7 @@ namespace SieveTests.Controllers
{
var result = _dbContext.Posts.AsNoTracking();
result = _sieveProcessor.ApplyAll(sieveModel, result);
result = _sieveProcessor.Apply(sieveModel, result);
return Json(result.ToList());
}

18
SieveUnitTests/General.cs
View File

@ -58,7 +58,7 @@ namespace SieveUnitTests
Filters = "Title@=*a"
};
var result = _processor.ApplyFiltering(model, _posts);
var result = _processor.Apply(model, _posts);
Assert.AreEqual(result.First().Id, 0);
Assert.IsTrue(result.Count() == 1);
@ -72,7 +72,7 @@ namespace SieveUnitTests
Filters = "Title@=a",
};
var result = _processor.ApplyFiltering(model, _posts);
var result = _processor.Apply(model, _posts);
Assert.IsTrue(result.Count() == 0);
}
@ -85,7 +85,7 @@ namespace SieveUnitTests
Filters = "IsDraft==false"
};
var result = _processor.ApplyAll(model, _posts);
var result = _processor.Apply(model, _posts);
Assert.IsTrue(result.Count() == 2);
}
@ -99,7 +99,7 @@ namespace SieveUnitTests
Sorts = "-IsDraft"
};
var result = _processor.ApplyAll(model, _posts);
var result = _processor.Apply(model, _posts);
Assert.AreEqual(result.First().Id, 0);
}
@ -116,7 +116,7 @@ namespace SieveUnitTests
Console.WriteLine(model.FiltersParsed.First().Operator);
Console.WriteLine(model.FiltersParsed.First().OperatorParsed);
var result = _processor.ApplyFiltering(model, _posts);
var result = _processor.Apply(model, _posts);
@ -132,7 +132,7 @@ namespace SieveUnitTests
Filters = "Isnew",
};
var result = _processor.ApplyFiltering(model, _posts);
var result = _processor.Apply(model, _posts);
Assert.IsFalse(result.Any(p => p.Id == 0));
Assert.IsTrue(result.Count() == 3);
@ -146,7 +146,7 @@ namespace SieveUnitTests
Filters = "does not exist",
};
Assert.ThrowsException<SieveMethodNotFoundException>(() => _processor.ApplyFiltering(model, _posts));
Assert.ThrowsException<SieveMethodNotFoundException>(() => _processor.Apply(model, _posts));
}
[TestMethod]
@ -157,7 +157,7 @@ namespace SieveUnitTests
Filters = "TestComment",
};
Assert.ThrowsException<SieveIncompatibleMethodException>(() => _processor.ApplyFiltering(model, _posts));
Assert.ThrowsException<SieveIncompatibleMethodException>(() => _processor.Apply(model, _posts));
}
[TestMethod]
@ -168,7 +168,7 @@ namespace SieveUnitTests
Filters = "(Title|LikeCount)==3",
};
var result = _processor.ApplyFiltering(model, _posts);
var result = _processor.Apply(model, _posts);
Assert.AreEqual(result.First().Id, 3);
Assert.IsTrue(result.Count() == 1);

6
SieveUnitTests/Mapper.cs
View File

@ -53,7 +53,7 @@ namespace SieveUnitTests
Filters = "shortname@=A",
};
var result = _processor.ApplyAll(model, _posts);
var result = _processor.Apply(model, _posts);
Assert.AreEqual(result.First().ThisHasNoAttributeButIsAccessible, "A");
@ -69,9 +69,9 @@ namespace SieveUnitTests
Sorts = "OnlySortableViaFluentApi"
};
var result = _processor.ApplySorting(model, _posts);
var result = _processor.Apply(model, _posts, applyFiltering: false, applyPagination: false);
Assert.ThrowsException<SieveMethodNotFoundException>(() => _processor.ApplyAll(model, _posts));
Assert.ThrowsException<SieveMethodNotFoundException>(() => _processor.Apply(model, _posts));
Assert.AreEqual(result.First().Id, 3);