update to v2.3.0 (#30)

* Add CancelationToken Support * fix tests build warnings * GridifyMapper ToString returns field list * add GridifyMapper ToString summary comment * remove the position from SyntaxToken * add Index mapping feature. fix issue #29 * update to v2.3.0
alirezanet · Oct 4, 2021 · eed8985 · eed8985
1 parent 179c5ab
commit eed8985
Show file tree

Hide file tree

Showing 15 changed files with 164 additions and 50 deletions.
diff --git a/src/Gridify.EntityFramework/Gridify.EntityFramework.csproj b/src/Gridify.EntityFramework/Gridify.EntityFramework.csproj
@@ -9,7 +9,7 @@
    <PropertyGroup>
       <TargetFramework>netstandard2.0</TargetFramework>
       <PackageId>Gridify.EntityFramework</PackageId>
-      <Version>2.2.1</Version>
+      <Version>2.3.0</Version>
       <Authors>Alireza Sabouri</Authors>
       <Company>TuxTeam</Company>
       <PackageDescription>Gridify (EntityFramework), Easy and optimized way to apply Filtering, Sorting, and Pagination using text-based data.</PackageDescription>

diff --git a/src/Gridify.EntityFramework/GridifyExtensions.cs b/src/Gridify.EntityFramework/GridifyExtensions.cs
@@ -1,12 +1,12 @@
 using System.Linq;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.EntityFrameworkCore;
 
 namespace Gridify.EntityFramework
 {
    public static partial class GridifyExtensions
    {
-
       #region "EntityFramework Integration"
 
       public async static Task<QueryablePaging<T>> GridifyQueryableAsync<T>(this IQueryable<T> query, IGridifyQuery gridifyQuery,
@@ -26,6 +26,23 @@ public static async Task<Paging<T>> GridifyAsync<T>(this IQueryable<T> query, IG
          return new Paging<T>(res.Count, await res.Query.ToListAsync());
       }
 
+      public async static Task<QueryablePaging<T>> GridifyQueryableAsync<T>(this IQueryable<T> query, IGridifyQuery gridifyQuery,
+         IGridifyMapper<T> mapper, CancellationToken token)
+      {
+         query = query.ApplyFiltering(gridifyQuery, mapper);
+         var count = await query.CountAsync(token);
+         query = query.ApplyOrdering(gridifyQuery, mapper);
+         query = query.ApplyPaging(gridifyQuery);
+         return new QueryablePaging<T>(count, query);
+      }
+
+      public static async Task<Paging<T>> GridifyAsync<T>(this IQueryable<T> query, IGridifyQuery gridifyQuery, CancellationToken token, IGridifyMapper<T> mapper = null)
+      {
+         mapper = mapper.FixMapper();
+         var res = await query.GridifyQueryableAsync(gridifyQuery, mapper, token);
+         return new Paging<T>(res.Count, await res.Query.ToListAsync(token));
+      }
+
       #endregion
    }
 }
diff --git a/src/Gridify/GMap.cs b/src/Gridify/GMap.cs
@@ -6,7 +6,7 @@ namespace Gridify
    public class GMap<T> : IGMap<T>
    {
       public string From { get; set; }
-      public Expression<Func<T, object?>> To { get; set; }
+      public LambdaExpression To { get; set; }
       public Func<string, object>? Convertor { get; set; }
       public bool IsNestedCollection { get; }
 
@@ -17,5 +17,13 @@ public GMap(string from, Expression<Func<T, object?>> to, Func<string, object>?
          Convertor = convertor;
          IsNestedCollection = isNestedCollection;
       }
+
+      public GMap(string from, Expression<Func<T,int, object?>> to, Func<string, object>? convertor = null, bool isNestedCollection = false)
+      {
+         From = from;
+         To = to;
+         Convertor = convertor;
+         IsNestedCollection = isNestedCollection;
+      }
    }
 }
diff --git a/src/Gridify/Gridify.csproj b/src/Gridify/Gridify.csproj
@@ -3,7 +3,7 @@
    <PropertyGroup>
       <TargetFramework>netstandard2.0</TargetFramework>
       <PackageId>Gridify</PackageId>
-      <Version>2.2.1</Version>
+      <Version>2.3.0</Version>
       <Authors>Alireza Sabouri</Authors>
       <Company>TuxTeam</Company>
       <PackageDescription>Gridify, Easy and optimized way to apply Filtering, Sorting, and Pagination using text-based data.</PackageDescription>

diff --git a/src/Gridify/GridifyMapper.cs b/src/Gridify/GridifyMapper.cs
@@ -58,6 +58,18 @@ public IGridifyMapper<T> AddMap(string from, Expression<Func<T, object?>> to, Fu
          return this;
       }
 
+      public IGridifyMapper<T> AddMap(string from, Expression<Func<T, int, object?>> to, Func<string, object>? convertor = null!,
+         bool overrideIfExists = true)
+      {
+         if (!overrideIfExists && HasMap(from))
+            throw new GridifyMapperException($"Duplicate Key. the '{from}' key already exists");
+
+         RemoveMap(from);
+         var isNested = Regex.IsMatch(to.ToString(), @"\.Select\s*\(");
+         _mappings.Add(new GMap<T>(from, to, convertor, isNested));
+         return this;
+      }
+
       public IGridifyMapper<T> AddMap(IGMap<T> gMap, bool overrideIfExists = true)
       {
          if (!overrideIfExists && HasMap(gMap.From))
@@ -96,7 +108,7 @@ public bool HasMap(string from)
             : _mappings.FirstOrDefault(q => from.Equals(q.From, StringComparison.InvariantCultureIgnoreCase));
       }
 
-      public Expression<Func<T, object>> GetExpression(string key)
+      public LambdaExpression GetLambdaExpression(string key)
       {
          var expression = Configuration.CaseSensitive
             ? _mappings.FirstOrDefault(q => key.Equals(q.From))?.To
@@ -105,12 +117,29 @@ public Expression<Func<T, object>> GetExpression(string key)
             throw new GridifyMapperException($"Mapping Key `{key}` not found.");
          return expression!;
       }
+
+      public Expression<Func<T,object?>> GetExpression(string key)
+      {
+         var expression = Configuration.CaseSensitive
+            ? _mappings.FirstOrDefault(q => key.Equals(q.From))?.To
+            : _mappings.FirstOrDefault(q => key.Equals(q.From, StringComparison.InvariantCultureIgnoreCase))?.To;
+         if (expression == null)
+            throw new GridifyMapperException($"Mapping Key `{key}` not found.");
+         return expression as Expression<Func<T,object?>> ?? throw new GridifyMapperException($"Expression fir the `{key}` not found.");
+      }
 
       public IEnumerable<IGMap<T>> GetCurrentMaps()
       {
          return _mappings;
       }
 
+      /// <summary>
+      /// Converts current mappings to a comma seperated list of map names.
+      /// eg, filed1,field2,field3 
+      /// </summary>
+      /// <returns>a comma seperated string</returns>
+      public override string ToString() => string.Join(",", _mappings.Select(q => q.From));
+
       private static Expression<Func<T, object>> CreateExpression(string from)
       {
          // x =>

diff --git a/src/Gridify/IGMap.cs b/src/Gridify/IGMap.cs
@@ -6,7 +6,7 @@ namespace Gridify
    public interface IGMap<T>
    {
       string From { get; set; }
-      Expression<Func<T, object?>> To { get; set; }
+      LambdaExpression To { get; set; }
       Func<string, object>? Convertor { get; set; }
       bool IsNestedCollection { get; }
    }

diff --git a/src/Gridify/IGridifyMapper.cs b/src/Gridify/IGridifyMapper.cs
@@ -7,11 +7,16 @@ namespace Gridify
    public interface IGridifyMapper<T>
    {
       IGridifyMapper<T> AddMap(string from, Expression<Func<T, object?>> to, Func<string, object>? convertor = null, bool overrideIfExists = true);
+
+      IGridifyMapper<T> AddMap(string from, Expression<Func<T, int, object?>> to, Func<string, object>? convertor = null!,
+         bool overrideIfExists = true);
+
       IGridifyMapper<T> AddMap(IGMap<T> gMap, bool overrideIfExists = true);
       IGridifyMapper<T> GenerateMappings();
       IGridifyMapper<T> RemoveMap(string propertyName);
       IGridifyMapper<T> RemoveMap(IGMap<T> gMap);
-      Expression<Func<T, object>> GetExpression(string from);
+      LambdaExpression GetLambdaExpression(string from);
+      Expression<Func<T, object?>> GetExpression(string key);
       IGMap<T>? GetGMap(string from);
       bool HasMap(string key);
       public GridifyMapperConfiguration Configuration { get; }

diff --git a/src/Gridify/Syntax/FieldExpressionSyntax.cs b/src/Gridify/Syntax/FieldExpressionSyntax.cs
@@ -1,21 +1,38 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
+using System.Text.RegularExpressions;
 
 namespace Gridify.Syntax
 {
    internal sealed class FieldExpressionSyntax : ExpressionSyntax
    {
       internal FieldExpressionSyntax(SyntaxToken fieldToken)
       {
-         FieldToken = fieldToken;
+         // for performance reason we simply check the last character first 
+         if (fieldToken.Text.EndsWith("]"))
+         {
+            // checking indexes from the field names
+            var regex = new Regex(@"(\w+)\[(\d+)\]");
+            var match = regex.Match(fieldToken.Text);
+            if (!match.Success) throw new ArgumentException($"Invalid filed name '{fieldToken.Text}'");
+            IsCollection = true;
+            Index = int.Parse(match.Groups[2].Value);
+            FieldToken = new SyntaxToken(SyntaxKind.FieldToken, 0, match.Groups[1].Value);
+         }
+         else
+            FieldToken = fieldToken;
       }
 
+
       public override SyntaxKind Kind => SyntaxKind.FieldExpression;
 
       public override IEnumerable<SyntaxNode> GetChildren()
       {
          yield return FieldToken;
       }
 
+      public bool IsCollection { get; }
+      public int Index { get; }
       public SyntaxToken FieldToken { get; }
    }
 }
diff --git a/src/Gridify/Syntax/Lexer.cs b/src/Gridify/Syntax/Lexer.cs
@@ -75,7 +75,7 @@ public SyntaxToken NextToken()
          {
             var start = _position;
 
-            while (char.IsLetterOrDigit(Current) || Current is '_')
+            while (char.IsLetterOrDigit(Current) || Current is '_' or '[' or ']')  
                Next();
 
             var length = _position - start;

diff --git a/src/Gridify/Syntax/Parser.cs b/src/Gridify/Syntax/Parser.cs
@@ -118,7 +118,7 @@ private SyntaxToken Match(SyntaxKind kind)
             return NextToken();
 
          _diagnostics.Add($"Unexpected token <{Current.Kind}>, expected <{kind}>");
-         return new SyntaxToken(kind, Current.Position, string.Empty);
+         return new SyntaxToken(kind, 0, string.Empty);
       }
 
       private ExpressionSyntax ParsePrimaryExpression()

diff --git a/src/Gridify/Syntax/SyntaxToken.cs b/src/Gridify/Syntax/SyntaxToken.cs
@@ -6,19 +6,17 @@ namespace Gridify.Syntax
    public class SyntaxToken : SyntaxNode
    {
       public override SyntaxKind Kind { get; }
-
-      public int Position { get; }
       public string Text { get; }
 
       public override IEnumerable<SyntaxNode> GetChildren()
       {
          return Enumerable.Empty<SyntaxNode>();
       }
 
-      public SyntaxToken(SyntaxKind kind, int position, string text)
+      // we don't need position yet ( we can use the second argument later when we had a analyzer or debugger )
+      public SyntaxToken(SyntaxKind kind, int _ ,  string text)
       {
          Kind = kind;
-         Position = position;
          Text = text;
       }
 

diff --git a/src/Gridify/Syntax/SyntaxTreeToQueryConvertor.cs b/src/Gridify/Syntax/SyntaxTreeToQueryConvertor.cs
@@ -12,7 +12,10 @@ public static class ExpressionToQueryConvertor
       private static (Expression<Func<T, bool>> Expression, bool IsNested)? ConvertBinaryExpressionSyntaxToQuery<T>(
          BinaryExpressionSyntax binarySyntax, IGridifyMapper<T> mapper)
       {
-         var left = (binarySyntax.Left as FieldExpressionSyntax)?.FieldToken.Text.Trim();
+
+         var fieldExpression = binarySyntax.Left as FieldExpressionSyntax;
+
+         var left = fieldExpression?.FieldToken.Text.Trim();
          var right = (binarySyntax.Right as ValueExpressionSyntax);
          var op = binarySyntax.OperatorToken;
 
@@ -21,6 +24,9 @@ private static (Expression<Func<T, bool>> Expression, bool IsNested)? ConvertBin
          var gMap = mapper.GetGMap(left);
 
          if (gMap == null) return null;
+
+         if (fieldExpression!.IsCollection)
+           gMap.To = UpdateExpressionIndex(gMap.To,fieldExpression.Index);
 
          if (gMap.IsNestedCollection)
          {
@@ -36,6 +42,15 @@ private static (Expression<Func<T, bool>> Expression, bool IsNested)? ConvertBin
          }
       }
 
+      private static LambdaExpression UpdateExpressionIndex(LambdaExpression exp, int index)
+      {
+	      var parameter = exp.Parameters[0];
+         var unary = exp.Body as UnaryExpression;
+         var body = unary!.Operand as MemberExpression;
+         var newBody = new PredicateBuilder.ReplaceExpressionVisitor(exp.Parameters[1],Expression.Constant(index,typeof(int))).Visit(body!);
+         return Expression.Lambda(newBody,parameter);
+      }
+
       private static Expression<Func<T, bool>>? GenerateNestedExpression<T>(
          IGridifyMapper<T> mapper,
          IGMap<T> gMap,

diff --git a/test/Gridify.Tests/GridifyExtensionsShould.cs b/test/Gridify.Tests/GridifyExtensionsShould.cs
@@ -245,7 +245,7 @@ public void ApplyFiltering_StartsWith()
             .ApplyFiltering(gq)
             .ToList();
 
-         var expected = _fakeRepository.Where(q => q.Name.StartsWith("A")).ToList();
+         var expected = _fakeRepository.Where(q => q.Name!.StartsWith("A")).ToList();
 
          Assert.Equal(expected.Count, actual.Count);
          Assert.Equal(expected, actual);
@@ -294,7 +294,7 @@ public void ApplyFiltering_NotStartsWith()
             .ApplyFiltering(gq)
             .ToList();
 
-         var expected = _fakeRepository.Where(q => !q.Name.StartsWith("A")).ToList();
+         var expected = _fakeRepository.Where(q => !q.Name!.StartsWith("A")).ToList();
 
          Assert.Equal(expected.Count, actual.Count);
          Assert.Equal(expected, actual);
@@ -310,7 +310,7 @@ public void ApplyFiltering_EndsWith()
             .ApplyFiltering(gq)
             .ToList();
 
-         var expected = _fakeRepository.Where(q => q.Name.EndsWith("li")).ToList();
+         var expected = _fakeRepository.Where(q => q.Name!.EndsWith("li")).ToList();
          Assert.Equal(expected.Count, actual.Count);
          Assert.Equal(expected, actual);
          Assert.True(actual.Any());
@@ -325,7 +325,7 @@ public void ApplyFiltering_NotEndsWith()
             .ApplyFiltering(gq)
             .ToList();
 
-         var expected = _fakeRepository.Where(q => !q.Name.EndsWith("i")).ToList();
+         var expected = _fakeRepository.Where(q => !q.Name!.EndsWith("i")).ToList();
 
          Assert.Equal(expected.Count, actual.Count);
          Assert.Equal(expected, actual);
@@ -350,7 +350,7 @@ public void ApplyFiltering_ComplexWithParenthesis()
          var actual = _fakeRepository.AsQueryable()
             .ApplyFiltering("(name=*J|name=*S),(Id<5)")
             .ToList();
-         var expected = _fakeRepository.Where(q => (q.Name.Contains("J") || q.Name.Contains("S")) && q.Id < 5).ToList();
+         var expected = _fakeRepository.Where(q => (q.Name!.Contains("J") || q.Name.Contains("S")) && q.Id < 5).ToList();
          Assert.Equal(expected.Count, actual.Count);
          Assert.Equal(expected, actual);
          Assert.True(actual.Any());
@@ -364,7 +364,7 @@ public void ApplyFiltering_NestedParenthesisWithSpace()
          var actual = _fakeRepository.AsQueryable()
             .ApplyFiltering(gq)
             .ToList();
-         var expected = _fakeRepository.Where(q => q.Name.Contains("J") || q.Name.Contains("S") && q.Id < 5).ToList();
+         var expected = _fakeRepository.Where(q => q.Name!.Contains("J") || q.Name.Contains("S") && q.Id < 5).ToList();
          Assert.Equal(expected.Count, actual.Count);
          Assert.Equal(expected, actual);
          Assert.True(actual.Any());
@@ -394,13 +394,13 @@ public void ApplyFiltering_CaseInsensitiveSearchUsingConvertor() //issue #21
       {
          var gq = new GridifyQuery { Filter = "name=BOB" };
          var gm = new GridifyMapper<TestClass>()
-            .AddMap("name", q => q.Name.ToLower(), c => c.ToLower());
+            .AddMap("name", q => q.Name!.ToLower(), c => c.ToLower());
 
          var actual = _fakeRepository.AsQueryable()
             .ApplyFiltering(gq, gm)
             .ToList();
 
-         var expected = _fakeRepository.Where(q => q.Name.ToLower() == "BOB".ToLower()).ToList();
+         var expected = _fakeRepository.Where(q => q.Name!.ToLower() == "BOB".ToLower()).ToList();
          Assert.Equal(expected.Count, actual.Count);
          Assert.Equal(expected, actual);
          Assert.True(actual.Any());
@@ -415,7 +415,7 @@ public void ApplyFiltering_CaseInsensitiveSearch() //issue #21
             .ApplyFiltering(gq)
             .ToList();
 
-         var expected = _fakeRepository.Where(q => q.Name.ToLower() == "BOB".ToLower()).ToList();
+         var expected = _fakeRepository.Where(q => q.Name!.ToLower() == "BOB".ToLower()).ToList();
          Assert.Equal(expected.Count, actual.Count);
          Assert.Equal(expected, actual);
          Assert.True(actual.Any());
@@ -534,7 +534,7 @@ public void ApplyFiltering_NotEqual_ProcessingNullOrDefaultValue()
       public void ApplyFiltering_Equal_ProcessingNullOrDefaultValueNonStringTypes()
       {
          var actual = _fakeRepository.AsQueryable().ApplyFiltering("myGuid=").ToList();
-         var expected = _fakeRepository.Where(q => q.MyGuid == null || q.MyGuid == default).ToList();
+         var expected = _fakeRepository.Where(q => q.MyGuid == default).ToList();
 
          Assert.Equal(expected.Count, actual.Count);
          Assert.Equal(expected, actual);
@@ -545,7 +545,7 @@ public void ApplyFiltering_Equal_ProcessingNullOrDefaultValueNonStringTypes()
       public void ApplyFiltering_NotEqual_ProcessingNullOrDefaultValueNonStringTypes()
       {
          var actual = _fakeRepository.AsQueryable().ApplyFiltering("myGuid!=").ToList();
-         var expected = _fakeRepository.Where(q => q.MyGuid != null && q.MyGuid != default).ToList();
+         var expected = _fakeRepository.Where(q => q.MyGuid != default).ToList();
 
          Assert.Equal(expected.Count, actual.Count);
          Assert.Equal(expected, actual);