Merge pull request #31 from trenoncourt/develop

trenoncourt · web-flow · commit 57cbbbf8824e · 2017-11-18T16:45:05.000+01:00
Develop
diff --git a/README.md b/README.md
@@ -163,6 +163,22 @@ public class UsersController : Controller
 ```
 *Note that Dto projection is the best way to limit selectable properties*
 
+## Use base type instead of dynamic types
+AQ uses dynamic types per default to ensure that the final flow will be as small as possible. In some cases you may not want to use dynamic types, there is a property for this:
+```c#
+[Route("api/[controller]")]
+public class UsersController : Controller
+{
+    [HttpGet]
+    [AutoQueryable(UseBaseType = true)]
+    public IQueryable<User> Get([FromServices] myDbContext dbContext)
+    {
+        return dbContext.User;
+    }
+}
+```
+*Note that final flow will include null and default values but you can escape them with serializer settings for exemple*
+
 ## Use AutoQueryable without attribute 
 If you don't want to use autoqueryable attribute you could use AQ directry in your code by passing it the querystring. 
 First install the Autoqueryable package
@@ -192,8 +208,8 @@ public class UsersController
 - Add capability to use Group by
 - Add capability to set AutoQueryable options in headers
 - Add capability to choose to ignore case or not (case is ignored for now)
-- Add an option to not use dynamic objects (Use the type T provided by the IQueryable<T>)
 - Add Odata-v(x) & others as plugin (choose beetween AutoQueryable, Odata or others for query)
+- ~~Add an option to not use dynamic objects (Use the type T provided by the IQueryable\<T>)~~
 - ~~Add **Top**, **Skip**, **Take**, **OrderBy** keywords~~
 - ~~Add capability to include navidation properties (aka expand in OData)~~
 - ~~Add capability to select properties (columns in table)~~
diff --git a/sample/AutoQueryable.Sample.EfCore/Controllers/ProductController.cs b/sample/AutoQueryable.Sample.EfCore/Controllers/ProductController.cs
@@ -6,6 +6,7 @@
 using AutoQueryable.Sample.EfCore.Contexts;
 using AutoQueryable.Sample.EfCore.Dtos;
 using Microsoft.AspNetCore.Mvc;
+using AutoQueryable.Sample.EfCore.Entities;
 
 namespace AutoQueryable.Sample.EfCore.Controllers
 {
@@ -20,7 +21,7 @@ public class ProductController : ControllerBase
         /// <example>http://localhost:5000/api/products?select=name&top=50&skip=10</example>
         /// <param name="context"></param>
         /// <returns></returns>
-        [AutoQueryable]
+        [AutoQueryable(UseBaseType = true)]
         [HttpGet]
         public IQueryable Get([FromServices] AutoQueryableContext context)
         {
diff --git a/sample/AutoQueryable.Sample.EfCore/Entities/ProductModel.cs b/sample/AutoQueryable.Sample.EfCore/Entities/ProductModel.cs
@@ -16,6 +16,6 @@ public ProductModel()
         public Guid Rowguid { get; set; }
         public DateTime ModifiedDate { get; set; }
 
-        public virtual ICollection<Product> Product { get; set; }
+        public virtual IEnumerable<Product> Product { get; set; }
     }
 }
diff --git a/sample/AutoQueryable.Sample.EfCore/Startup.cs b/sample/AutoQueryable.Sample.EfCore/Startup.cs
@@ -20,7 +20,6 @@ public void ConfigureServices(IServiceCollection services)
                 .AddJsonFormatters(settings =>
                 {
                     settings.ContractResolver = new CamelCasePropertyNamesContractResolver();
-                    settings.NullValueHandling = NullValueHandling.Ignore;
                     settings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;
                 });
 
diff --git a/src/AutoQueryable.AspNet.Filter/AutoQueryable.AspNet.Filter.csproj b/src/AutoQueryable.AspNet.Filter/AutoQueryable.AspNet.Filter.csproj
@@ -3,8 +3,8 @@
   <PropertyGroup>
     <Description>AutoQueryable.AspNetCore.Filter add filterAttribute for AutoQueryable to Asp.Net &gt;=4.6.</Description>
     <AssemblyTitle>AutoQueryable.AspNetCore.Filter add filterAttribute for AutoQueryable to Asp.Net &gt;=4.6.</AssemblyTitle>
-    <VersionPrefix>1.3.0</VersionPrefix>
-    <Version>1.3.0</Version>
+    <VersionPrefix>1.4.0</VersionPrefix>
+    <Version>1.4.0</Version>
     <Authors>Thibaut Renoncourt</Authors>
     <TargetFramework>net46</TargetFramework>
     <AssemblyName>AutoQueryable.AspNet.Filter</AssemblyName>
diff --git a/src/AutoQueryable.AspNetCore.Filter/AutoQueryable.AspNetCore.Filter.csproj b/src/AutoQueryable.AspNetCore.Filter/AutoQueryable.AspNetCore.Filter.csproj
@@ -3,8 +3,8 @@
   <PropertyGroup>
     <Description>AutoQueryable.AspNetCore.Filter add filterAttribute for AutoQueryable to Asp.Net Core.</Description>
     <AssemblyTitle>AutoQueryable.AspNetCore.Filter add filterAttribute for AutoQueryable to Asp.Net Core.</AssemblyTitle>
-    <VersionPrefix>1.3.0</VersionPrefix>
-    <Version>1.3.0</Version>
+    <VersionPrefix>1.4.0</VersionPrefix>
+    <Version>1.4.0</Version>
     <Authors>Thibaut Renoncourt</Authors>
     <TargetFramework>netstandard1.6</TargetFramework>
     <AssemblyName>AutoQueryable.AspNetCore.Filter</AssemblyName>
diff --git a/src/AutoQueryable.AspNetCore.Filter/FilterAttributes/AutoQueryableAttribute.cs b/src/AutoQueryable.AspNetCore.Filter/FilterAttributes/AutoQueryableAttribute.cs
@@ -41,6 +41,8 @@ public class AutoQueryableAttribute : ActionFilterAttribute
         
         public ProviderType ProviderType { get; set; }
 
+        public bool UseBaseType { get; set; }
+
         public override void OnActionExecuted(ActionExecutedContext context)
         {
             dynamic query = ((ObjectResult)context.Result).Value;
@@ -65,7 +67,8 @@ public override void OnActionExecuted(ActionExecutedContext context)
                 MaxToTake = MaxToTake,
                 MaxToSkip = MaxToSkip,
                 MaxDepth = MaxDepth,
-                ProviderType = ProviderType
+                ProviderType = ProviderType,
+                UseBaseType = UseBaseType
             }));
         }
     }
diff --git a/src/AutoQueryable.Core/AutoQueryable.Core.csproj b/src/AutoQueryable.Core/AutoQueryable.Core.csproj
@@ -1,10 +1,10 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>netstandard1.3</TargetFrameworks>
-    <VersionPrefix>1.3.0</VersionPrefix>
-    <Version>1.3.0</Version>
-    <AssemblyVersion>1.3.0.0</AssemblyVersion>
-    <FileVersion>1.3.0.0</FileVersion>
+    <VersionPrefix>1.4.0</VersionPrefix>
+    <Version>1.4.0</Version>
+    <AssemblyVersion>1.4.0.0</AssemblyVersion>
+    <FileVersion>1.4.0.0</FileVersion>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.CSharp" Version="4.3.0" />
diff --git a/src/AutoQueryable.Core/Models/AutoQueryableProfile.cs b/src/AutoQueryable.Core/Models/AutoQueryableProfile.cs
@@ -36,5 +36,7 @@ public class AutoQueryableProfile
         public int? MaxDepth { get; set; }
 
         public ProviderType ProviderType { get; set; } = ProviderType.Default;
+
+        public bool UseBaseType { get; set; }
     }
 }
diff --git a/src/AutoQueryable.Nancy.Filter/AutoQueryable.Nancy.Filter.csproj b/src/AutoQueryable.Nancy.Filter/AutoQueryable.Nancy.Filter.csproj
@@ -4,8 +4,8 @@
     <TargetFramework>netstandard1.6</TargetFramework>
     <Description>AutoQueryable.AspNetCore.Filter add filterAttribute for AutoQueryable to Nancy.</Description>
     <Authors>Thibaut Renoncourt</Authors>
-    <VersionPrefix>1.3.0</VersionPrefix>
-    <Version>1.3.0</Version>
+    <VersionPrefix>1.4.0</VersionPrefix>
+    <Version>1.4.0</Version>
     <PackageLicenseUrl>https://raw.githubusercontent.com/trenoncourt/AutoQueryable/master/LICENSE</PackageLicenseUrl>
     <PackageProjectUrl>https://github.com/trenoncourt/AutoQueryable</PackageProjectUrl>
     <PackageTags>AutoQueryable;AutoQuery;OData;GraphQL</PackageTags>
diff --git a/src/AutoQueryable.Providers.OData/AutoQueryable.Providers.OData.csproj b/src/AutoQueryable.Providers.OData/AutoQueryable.Providers.OData.csproj
@@ -1,10 +1,10 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>netstandard1.3</TargetFramework>
-    <VersionPrefix>1.3.0</VersionPrefix>
-    <Version>1.3.0</Version>
-    <AssemblyVersion>1.3.0.0</AssemblyVersion>
-    <FileVersion>1.3.0.0</FileVersion>
+    <VersionPrefix>1.4.0</VersionPrefix>
+    <Version>1.4.0</Version>
+    <AssemblyVersion>1.4.0.0</AssemblyVersion>
+    <FileVersion>1.4.0.0</FileVersion>
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="..\AutoQueryable.Core\AutoQueryable.Core.csproj" />
diff --git a/src/AutoQueryable/AutoQueryable.csproj b/src/AutoQueryable/AutoQueryable.csproj
@@ -2,7 +2,7 @@
   <PropertyGroup>
     <Description>AutoQueryable add auto querying functionality like OData with best url practices to Asp.Net Core.</Description>
     <AssemblyTitle>AutoQueryable add auto querying functionality like OData with best url practices to Asp.Net Core.</AssemblyTitle>
-    <VersionPrefix>1.3.0</VersionPrefix>
+    <VersionPrefix>1.4.0</VersionPrefix>
     <Authors>Thibaut Renoncourt</Authors>
     <TargetFrameworks>netstandard1.3</TargetFrameworks>
     <AssemblyName>AutoQueryable</AssemblyName>
@@ -14,9 +14,9 @@
     <GenerateAssemblyConfigurationAttribute>false</GenerateAssemblyConfigurationAttribute>
     <GenerateAssemblyCompanyAttribute>false</GenerateAssemblyCompanyAttribute>
     <GenerateAssemblyProductAttribute>false</GenerateAssemblyProductAttribute>
-    <Version>1.3.0</Version>
-    <AssemblyVersion>1.3.0.0</AssemblyVersion>
-    <FileVersion>1.3.0.0</FileVersion>
+    <Version>1.4.0</Version>
+    <AssemblyVersion>1.4.0.0</AssemblyVersion>
+    <FileVersion>1.4.0.0</FileVersion>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="System.Reflection.Emit" Version="4.3.0" />
diff --git a/src/AutoQueryable/Extensions/QueryableExtension.cs b/src/AutoQueryable/Extensions/QueryableExtension.cs
@@ -11,6 +11,7 @@ public static class QueryableExtension
     {
         public static dynamic AutoQueryable<TEntity>(this IQueryable<TEntity> query, string queryString, AutoQueryableProfile profile = null) where TEntity : class
         {
+            profile = profile ?? new AutoQueryableProfile();
             Type entityType = typeof(TEntity);
             return QueryableHelper.GetAutoQuery(queryString, entityType, query, profile);
         }
diff --git a/src/AutoQueryable/Helpers/QueryBuilder.cs b/src/AutoQueryable/Helpers/QueryBuilder.cs
@@ -48,7 +48,14 @@ public static QueryResult Build<T>(IQueryable<T> query, Type entityType, Clauses
             }
             else
             {
-                queryProjection = query.Select(SelectHelper.GetSelector<T>(selectColumns));
+                if (profile.UseBaseType)
+                {
+                    queryProjection = query.Select(SelectHelper.GetSelector<T, T>(selectColumns, profile));
+                }
+                else
+                {
+                    queryProjection = query.Select(SelectHelper.GetSelector<T, object>(selectColumns, profile));
+                }
             }
 
             if (clauses.Skip != null)
diff --git a/src/AutoQueryable/Helpers/QueryableHelper.cs b/src/AutoQueryable/Helpers/QueryableHelper.cs
@@ -22,7 +22,11 @@ public static dynamic GetAutoQuery<TEntity>(string queryString, Type entityType,
             {
                 IColumnProvider columnProvider = ProviderFactory.GetColumnProvider();
                 IEnumerable<SelectColumn> selectColumns = EntityColumnHelper.GetSelectableColumns(profile, entityType);
-                return query.Select(SelectHelper.GetSelector<TEntity>(selectColumns));
+                if (profile.UseBaseType)
+                {
+                    return query.Select(SelectHelper.GetSelector<TEntity, TEntity>(selectColumns, profile));
+                }
+                return query.Select(SelectHelper.GetSelector<TEntity, object>(selectColumns, profile));
             }
             
             // Get criteria & clauses from choosen provider (AQ, OData, ...)
diff --git a/src/AutoQueryable/Helpers/SelectHelper.cs b/src/AutoQueryable/Helpers/SelectHelper.cs
@@ -29,7 +29,13 @@ static RuntimeTypeBuilder()
 
         internal static Type GetRuntimeType<TEntity>(IDictionary<string, object> fields)
         {
-            string typeKey = GetTypeKey<TEntity>(fields);
+            return GetRuntimeType(typeof(TEntity), fields);
+        }
+
+        internal static Type GetRuntimeType(Type entityType, IDictionary<string, object> fields)
+        {
+
+            string typeKey = GetTypeKey(entityType, fields);
             if (!builtTypes.ContainsKey(typeKey))
             {
                 lock (moduleBuilder)
@@ -65,6 +71,11 @@ internal static Type GetRuntimeType(string typeName, IEnumerable<KeyValuePair<st
         }
 
         private static string GetTypeKey<TEntity>(IEnumerable<KeyValuePair<string, object>> fields)
+        {
+            return GetTypeKey(typeof(TEntity), fields);
+        }
+
+        private static string GetTypeKey(Type entityType, IEnumerable<KeyValuePair<string, object>> fields)
         {
 
             var fieldsKey = fields.Aggregate(string.Empty, (current, field) =>
@@ -79,7 +90,7 @@ private static string GetTypeKey<TEntity>(IEnumerable<KeyValuePair<string, objec
                 }
                 return current;
             });
-            return typeof(TEntity).FullName + getHash(fieldsKey);
+            return entityType.FullName + getHash(fieldsKey);
         }
         private static string getHash(string text)
         {
@@ -96,18 +107,17 @@ private static string getHash(string text)
 
     public static class SelectHelper
     {
-        public static Expression<Func<TEntity, object>> GetSelector<TEntity>(IEnumerable<SelectColumn> columns)
+        public static Expression<Func<TEntity, TResult>> GetSelector<TEntity, TResult>(IEnumerable<SelectColumn> columns, AutoQueryableProfile profile)
         {
             Dictionary<string, Expression> memberExpressions = new Dictionary<string, Expression>();
 
             ParameterExpression parameter = Expression.Parameter(typeof(TEntity), "p");
 
-            MemberInitExpression memberInit = InitType<TEntity>(columns, parameter);
-            return Expression.Lambda<Func<TEntity, object>>(memberInit, parameter);
-
+            MemberInitExpression memberInit = InitType<TEntity>(columns, parameter, profile);
+            return Expression.Lambda<Func<TEntity, TResult>>(memberInit, parameter);
         }
 
-        private static Expression GetMemberExpression<TEntity>(Expression parent, SelectColumn column, bool isLambdaBody = false)
+        private static Expression GetMemberExpression<TEntity>(Expression parent, SelectColumn column, AutoQueryableProfile profile, bool isLambdaBody = false)
         {
             bool isCollection = parent.Type.IsEnumerableButNotString();
             // If the current column has no sub column, return the final property.
@@ -133,7 +143,7 @@ private static Expression GetMemberExpression<TEntity>(Expression parent, Select
                 if (ex.Type.IsEnumerableButNotString())
                 {
                     ParameterExpression param = ex.CreateParameterFromGenericType();
-                    Expression lambdaBody = GetMemberExpression<TEntity>(param, column, true);
+                    Expression lambdaBody = GetMemberExpression<TEntity>(param, column, profile, true);
                     return ex.CreateSelect(lambdaBody, param);
                 }
                 else
@@ -142,7 +152,7 @@ private static Expression GetMemberExpression<TEntity>(Expression parent, Select
                 }
             }
 
-            return InitType<TEntity>(column.SubColumns, nextParent);
+            return InitType<TEntity>(column.SubColumns, nextParent, profile);
         }
 
         
@@ -167,20 +177,28 @@ private static Dictionary<string, object> GetTypeProperties(Dictionary<string, E
             });
         }
 
-        public static MemberInitExpression InitType<TEntity>(IEnumerable<SelectColumn> columns, Expression node)
+        public static MemberInitExpression InitType<TEntity>(IEnumerable<SelectColumn> columns, Expression node, AutoQueryableProfile profile)
         {
             var expressions = new Dictionary<string, Expression>();
             foreach (SelectColumn subColumn in columns)
             {
-                Expression ex = GetMemberExpression<TEntity>(node, subColumn);
+                Expression ex = GetMemberExpression<TEntity>(node, subColumn, profile);
                 expressions.Add(subColumn.Name, ex);
             }
 
-            var properties = GetTypeProperties(expressions);
+            Type type = null;
+            if (profile.UseBaseType)
+            {
+                type = node.Type;
+            }
+            else
+            {
+                var properties = GetTypeProperties(expressions);
+                type = RuntimeTypeBuilder.GetRuntimeType(node.Type, properties);
+            }
+            NewExpression ctor = Expression.New(type);
 
-            Type dynamicType = RuntimeTypeBuilder.GetRuntimeType<TEntity>(properties);
-            NewExpression ctor = Expression.New(dynamicType);
-            return Expression.MemberInit(ctor, expressions.Select(p => Expression.Bind(dynamicType.GetProperty(p.Key), p.Value)));
+            return Expression.MemberInit(ctor, expressions.Select(p => Expression.Bind(type.GetProperty(p.Key, BindingFlags.IgnoreCase | BindingFlags.Public | BindingFlags.Instance), p.Value)));
         }
     }
 }
diff --git a/test/AutoQueryable.UnitTest/AutoQueryable.UnitTest.csproj b/test/AutoQueryable.UnitTest/AutoQueryable.UnitTest.csproj
@@ -1,24 +1,19 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
-
-  <PropertyGroup>    
+  <PropertyGroup>
     <TargetFramework>netcoreapp2.0</TargetFramework>
   </PropertyGroup>
-
   <ItemGroup>
     <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="2.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="2.0.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.3.0" />
     <PackageReference Include="MSTest.TestAdapter" Version="1.2.0" />
     <PackageReference Include="MSTest.TestFramework" Version="1.2.0" />
   </ItemGroup>
-
   <ItemGroup>
     <ProjectReference Include="..\..\src\AutoQueryable.Core\AutoQueryable.Core.csproj" />
     <ProjectReference Include="..\..\src\AutoQueryable\AutoQueryable.csproj" />
   </ItemGroup>
-
   <ItemGroup>
     <Service Include="{82a7f48d-3b50-4b1e-b82e-3ada8210c358}" />
   </ItemGroup>
-
-</Project>
+</Project>
diff --git a/test/AutoQueryable.UnitTest/BaseTypeTest.cs b/test/AutoQueryable.UnitTest/BaseTypeTest.cs
@@ -0,0 +1,26 @@
+﻿using System.Linq;
+using AutoQueryable.Core.Models;
+using AutoQueryable.Extensions;
+using AutoQueryable.UnitTest.Mock;
+using AutoQueryable.UnitTest.Mock.Entities;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System.Collections.Generic;
+
+namespace AutoQueryable.UnitTest
+{
+    [TestClass]
+    public class BaseTypeTest
+    {
+        [TestMethod]
+        public void SelectAllProducts()
+        {
+            using (AutoQueryableContext context = new AutoQueryableContext())
+            {
+                DataInitializer.InitializeSeed(context);
+                var query = context.Product.AutoQueryable("", new AutoQueryableProfile {UseBaseType = true});
+                IEnumerable<Product> pp = query as IEnumerable<Product>;
+                Assert.AreEqual(pp.Count(), DataInitializer.ProductSampleCount);
+            }
+        }
+    }
+}
diff --git a/test/AutoQueryable.UnitTest/Mock/Entities/ProductModel.cs b/test/AutoQueryable.UnitTest/Mock/Entities/ProductModel.cs
@@ -16,6 +16,6 @@ public ProductModel()
         public Guid Rowguid { get; set; }
         public DateTime ModifiedDate { get; set; }
 
-        public virtual ICollection<Product> Product { get; set; }
+        public virtual IEnumerable<Product> Product { get; set; }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,6 @@ public ProductModel()`
`16`	`16`	`public Guid Rowguid { get; set; }`
`17`	`17`	`public DateTime ModifiedDate { get; set; }`
`18`	`18`
`19`		`- public virtual ICollection<Product> Product { get; set; }`
	`19`	`+ public virtual IEnumerable<Product> Product { get; set; }`
