chore: scaffolded required query parameter service

Author: maurei

src/JsonApiDotNetCore/Extensions/IServiceCollectionExtensions.cs

@@ -204,7 +204,7 @@ public static void AddJsonApiInternals(
             services.AddScoped<ISparseFieldsService, SparseFieldsService>();
             services.AddScoped<ITargetedFields, TargetedFields>();
             services.AddScoped<IFieldsExplorer, FieldsExplorer>();
-            services.AddScoped<IAttributeBehaviourService, AttributeBehaviourService>();
+            services.AddScoped<IAttributeBehaviourService, OmitNullService>();
             services.AddScoped<IFieldsToSerialize, FieldsToSerialize>();
 
             AddServerSerialization(services);
@@ -248,8 +248,8 @@ public static void AddClientSerialization(this IServiceCollection services)
 
             services.AddScoped<IRequestSerializer>(sp =>
             {
-               var resourceObjectBuilder = new ResourceObjectBuilder(sp.GetService<IResourceGraph>(), sp.GetService<IContextEntityProvider>(), sp.GetService<IResourceObjectBuilderSettingsProvider>().Get());
-               return new RequestSerializer(sp.GetService<IFieldsExplorer>(), sp.GetService<IResourceGraph>(), resourceObjectBuilder);
+                var resourceObjectBuilder = new ResourceObjectBuilder(sp.GetService<IResourceGraph>(), sp.GetService<IContextEntityProvider>(), sp.GetService<IResourceObjectBuilderSettingsProvider>().Get());
+                return new RequestSerializer(sp.GetService<IFieldsExplorer>(), sp.GetService<IResourceGraph>(), resourceObjectBuilder);
             });
 
         }

src/JsonApiDotNetCore/JsonApiDotNetCore.csproj

@@ -46,15 +46,15 @@
   </ItemGroup>
   <ItemGroup>
     <Folder Include="Models\JsonApiDocuments\" />
-    <Folder Include="Query\" />
+    <Folder Include="QueryParameters\" />
     <Folder Include="Internal\Exceptions\" />
     <Folder Include="Models\Annotation\" />
     <Folder Include="Serialization\Common\" />
     <Folder Include="Serialization\Client\" />
     <Folder Include="Serialization\Server\" />
     <Folder Include="Serialization\Server\Builders\" />
-    <Folder Include="Query\Contracts\" />
-    <Folder Include="Query\Common\" />
+    <Folder Include="QueryParameters\Contracts\" />
+    <Folder Include="QueryParameters\Common\" />
     <Folder Include="Serialization\Server\Contracts\" />
   </ItemGroup>
 </Project>

src/JsonApiDotNetCore/Query/AttributeBehaviourService.cs

@@ -0,0 +1,27 @@
+using System.Text.RegularExpressions;
+
+namespace JsonApiDotNetCore.Query
+{
+    public abstract class QueryParameterService : IQueryParameterService
+    {
+
+        /// <summary>
+        /// By default, the name is derived from the implementing type.
+        /// </summary>
+        /// <example>
+        /// The following query param service will match the query  displayed in URL
+        /// `?include=some-relationship`
+        /// <code>public class IncludeService : QueryParameterService  { /* ... */  } </code>
+        /// </example>
+        public virtual string Name { get { return GetParameterNameFromType(); } }
+
+        /// <inheritdoc/>
+        public abstract void Parse(string value);
+
+        /// <summary>
+        /// Gets the query parameter name from the implementing class name. Trims "Service"
+        /// from the name if present.
+        /// </summary>
+        private string GetParameterNameFromType() => new Regex("Service$").Replace(GetType().Name, string.Empty);
+    }
+}

src/JsonApiDotNetCore/Query/Common/IQueryParameterService.cs renamed to src/JsonApiDotNetCore/QueryParameters/Common/IQueryParameterService.cs

@@ -15,6 +15,5 @@ public interface ISparseFieldsService
         /// <param name="relationship"></param>
         /// <returns></returns>
         List<AttrAttribute> Get(RelationshipAttribute relationship = null);
-        void Register(AttrAttribute selected, RelationshipAttribute relationship = null);
     }
 }

src/JsonApiDotNetCore/QueryParameters/Common/QueryParameterService.cs

@@ -0,0 +1,12 @@
+using System;
+
+namespace JsonApiDotNetCore.Query
+{
+    public class FilterService : QueryParameterService
+    {
+        public override void Parse(string value)
+        {
+            throw new NotImplementedException();
+        }
+    }
+}

