chore: rename base document parser and builder

Author: maurei

benchmarks/Serialization/JsonApiSerializer_Benchmarks.cs

@@ -36,7 +36,7 @@
 
 //            var genericProcessorFactoryMock = new Mock<IGenericProcessorFactory>();
 
-//            var documentBuilder = new DocumentBuilder(jsonApiContextMock.Object);
+//            var documentBuilder = new BaseDocumentBuilder(jsonApiContextMock.Object);
 //            _jsonApiSerializer = new JsonApiSerializer(jsonApiContextMock.Object, documentBuilder);
 //        }
 

src/JsonApiDotNetCore/Serialization/Client/RequestSerializer.cs

@@ -11,11 +11,11 @@
 namespace JsonApiDotNetCore.Serialization.Client
 {
     /// <summary>
-    /// Client serializer implementation of <see cref="DocumentBuilder"/>
+    /// Client serializer implementation of <see cref="BaseDocumentBuilder"/>
     /// Note that this implementation does not override the default implementation
     /// of <see cref="ResourceObjectBuilder.GetRelationshipData"/>.
     /// </summary>
-    public class RequestSerializer : DocumentBuilder, IRequestSerializer
+    public class RequestSerializer : BaseDocumentBuilder, IRequestSerializer
     {
         private readonly Dictionary<Type, List<AttrAttribute>> _attributesToSerializeCache;
         private readonly Dictionary<Type, List<RelationshipAttribute>> _relationshipsToSerializeCache;

src/JsonApiDotNetCore/Serialization/Client/ResponseDeserializer.cs

@@ -9,9 +9,9 @@
 namespace JsonApiDotNetCore.Serialization.Client
 {
     /// <summary>
-    /// Client deserializer implementation of the <see cref="DocumentParser"/>
+    /// Client deserializer implementation of the <see cref="BaseDocumentParser"/>
     /// </summary>
-    public class ResponseDeserializer : DocumentParser, IResponseDeserializer
+    public class ResponseDeserializer : BaseDocumentParser, IResponseDeserializer
     {
         public ResponseDeserializer(IContextEntityProvider provider) : base(provider) { }
 

src/JsonApiDotNetCore/Serialization/Common/DocumentParser.cs renamed to src/JsonApiDotNetCore/Serialization/Common/BaseDocumentParser.cs

@@ -16,12 +16,12 @@ namespace JsonApiDotNetCore.Serialization
     /// Abstract base class for deserialization. Deserializes JSON content into <see cref="Document"/>s
     /// And constructs instances of the resource(s) in the document body.
     /// </summary>
-    public abstract class DocumentParser
+    public abstract class BaseDocumentParser
     {
         protected readonly IContextEntityProvider _provider;
         protected Document _document;
 
-        protected DocumentParser(IContextEntityProvider provider)
+        protected BaseDocumentParser(IContextEntityProvider provider)
         {
             _provider = provider;
         }

src/JsonApiDotNetCore/Serialization/Common/DocumentBuilder.cs

@@ -9,9 +9,9 @@ namespace JsonApiDotNetCore.Serialization
     /// Abstract base class for serialization that extends <see cref="ResourceObjectBuilder"/>.
     /// Converts entities in to <see cref="ResourceObject"/>s and wraps them in a <see cref="Document"/>.
     /// </summary>
-    public abstract class DocumentBuilder : ResourceObjectBuilder
+    public abstract class BaseDocumentBuilder : ResourceObjectBuilder
     {
-        protected DocumentBuilder(IResourceGraph resourceGraph, IContextEntityProvider provider, SerializerSettings behaviour) : base(resourceGraph, provider, behaviour) { }
+        protected BaseDocumentBuilder(IResourceGraph resourceGraph, IContextEntityProvider provider, SerializerSettings behaviour) : base(resourceGraph, provider, behaviour) { }
 
         /// <summary>
         /// Builds a <see cref="Document"/> for <paramref name="entity"/>.

src/JsonApiDotNetCore/Serialization/Server/RequestDeserializer.cs

@@ -5,9 +5,9 @@
 namespace JsonApiDotNetCore.Serialization.Server
 {
     /// <summary>
-    /// Server deserializer implementation of the <see cref="DocumentParser"/>
+    /// Server deserializer implementation of the <see cref="BaseDocumentParser"/>
     /// </summary>
-    public class RequestDeserializer : DocumentParser, IJsonApiDeserializer
+    public class RequestDeserializer : BaseDocumentParser, IJsonApiDeserializer
     {
         private readonly ITargetedFields  _targetedFields;
 

src/JsonApiDotNetCore/Serialization/Server/ResponseSerializer.cs

@@ -13,7 +13,7 @@
 namespace JsonApiDotNetCore.Serialization.Server
 {
     /// <summary>
-    /// Server serializer implementation of <see cref="DocumentBuilder"/>
+    /// Server serializer implementation of <see cref="BaseDocumentBuilder"/>
     /// </summary>
     /// <remarks>
     /// Because in JsonApiDotNetCore every json:api request is associated with exactly one
@@ -23,7 +23,7 @@ namespace JsonApiDotNetCore.Serialization.Server
     /// </remarks>
     /// <typeparam name="TResource">Type of the resource associated with the scope of the request
     /// for which this serializer is used.</typeparam>
-    public class ResponseSerializer<TResource> : DocumentBuilder, IJsonApiSerializer, IJsonApiDefaultSerializer
+    public class ResponseSerializer<TResource> : BaseDocumentBuilder, IJsonApiSerializer, IJsonApiDefaultSerializer
         where TResource : class, IIdentifiable
     {
         private readonly Dictionary<Type, List<AttrAttribute>> _attributesToSerializeCache = new Dictionary<Type, List<AttrAttribute>>();

src/JsonApiDotNetCore/Serialization/wiki.md

@@ -10,14 +10,14 @@ Throughout the document and the code when referring to fields, members, object t
 `Document` class, [see document spec](https://jsonapi.org/format/#document-structure).
 
 ## Deserialization
-The previous `JsonApiDeSerializer` implementation is now split into a `RequestDeserializer` and `ResponseDeserializer`. Both inherit from `DocumentParser` which does the shared parsing.
+The previous `JsonApiDeSerializer` implementation is now split into a `RequestDeserializer` and `ResponseDeserializer`. Both inherit from `BaseDocumentParser` which does the shared parsing.
 
-#### DocumentParser
+#### BaseDocumentParser
 Responsible for 
 - Converting the serialized string content into an intance of the `Document` class. 
 - Building instances of the corresponding resource class (eg `Article`) by going through the document's primary data (`Document.Data`, [see primary data spec](https://jsonapi.org/format/#document-top-level)).
 
-Responsibility of any implementation-specific parsing is shifted through the abstract `DocumentParser.AfterProcessField()` method. This method is fired once each time after a `AttrAttribute` or `RelationshipAttribute` is processed. It allows a implementation of `DocumentParser` to intercept the parsing and add steps that are only required for clients/servers.
+Responsibility of any implementation-specific parsing is shifted through the abstract `BaseDocumentParser.AfterProcessField()` method. This method is fired once each time after a `AttrAttribute` or `RelationshipAttribute` is processed. It allows a implementation of `BaseDocumentParser` to intercept the parsing and add steps that are only required for clients/servers.
 
 #### ResponseDeserializer
 The client deserializer complements the base deserialization  by
@@ -30,7 +30,7 @@ For server-side parsing, no extra parsing needs to be done after the base deseri
 * The `AfterProcessField` method is overriden so that every attribute and relationship is registered with the `ITargetedFields` service after it is processed.
 
 ## Serialization
-Like with the deserializers, `JsonApiSerializer` is now split up into a `ResponseSerializer` and `RequestSerializer`. Both inherit from a shared `DocumentBuilder` class. Additionally, `DocumentBuilder` inherits from `ResourceObjectBuilder`, which is extended by `IncludedResourceObjectBuilder`.
+Like with the deserializers, `JsonApiSerializer` is now split up into a `ResponseSerializer` and `RequestSerializer`. Both inherit from a shared `BaseDocumentBuilder` class. Additionally, `BaseDocumentBuilder` inherits from `ResourceObjectBuilder`, which is extended by `IncludedResourceObjectBuilder`.
 
 ### ResourceObjectBuilder
 At the core of serialization is the `ResourceObject` class [see resource object spec](https://jsonapi.org/format/#document-resource-objects).
@@ -44,7 +44,7 @@ Additionally, client and server serializers also differ in how relationship memb
 
 This time, the `GetRelationshipData()` method is not abstract, but virtual with a default implementation. This default implementation is to just create a `RelationshipData` with primary data (like `{"related-foo": { "data": { "id": 1" "type": "foobar"}}}`). Some implementations (server, included builder) need additional logic, others don't (client).
 
-### DocumentBuilder
+### BaseDocumentBuilder
 Responsible for
 - Calling the base resource object serialization for one (or many) entities and wrapping the result in a `Document`.
 
@@ -70,7 +70,7 @@ The server serializer is also responsible for adding top-level meta data and lin
 
 
 ### IncludedResourceObjectBuilder
-Responsible for building the *included member* of a `Document`. Note that `IncludedResourceObjectBuilder` extends `ResourceObjectBuilder` and not `DocumentBuilder` because it does not need to build an entire document but only resource objects.
+Responsible for building the *included member* of a `Document`. Note that `IncludedResourceObjectBuilder` extends `ResourceObjectBuilder` and not `BaseDocumentBuilder` because it does not need to build an entire document but only resource objects.
 
 Relationship *inclusion chains* are at the core of building the included member. For example, consider the request `articles?included=author.blogs.reviewers.favorite-food,reviewer.blogs.author.favorite-song`. It contains the following (complex) inclusion chains:
 1. `author.blogs.reviewers.favorite-food`

src/JsonApiDotNetCore/Services/Operations/Processors/CreateOpProcessor.cs

@@ -23,13 +23,13 @@ public class CreateOpProcessor<T>
         public CreateOpProcessor(
             ICreateService<T, int> service,
             IOperationsDeserializer deserializer,
-            IDocumentBuilder documentBuilder,
+            IBaseDocumentBuilder documentBuilder,
             IResourceGraph resourceGraph
         ) : base(service, deserializer, documentBuilder, resourceGraph)
         { }
     }
 
-    public interface IDocumentBuilder
+    public interface IBaseDocumentBuilder
     {
         ResourceObject GetData(ContextEntity contextEntity, IIdentifiable singleResource);
     }
@@ -39,13 +39,13 @@ public class CreateOpProcessor<T, TId> : ICreateOpProcessor<T, TId>
     {
         private readonly ICreateService<T, TId> _service;
         private readonly IOperationsDeserializer _deserializer;
-        private readonly IDocumentBuilder _documentBuilder;
+        private readonly IBaseDocumentBuilder _documentBuilder;
         private readonly IResourceGraph _resourceGraph;
 
         public CreateOpProcessor(
             ICreateService<T, TId> service,
             IOperationsDeserializer deserializer,
-            IDocumentBuilder documentBuilder,
+            IBaseDocumentBuilder documentBuilder,
             IResourceGraph resourceGraph)
         {
             _service = service;

src/JsonApiDotNetCore/Services/Operations/Processors/GetOpProcessor.cs

@@ -38,7 +38,7 @@ public GetOpProcessor(
             IGetByIdService<T, int> getById,
             IGetRelationshipService<T, int> getRelationship,
             IOperationsDeserializer deserializer,
-            IDocumentBuilder documentBuilder,
+            IBaseDocumentBuilder documentBuilder,
             IResourceGraph resourceGraph
         ) : base(getAll, getById, getRelationship, deserializer, documentBuilder, resourceGraph)
         { }
@@ -52,7 +52,7 @@ public class GetOpProcessor<T, TId> : IGetOpProcessor<T, TId>
         private readonly IGetByIdService<T, TId> _getById;
         private readonly IGetRelationshipService<T, TId> _getRelationship;
         private readonly IOperationsDeserializer _deserializer;
-        private readonly IDocumentBuilder _documentBuilder;
+        private readonly IBaseDocumentBuilder _documentBuilder;
         private readonly IResourceGraph _resourceGraph;
 
         /// <inheritdoc />
@@ -61,7 +61,7 @@ public GetOpProcessor(
             IGetByIdService<T, TId> getById,
             IGetRelationshipService<T, TId> getRelationship,
             IOperationsDeserializer deserializer,
-            IDocumentBuilder documentBuilder,
+            IBaseDocumentBuilder documentBuilder,
             IResourceGraph resourceGraph)
         {
             _getAll = getAll;

src/JsonApiDotNetCore/Services/Operations/Processors/RemoveOpProcessor.cs

@@ -22,7 +22,7 @@ public class RemoveOpProcessor<T> : RemoveOpProcessor<T, int>, IRemoveOpProcesso
         public RemoveOpProcessor(
             IDeleteService<T, int> service,
             IOperationsDeserializer deserializer,
-            IDocumentBuilder documentBuilder,
+            IBaseDocumentBuilder documentBuilder,
             IResourceGraph resourceGraph
         ) : base(service, deserializer, documentBuilder, resourceGraph)
         { }
@@ -33,13 +33,13 @@ public class RemoveOpProcessor<T, TId> : IRemoveOpProcessor<T, TId>
     {
         private readonly IDeleteService<T, TId> _service;
         private readonly IOperationsDeserializer _deserializer;
-        private readonly IDocumentBuilder _documentBuilder;
+        private readonly IBaseDocumentBuilder _documentBuilder;
         private readonly IResourceGraph _resourceGraph;
 
         public RemoveOpProcessor(
             IDeleteService<T, TId> service,
             IOperationsDeserializer deserializer,
-            IDocumentBuilder documentBuilder,
+            IBaseDocumentBuilder documentBuilder,
             IResourceGraph resourceGraph)
         {
             _service = service;

src/JsonApiDotNetCore/Services/Operations/Processors/UpdateOpProcessor.cs

@@ -22,7 +22,7 @@ public class UpdateOpProcessor<T> : UpdateOpProcessor<T, int>, IUpdateOpProcesso
         public UpdateOpProcessor(
             IUpdateService<T, int> service,
             IOperationsDeserializer deserializer,
-            IDocumentBuilder documentBuilder,
+            IBaseDocumentBuilder documentBuilder,
             IResourceGraph resourceGraph
         ) : base(service, deserializer, documentBuilder, resourceGraph)
         { }
@@ -33,13 +33,13 @@ public class UpdateOpProcessor<T, TId> : IUpdateOpProcessor<T, TId>
     {
         private readonly IUpdateService<T, TId> _service;
         private readonly IOperationsDeserializer _deserializer;
-        private readonly IDocumentBuilder _documentBuilder;
+        private readonly IBaseDocumentBuilder _documentBuilder;
         private readonly IResourceGraph _resourceGraph;
 
         public UpdateOpProcessor(
             IUpdateService<T, TId> service,
             IOperationsDeserializer deserializer,
-            IDocumentBuilder documentBuilder,
+            IBaseDocumentBuilder documentBuilder,
             IResourceGraph resourceGraph)
         {
             _service = service;

test/UnitTests/Builders/DocumentBuilderBehaviour_Tests.cs

@@ -7,7 +7,7 @@
 
 //namespace UnitTests.Builders
 //{
-//    public class DocumentBuilderBehaviour_Tests
+//    public class BaseDocumentBuilderBehaviour_Tests
 //    {
 
 //        [Theory]
@@ -60,8 +60,8 @@
 //            var httpContextAccessorMock = new Mock<IHttpContextAccessor>();
 //            httpContextAccessorMock.SetupGet(m => m.HttpContext).Returns(httpContext);
 
-//            var sut = new DocumentBuilderOptionsProvider(jsonApiContextMock.Object, httpContextAccessorMock.Object);
-//            var documentBuilderOptions = sut.GetDocumentBuilderOptions();
+//            var sut = new BaseDocumentBuilderOptionsProvider(jsonApiContextMock.Object, httpContextAccessorMock.Object);
+//            var documentBuilderOptions = sut.GetBaseDocumentBuilderOptions();
 
 //            Assert.Equal(omitsNulls, documentBuilderOptions.OmitNullValuedAttributes);
 //        }