Moved null attribute handling behind IDocumentBuilderBehavior api'

Author: lheiskan

src/JsonApiDotNetCore/Builders/DocumentBuilder.cs

@@ -13,6 +13,7 @@ public class DocumentBuilder : IDocumentBuilder
         private readonly IJsonApiContext _jsonApiContext;
         private readonly IContextGraph _contextGraph;
         private readonly IRequestMeta _requestMeta;
+        private readonly DocumentBuilderOptions _documentBuilderOptions;
 
         public DocumentBuilder(IJsonApiContext jsonApiContext)
         {
@@ -27,6 +28,14 @@ public DocumentBuilder(IJsonApiContext jsonApiContext, IRequestMeta requestMeta)
             _requestMeta = requestMeta;
         }
 
+        public DocumentBuilder(IJsonApiContext jsonApiContext, IRequestMeta requestMeta, IDocumentBuilderBehavior documentBuilderBehavior)
+        {
+            _jsonApiContext = jsonApiContext;
+            _contextGraph = jsonApiContext.ContextGraph;
+            _requestMeta = requestMeta;
+            _documentBuilderOptions = documentBuilderBehavior?.GetDocumentBuilderOptions() ?? new DocumentBuilderOptions();
+        }
+
         public Document Build(IIdentifiable entity)
         {
             var contextEntity = _contextGraph.GetContextEntity(entity.GetType());
@@ -121,7 +130,7 @@ private DocumentData GetData(ContextEntity contextEntity, IIdentifiable entity)
                 if (ShouldIncludeAttribute(attr))
                 {
                     var value = attr.GetValue(entity);
-                    if (value != null || ShouldIncludeNullValuedAttributes())
+                    if (value != null || _documentBuilderOptions.IncludeNullAttributes)
                     {
                         data.Attributes.Add(attr.PublicAttributeName, value);
                     }
@@ -134,15 +143,6 @@ private DocumentData GetData(ContextEntity contextEntity, IIdentifiable entity)
             return data;
         }
 
-        private bool ShouldIncludeNullValuedAttributes()
-        {
-            object isOmitNullValuedAttributes = false;
-            return 
-                (_requestMeta?.GetMeta()?.TryGetValue("jsonapidotnet:omit-null-valued-attributes", out isOmitNullValuedAttributes) ?? false ) ? 
-                (bool)isOmitNullValuedAttributes 
-                : _jsonApiContext.Options.OmitNullValuedAttributesFromResponses; 
-        }
-
         private bool ShouldIncludeAttribute(AttrAttribute attr)
         {
             return (_jsonApiContext.QuerySet == null 

src/JsonApiDotNetCore/Builders/DocumentBuilderOptions.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace JsonApiDotNetCore.Builders
+{
+    public struct DocumentBuilderOptions 
+    {
+        public DocumentBuilderOptions(bool isIncludeNullAttributes = false)
+        {
+            this.IncludeNullAttributes = isIncludeNullAttributes;
+        }
+
+        public bool IncludeNullAttributes { get; private set; }
+    }
+}

src/JsonApiDotNetCore/Builders/IDocumentBuilderBehavior.cs

@@ -0,0 +1,11 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace JsonApiDotNetCore.Builders
+{
+    public interface IDocumentBuilderBehavior
+    {
+        DocumentBuilderOptions GetDocumentBuilderOptions(); 
+    }
+}

src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs

@@ -17,7 +17,6 @@ public class JsonApiOptions
         public IContextGraph ContextGraph { get; set; }
         public bool RelativeLinks { get; set; }
         public bool AllowCustomQueryParameters { get; set; }
-        public bool OmitNullValuedAttributesFromResponses { get; set; }
 
         [Obsolete("JsonContract resolver can now be set on SerializerSettings.")]
         public IContractResolver JsonContractResolver

src/JsonApiDotNetCore/Services/IJsonApiContext.cs

@@ -26,6 +26,8 @@ public interface IJsonApiContext
         Dictionary<AttrAttribute, object> AttributesToUpdate { get; set; }
         Dictionary<RelationshipAttribute, object> RelationshipsToUpdate { get; set; }
         Type ControllerType { get; set; }
+        Dictionary<string, object> DocumentMeta { get; set; }
+
         TAttribute GetControllerAttribute<TAttribute>() where TAttribute : Attribute;
     }
 }

src/JsonApiDotNetCore/Services/JsonApiContext.cs

@@ -50,6 +50,7 @@ public JsonApiContext(
         public Dictionary<AttrAttribute, object> AttributesToUpdate { get; set; } = new Dictionary<AttrAttribute, object>();
         public Dictionary<RelationshipAttribute, object> RelationshipsToUpdate { get; set; } = new Dictionary<RelationshipAttribute, object>();
         public Type ControllerType { get; set; }
+        public Dictionary<string, object> DocumentMeta { get; set; }
 
         public IJsonApiContext ApplyContext<T>(object controller)
         {

test/UnitTests/Builders/DocumentBuilder_Tests.cs

@@ -20,8 +20,8 @@ public class DocumentBuilder_Tests
 
         public DocumentBuilder_Tests()
         {
-            _jsonApiContextMock = new Mock<IJsonApiContext>();
-            _requestMetaMock = new Mock<IRequestMeta>();
+            _jsonApiContextMock = new Mock<IJsonApiContext>();
+            _requestMetaMock = new Mock<IRequestMeta>();
 
             _options = new JsonApiOptions();
 
@@ -144,38 +144,23 @@ public void Build_Can_Build_CustomIEnumerables()
         }
 
 
-        [Theory]
-        [InlineData(null,null,false)]
-        [InlineData(true,null,true)]
-        [InlineData(false,null,false)]
-        [InlineData(true,true,true)]
-        [InlineData(true,false,false)]
-        [InlineData(false,false,false)]
-        [InlineData(null,false,false)]
-        [InlineData(null,true,true)]
-        public void CheckNullValueHandling(bool? optionsOmitNullValuedAttributesFromResponses, 
-            bool? requestMetaOmitNullValuedAttributesFromResponses, 
-            bool isNullValuesAreIncludedInResponse)
+        [Theory]
+        [InlineData(null,false)]
+        [InlineData(false,false)]
+        [InlineData(true,true)]
+        public void DocumentBuilderOptions(bool? isIcludeNullAttributesOptionValue,
+            bool isNullValuesAreIncludedInResult)
         {
-            if (optionsOmitNullValuedAttributesFromResponses.HasValue)
+            var documentBuilderBehaviourMock = new Mock<IDocumentBuilderBehavior>();
+            if (isIcludeNullAttributesOptionValue.HasValue)
             {
-                _options.OmitNullValuedAttributesFromResponses = optionsOmitNullValuedAttributesFromResponses.Value;
+                documentBuilderBehaviourMock.Setup(m => m.GetDocumentBuilderOptions())
+                    .Returns(new DocumentBuilderOptions(isIcludeNullAttributesOptionValue.Value));
             }
-            if (requestMetaOmitNullValuedAttributesFromResponses.HasValue)
-            {
-                _requestMetaMock.Setup(m => m.GetMeta())
-                    .Returns(new Dictionary<string, object>()
-                    {
-                        {
-                            "jsonapidotnet:omit-null-valued-attributes", requestMetaOmitNullValuedAttributesFromResponses.Value
-                        }
-                    });
-            }
-            var documentBuilder = new DocumentBuilder(
-                _jsonApiContextMock.Object, requestMetaOmitNullValuedAttributesFromResponses.HasValue ? _requestMetaMock.Object : null);
+            var documentBuilder = new DocumentBuilder(_jsonApiContextMock.Object, null, isIcludeNullAttributesOptionValue.HasValue ? documentBuilderBehaviourMock.Object : null);
             var document = documentBuilder.Build(new Model());
-
-            Assert.Equal(isNullValuesAreIncludedInResponse, document.Data.Attributes.ContainsKey("StringProperty"));
+
+            Assert.Equal(isNullValuesAreIncludedInResult, document.Data.Attributes.ContainsKey("StringProperty"));
         }
 
         private class Model : Identifiable