Merge pull request #574 from json-api-dotnet/feat/queryparams

Query Parameter Services

Author: wisepotato

.editorconfig

@@ -12,3 +12,14 @@ charset = utf-8
 
 [*.{csproj,props}]
 indent_size = 2
+
+[*.{cs,vb}]
+dotnet_naming_rule.private_members_with_underscore.symbols  = private_fields
+dotnet_naming_rule.private_members_with_underscore.style    = prefix_underscore
+dotnet_naming_rule.private_members_with_underscore.severity = suggestion
+
+dotnet_naming_symbols.private_fields.applicable_kinds           = field
+dotnet_naming_symbols.private_fields.applicable_accessibilities = private
+
+dotnet_naming_style.prefix_underscore.capitalization = camel_case
+dotnet_naming_style.prefix_underscore.required_prefix = _

benchmarks/Query/QueryParser_Benchmarks.cs

@@ -57,7 +57,7 @@ private void Run(int iterations, Action action) {
         }
 
         // this facade allows us to expose and micro-benchmark protected methods
-        private class BenchmarkFacade : QueryParser {
+        private class BenchmarkFacade : QueryParameterDiscovery {
             public BenchmarkFacade(
                 IRequestContext currentRequest,
                 JsonApiOptions options) : base(currentRequest, options) { }

benchmarks/RequestMiddleware/ContainsMediaTypeParameters_Benchmarks.cs

@@ -14,7 +14,7 @@ public class ContainsMediaTypeParameters_Benchmarks
 
         [Benchmark]
         public void Current() 
-            => JsonApiDotNetCore.Middleware.RequestMiddleware.ContainsMediaTypeParameters(MEDIA_TYPE);
+            => JsonApiDotNetCore.Middleware.CurrentRequestMiddleware.ContainsMediaTypeParameters(MEDIA_TYPE);
 
         private bool UsingSplitImpl(string mediaType)
         {

src/Examples/JsonApiDotNetCoreExample/Properties/launchSettings.json

@@ -22,7 +22,8 @@
       "launchUrl": "http://localhost:5000/api/values",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
-      }
+      },
+      "applicationUrl": "http://localhost:5000/"
     }
   }
 }

src/Examples/JsonApiDotNetCoreExample/Resources/UserResource.cs

@@ -24,13 +24,13 @@ public override QueryFilters GetQueryFilters()
 
         private IQueryable<User> FirstCharacterFilter(IQueryable<User> users, FilterQuery filterQuery)
         {
-          switch(filterQuery.Operation)
-          {
-            case "lt":
-              return users.Where(u => u.Username[0] < filterQuery.Value[0]);
-            default:
-              return users.Where(u => u.Username[0] == filterQuery.Value[0]);
-          }
+            switch (filterQuery.Operation)
+            {
+                case "lt":
+                    return users.Where(u => u.Username[0] < filterQuery.Value[0]);
+                default:
+                    return users.Where(u => u.Username[0] == filterQuery.Value[0]);
+            }
         }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Services/CustomArticleService.cs

@@ -16,12 +16,19 @@ namespace JsonApiDotNetCoreExample.Services
 {
     public class CustomArticleService : EntityResourceService<Article>
     {
-        public CustomArticleService(IEntityRepository<Article, int> repository, IJsonApiOptions options,
-                                    ITargetedFields updatedFields, ICurrentRequest currentRequest,
-                                    IIncludeService includeService, ISparseFieldsService sparseFieldsService,
-                                    IPageQueryService pageManager, IResourceGraph resourceGraph,
-                                    IResourceHookExecutor hookExecutor = null, ILoggerFactory loggerFactory = null)
-            : base(repository, options, updatedFields, currentRequest, includeService, sparseFieldsService, pageManager, resourceGraph, hookExecutor, loggerFactory)
+        public CustomArticleService(ISortService sortService,
+                                    IFilterService filterService,
+                                    IEntityRepository<Article, int> repository,
+                                    IJsonApiOptions options,
+                                    ICurrentRequest currentRequest,
+                                    IIncludeService includeService,
+                                    ISparseFieldsService sparseFieldsService,
+                                    IPageService pageManager,
+                                    IResourceGraph resourceGraph,
+                                    IResourceHookExecutor hookExecutor = null,
+                                    ILoggerFactory loggerFactory = null)
+            : base(sortService, filterService, repository, options, currentRequest, includeService, sparseFieldsService,
+                   pageManager, resourceGraph, hookExecutor, loggerFactory)
         {
         }
 

src/Examples/NoEntityFrameworkExample/Properties/launchSettings.json

@@ -8,16 +8,20 @@
     }
   },
   "profiles": {
+    "NoEntityFrameworkExample": {
+      "commandName": "Project",
+      "launchBrowser": true,
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      },
+      "applicationUrl": "http://localhost:5000/"
+    },
     "IIS Express": {
       "commandName": "IISExpress",
       "launchBrowser": true,
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       }
-    },
-    "NoEntityFrameworkExample": {
-      "commandName": "Project",
-      "environmentVariables": {}
     }
   }
 }

src/Examples/ReportsExample/Properties/launchSettings.json

@@ -8,20 +8,20 @@
     }
   },
   "profiles": {
-    "IIS Express": {
-      "commandName": "IISExpress",
-      "launchBrowser": true,
-      "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
-      }
-    },
     "ReportsExample": {
       "commandName": "Project",
       "launchBrowser": true,
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       },
       "applicationUrl": "http://localhost:55654/"
+    },
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
     }
   }
 }

src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs

@@ -1,4 +1,3 @@
-using System.Collections.Generic;
 using System.Threading.Tasks;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Extensions;
@@ -51,13 +50,8 @@ public BaseJsonApiController(
             _update = resourceService;
             _updateRelationships = resourceService;
             _delete = resourceService;
-            ParseQueryParams();
         }
 
-        private void ParseQueryParams()
-        {
-
-        }
 
         public BaseJsonApiController(
             IJsonApiOptions jsonApiOptions,

src/JsonApiDotNetCore/Controllers/DisableQueryAttribute.cs

@@ -3,12 +3,27 @@
 namespace JsonApiDotNetCore.Controllers
 {
     public class DisableQueryAttribute : Attribute
-    { 
+    {
+        /// <summary>
+        /// Disabled one of the native query parameters for a controller.
+        /// </summary>
+        /// <param name="queryParams"></param>
         public DisableQueryAttribute(QueryParams queryParams)
         {
-            QueryParams = queryParams;
+            QueryParams = queryParams.ToString("G").ToLower();
         }
 
-        public QueryParams QueryParams { get; set; }
+        /// <summary>
+        /// It is allowed to use strings to indicate which query parameters
+        /// should be disabled, because the user may have defined a custom
+        /// query parameter that is not included in the  <see cref="QueryParams"/> enum.
+        /// </summary>
+        /// <param name="customQueryParams"></param>
+        public DisableQueryAttribute(string customQueryParams)
+        {
+            QueryParams = customQueryParams.ToLower();
+        }
+
+        public string QueryParams { get; }
     }
 }