`20`	`20`	`}`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,6 @@ public void ConfigureServices(IServiceCollection services)`
`20`	`20`	`.AddJsonFormatters(settings =>`
`21`	`21`	`{`
`22`	`22`	`settings.ContractResolver = new CamelCasePropertyNamesContractResolver();`
`23`		`- settings.NullValueHandling = NullValueHandling.Ignore;`
`24`	`23`	`settings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;`
`25`	`24`	`});`
`26`	`25`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,8 @@ public class AutoQueryableAttribute : ActionFilterAttribute`
`41`	`41`
`42`	`42`	`public ProviderType ProviderType { get; set; }`
`43`	`43`
	`44`	`+ public bool UseBaseType { get; set; }`
	`45`	`+`
`44`	`46`	`public override void OnActionExecuted(ActionExecutedContext context)`
`45`	`47`	`{`
`46`	`48`	`dynamic query = ((ObjectResult)context.Result).Value;`
`@@ -65,7 +67,8 @@ public override void OnActionExecuted(ActionExecutedContext context)`
`65`	`67`	`MaxToTake = MaxToTake,`
`66`	`68`	`MaxToSkip = MaxToSkip,`
`67`	`69`	`MaxDepth = MaxDepth,`
`68`		`- ProviderType = ProviderType`
	`70`	`+ ProviderType = ProviderType,`
	`71`	`+ UseBaseType = UseBaseType`
`69`	`72`	`}));`
`70`	`73`	`}`
`71`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,5 +36,7 @@ public class AutoQueryableProfile`
`36`	`36`	`public int? MaxDepth { get; set; }`
`37`	`37`
`38`	`38`	`public ProviderType ProviderType { get; set; } = ProviderType.Default;`
	`39`	`+`
	`40`	`+ public bool UseBaseType { get; set; }`
`39`	`41`	`}`
`40`	`42`	`}`