Skip to content

Extensible Filtering #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 30, 2017
Merged
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,14 @@ Install-Package JsonApiDotnetCore

- project.json
```json
"JsonApiDotNetCore": "1.2.1"
"JsonApiDotNetCore": "1.3.0"
```

- *.csproj
```xml
<ItemGroup>
<!-- ... -->
<PackageReference Include="JsonApiDotNetCore" Version="1.2.1" />
<PackageReference Include="JsonApiDotNetCore" Version="1.3.0" />
</ItemGroup>
```

Expand Down
4 changes: 3 additions & 1 deletion src/JsonApiDotNetCore/Data/DefaultEntityRepository.cs
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,10 @@ public virtual IQueryable<TEntity> Filter(IQueryable<TEntity> entities, FilterQ
if(filterQuery == null)
return entities;

var attributeFilterQuery = new AttrFilterQuery(_jsonApiContext, filterQuery);

return entities
.Filter(filterQuery);
.Filter(attributeFilterQuery);
}

public virtual IQueryable<TEntity> Sort(IQueryable<TEntity> entities, List<SortQuery> sortQueries)
Expand Down
2 changes: 1 addition & 1 deletion src/JsonApiDotNetCore/Extensions/IQueryableExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ private static IOrderedQueryable<TSource> CallGenericOrderMethod<TSource>(IQuery
return (IOrderedQueryable<TSource>)result;
}

public static IQueryable<TSource> Filter<TSource>(this IQueryable<TSource> source, FilterQuery filterQuery)
public static IQueryable<TSource> Filter<TSource>(this IQueryable<TSource> source, AttrFilterQuery filterQuery)
{
if (filterQuery == null)
return source;
Expand Down
51 changes: 51 additions & 0 deletions src/JsonApiDotNetCore/Internal/Query/AttrFilterQuery.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
using System;
using System.Linq;
using JsonApiDotNetCore.Models;
using JsonApiDotNetCore.Services;

namespace JsonApiDotNetCore.Internal.Query
{
public class AttrFilterQuery
{
private readonly IJsonApiContext _jsonApiContext;

public AttrFilterQuery(
IJsonApiContext jsonApiCopntext,
FilterQuery filterQuery)
{
_jsonApiContext = jsonApiCopntext;

var attribute = GetAttribute(filterQuery.Key);

if (attribute == null)
throw new JsonApiException("400", $"{filterQuery.Key} is not a valid property.");

FilteredAttribute = attribute;
PropertyValue = filterQuery.Value;
FilterOperation = GetFilterOperation(filterQuery.Operation);
}

public AttrAttribute FilteredAttribute { get; set; }
public string PropertyValue { get; set; }
public FilterOperations FilterOperation { get; set; }

private FilterOperations GetFilterOperation(string prefix)
{
if (prefix.Length == 0) return FilterOperations.eq;

FilterOperations opertion;
if (!Enum.TryParse<FilterOperations>(prefix, out opertion))
throw new JsonApiException("400", $"Invalid filter prefix '{prefix}'");

return opertion;
}

private AttrAttribute GetAttribute(string propertyName)
{
return _jsonApiContext.RequestEntity.Attributes
.FirstOrDefault(attr =>
attr.InternalAttributeName.ToLower() == propertyName.ToLower()
);
}
}
}
16 changes: 7 additions & 9 deletions src/JsonApiDotNetCore/Internal/Query/FilterQuery.cs
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
using JsonApiDotNetCore.Models;

namespace JsonApiDotNetCore.Internal.Query
{
public class FilterQuery
{
public FilterQuery(AttrAttribute filteredAttribute, string propertyValue, FilterOperations filterOperation)
public FilterQuery(string key, string value, string operation)
{
FilteredAttribute = filteredAttribute;
PropertyValue = propertyValue;
FilterOperation = filterOperation;
Key = key;
Value = value;
Operation = operation;
}

public AttrAttribute FilteredAttribute { get; set; }
public string PropertyValue { get; set; }
public FilterOperations FilterOperation { get; set; }
public string Key { get; set; }
public string Value { get; set; }
public string Operation { get; set; }
}
}
33 changes: 8 additions & 25 deletions src/JsonApiDotNetCore/Internal/Query/QuerySet.cs
Original file line number Diff line number Diff line change
Expand Up @@ -74,49 +74,32 @@ private List<FilterQuery> ParseFilterQuery(string key, string value)
var queries = new List<FilterQuery>();

var propertyName = key.Split('[', ']')[1].ToProperCase();
var attribute = GetAttribute(propertyName);

if (attribute == null)
throw new JsonApiException("400", $"{propertyName} is not a valid property.");

var values = value.Split(',');
foreach(var val in values)
queries.Add(ParseFilterOperation(attribute, val));
{
(var operation, var filterValue) = ParseFilterOperation(val);
queries.Add(new FilterQuery(propertyName, filterValue, operation));
}

return queries;
}

private FilterQuery ParseFilterOperation(AttrAttribute attribute, string value)
private (string operation, string value) ParseFilterOperation(string value)
{
if(value.Length < 3)
return new FilterQuery(attribute, value, FilterOperations.eq);
return (string.Empty, value);

var operation = value.Split(':');

if(operation.Length == 1)
return new FilterQuery(attribute, value, FilterOperations.eq);
return (string.Empty, value);

// remove prefix from value
var prefix = operation[0];
value = operation[1];

switch(prefix)
{
case "eq":
return new FilterQuery(attribute, value, FilterOperations.eq);
case "lt":
return new FilterQuery(attribute, value, FilterOperations.lt);
case "gt":
return new FilterQuery(attribute, value, FilterOperations.gt);
case "le":
return new FilterQuery(attribute, value, FilterOperations.le);
case "ge":
return new FilterQuery(attribute, value, FilterOperations.ge);
case "like":
return new FilterQuery(attribute, value, FilterOperations.like);
}

throw new JsonApiException("400", $"Invalid filter prefix '{prefix}'");
return (prefix, value);;
}

private PageQuery ParsePageQuery(string key, string value)
Expand Down
8 changes: 3 additions & 5 deletions src/JsonApiDotNetCore/JsonApiDotNetCore.csproj
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<VersionPrefix>1.2.2</VersionPrefix>
<VersionPrefix>1.3.0</VersionPrefix>
<TargetFramework>netcoreapp1.0</TargetFramework>
<AssemblyName>JsonApiDotNetCore</AssemblyName>
<PackageId>JsonApiDotNetCore</PackageId>
<RuntimeFrameworkVersion>1.1.1</RuntimeFrameworkVersion>
<PackageTargetFallback>$(PackageTargetFallback);dnxcore50;portable-net45+win8</PackageTargetFallback>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.AspNetCore.Routing" Version="1.1.1" />
<PackageReference Include="Microsoft.AspNetCore.Mvc" Version="1.1.2" />
<PackageReference Include="Microsoft.EntityFrameworkCore" Version="1.1.1" />
<PackageReference Include="Microsoft.Extensions.Logging" Version="1.1.1" />
<PackageReference Include="System.ValueTuple" Version="4.3.0" />
</ItemGroup>

</Project>
</Project>