src/JsonApiDotNetCore/Query/Contracts/IAttributeBehaviourService.cs renamed to src/JsonApiDotNetCore/QueryParameters/Contracts/IAttributeBehaviourService.cs

@@ -1,6 +1,5 @@
 using System.Collections.Generic;
 using System.Linq;
-using System.Text.RegularExpressions;
 using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Internal.Contracts;
 using JsonApiDotNetCore.Internal.Query;
@@ -10,29 +9,6 @@
 namespace JsonApiDotNetCore.Query
 {
 
-    public abstract class QueryParameterService : IQueryParameterService
-    {
-
-        /// <summary>
-        /// By default, the name is derived from the implementing type.
-        /// </summary>
-        /// <example>
-        /// The following query param service will match the query  displayed in URL
-        /// `?include=some-relationship`
-        /// <code>public class IncludeService : QueryParameterService  { /* ... */  } </code>
-        /// </example>
-        public virtual string Name { get { return GetParameterNameFromType(); } }
-
-        /// <inheritdoc/>
-        public abstract void Parse(string value);
-
-        /// <summary>
-        /// Gets the query parameter name from the implementing class name. Trims "Service"
-        /// from the name if present.
-        /// </summary>
-        private string GetParameterNameFromType() => new Regex("Service$").Replace(GetType().Name, string.Empty);
-    }
-
     public class IncludeService : QueryParameterService, IIncludeService
     {
         /// todo: make readonly

src/JsonApiDotNetCore/Query/Contracts/IIncludeService.cs renamed to src/JsonApiDotNetCore/QueryParameters/Contracts/IIncludeService.cs

@@ -0,0 +1,12 @@
+using System;
+
+namespace JsonApiDotNetCore.Query
+{
+    public class OmitDefaultService : QueryParameterService
+    {
+        public override void Parse(string value)
+        {
+            throw new NotImplementedException();
+        }
+    }
+}

src/JsonApiDotNetCore/Query/Contracts/IPageService.cs renamed to src/JsonApiDotNetCore/QueryParameters/Contracts/IPageService.cs

@@ -0,0 +1,12 @@
+using System;
+
+namespace JsonApiDotNetCore.Query
+{
+    public class OmitNullService : QueryParameterService
+    {
+        public override void Parse(string value)
+        {
+            throw new NotImplementedException();
+        }
+    }
+}

src/JsonApiDotNetCore/Query/Contracts/ISparseFieldsService.cs renamed to src/JsonApiDotNetCore/QueryParameters/Contracts/ISparseFieldsService.cs

@@ -5,7 +5,7 @@
 namespace JsonApiDotNetCore.Query
 
 {
-    public class PageService : IPageQueryService
+    public class PageService : QueryParameterService, IPageQueryService
     {
         private IJsonApiOptions _options;
 
@@ -25,6 +25,12 @@ public PageService(IJsonApiOptions options)
         public int CurrentPage { get; set; }
         /// <inheritdoc/>
         public int TotalPages => (TotalRecords == null) ? -1 : (int)Math.Ceiling(decimal.Divide(TotalRecords.Value, PageSize));
+
+        public override void Parse(string value)
+        {
+            throw new NotImplementedException();
+        }
+
         /// <inheritdoc/>
         public bool ShouldPaginate()
         {

src/JsonApiDotNetCore/QueryParameters/FilterService.cs

@@ -0,0 +1,12 @@
+using System;
+
+namespace JsonApiDotNetCore.Query
+{
+    public class SortService: QueryParameterService
+    {
+        public override void Parse(string value)
+        {
+            throw new NotImplementedException();
+        }
+    }
+}

src/JsonApiDotNetCore/Query/IncludeService.cs renamed to src/JsonApiDotNetCore/QueryParameters/IncludeService.cs

@@ -5,7 +5,7 @@ namespace JsonApiDotNetCore.Query
 
 {
     /// <inheritdoc/>
-    public class SparseFieldsService : ISparseFieldsService
+    public class SparseFieldsService : QueryParameterService, ISparseFieldsService
     {
         /// <summary>
         /// The selected fields for the primary resource of this request.
@@ -33,7 +33,8 @@ public List<AttrAttribute> Get(RelationshipAttribute relationship = null)
         }
 
         /// <inheritdoc/>
-        public void Register(AttrAttribute selected, RelationshipAttribute relationship = null)
+        //public override Parse(AttrAttribute selected, RelationshipAttribute relationship = null)
+        public override void Parse(string value)
         {
             if (relationship == null)
             {