feat: decoupled deserializer and serializer

Author: Maurits Moeys

src/JsonApiDotNetCore/Builders/IDocumentBuilderOptionsProvider.cs

@@ -0,0 +1,12 @@
+using JsonApiDotNetCore.Models.Links;
+
+namespace JsonApiDotNetCore.Configuration
+{
+    public interface IGlobalLinksConfiguration
+    {
+        bool RelativeLinks { get; set; }
+        Link RelationshipLinks { get; set; }
+        Link TopLevelLinks { get; set; }
+        Link ResourceLinks { get; set; }
+    }
+}

src/JsonApiDotNetCore/Builders/ILinkBuilder.cs

@@ -0,0 +1,40 @@
+// REF: https://github.com/aspnet/Entropy/blob/dev/samples/Mvc.CustomRoutingConvention/NameSpaceRoutingConvention.cs
+// REF: https://github.com/aspnet/Mvc/issues/5691
+using System.Reflection;
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.Extensions;
+using Microsoft.AspNetCore.Mvc.ApplicationModels;
+
+namespace JsonApiDotNetCore.Internal
+{
+    public class DasherizedRoutingConvention : IApplicationModelConvention
+    {
+        private readonly string _namespace;
+        public DasherizedRoutingConvention(string nspace)
+        {
+            _namespace = nspace;
+        }
+
+        public void Apply(ApplicationModel application)
+        {
+            foreach (var controller in application.Controllers)
+            {
+                if (IsDasherizedJsonApiController(controller) == false)
+                    continue;
+
+                var template = $"{_namespace}/{controller.ControllerName.Dasherize()}";
+                controller.Selectors[0].AttributeRouteModel = new AttributeRouteModel
+                {
+                    Template = template
+                };
+            }
+        }
+
+        private bool IsDasherizedJsonApiController(ControllerModel controller)
+        {
+            var type = controller.ControllerType;
+            var notDisabled = type.GetCustomAttribute<DisableRoutingConventionAttribute>() == null;
+            return notDisabled && type.IsSubclassOf(typeof(JsonApiControllerMixin));
+        }
+    }
+}

src/JsonApiDotNetCore/Builders/LinkBuilder.cs

@@ -0,0 +1,6 @@
+namespace JsonApiDotNetCore.Internal.Contracts
+{
+    public interface IContextEntityProvider
+    {
+    }
+}

src/JsonApiDotNetCore/Builders/MetaBuilder.cs

@@ -0,0 +1,18 @@
+using System.Collections.Generic;
+using JsonApiDotNetCore.Models;
+
+namespace JsonApiDotNetCore.Serialization
+{
+
+    public interface IUpdatedFieldsManager
+    {
+        List<AttrAttribute> AttributesToUpdate { get; set; }
+        List<RelationshipAttribute> RelationshipsToUpdate { get; set; }
+    }
+
+    public interface IUpdatedFieldManager_ProposalWithDictionaries
+    {
+        Dictionary<IIdentifiable, List<AttrAttribute>> AttributesToUpdate { get; set; }
+        Dictionary<IIdentifiable, List<RelationshipAttribute>> RelationshipsToUpdate { get; set; }
+    }
+}

src/JsonApiDotNetCore/Builders/DocumentBuilderOptions.cs renamed to src/JsonApiDotNetCore/Builders/SerializerOptions.cs

@@ -0,0 +1,6 @@
+namespace JsonApiDotNetCore.Models
+{
+    internal interface IResourceField
+    {
+    }
+}

src/JsonApiDotNetCore/Configuration/IGlobalLinksConfiguration.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Collections.Generic;
+
+namespace JsonApiDotNetCore.Models
+{
+    /// TODO: GetOutputAttrs is used in SERIALIATION LAYER to remove fields from
+    /// list of attrs that will be displayed, (i.e. touches the DOCUMENT structure)
+    /// whereas hooks is stuff to do on the MODEL in the SERVICELAYER.
+    /// Consider (not sure yet) to move to different class because of this.
+    /// edit: using different interfaces for this is maybe good enough to separate
+    public interface ISerializableFields
+    {
+        List<AttrAttribute> GetAllowedAttributes(Type type);
+        List<RelationshipAttribute> GetAllowedRelationships(Type type);
+    }
+}

src/JsonApiDotNetCore/Internal/CamelizedRoutingConvention.cs

@@ -1,3 +1,4 @@
+using JsonApiDotNetCore.Models.Links;
 using Newtonsoft.Json;
 
 namespace JsonApiDotNetCore.Models

src/JsonApiDotNetCore/Internal/Contracts/IContextEntityProvider.cs

@@ -0,0 +1,77 @@
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace JsonApiDotNetCore.Models
+{
+    public class ExposableData<T>
+    {
+        /// <summary>
+        /// see "primary data" in https://jsonapi.org/format/#document-top-level.
+        /// </summary>
+        [JsonProperty("data")]
+        public object Data { get { return GetPrimaryData(); } set { SetPrimaryData(value); } }
+
+        /// <summary>
+        /// see https://www.newtonsoft.com/json/help/html/ConditionalProperties.htm
+        /// </summary>
+        public bool ShouldSerializData()
+        {
+            return IsPopulated;
+        }
+
+        /// <summary>
+        /// Internally used for "single" primary data.
+        /// </summary>
+        internal T SingleData { get; private set; }
+
+        /// <summary>
+        /// Internally used for "many" primary data.
+        /// </summary>
+        internal List<T> ManyData { get; private set; }
+
+        /// <summary>
+        /// Internally used to indicate if the document's primary data is
+        /// "single" or "many".
+        /// </summary>
+        internal bool IsManyData { get; private set; } = false;
+
+        /// <summary>
+        /// Internally used to indicate if the document's primary data is
+        /// should still be serialized when it's value is null. This is used when
+        /// a single resource is requested but not present (eg /articles/1/author).
+        /// </summary>
+        internal bool IsPopulated { get; private set; } = false;
+
+        /// <summary>
+        /// Gets the "single" or "many" data depending on which one was
+        /// assigned in this document.
+        /// </summary>
+        protected object GetPrimaryData()
+        {
+            if (IsManyData)
+                return ManyData;
+            return SingleData;
+        }
+
+        /// <summary>
+        /// Sets the primary data depending on if it is "single" or "many" data.
+        /// </summary>
+        protected void SetPrimaryData(object value)
+        {
+            IsPopulated = true;
+            if (value is JObject jObject)
+                SingleData = jObject.ToObject<T>();
+            else if (value is T ro)
+                SingleData = ro;
+            else if (value != null)
+            {
+                IsManyData = true;
+                if (value is JArray jArray)
+                    ManyData = jArray.ToObject<List<T>>();
+                else
+                    ManyData = (List<T>)value;
+            }
+        }
+    }
+}

src/JsonApiDotNetCore/Internal/PageManager.cs

@@ -0,0 +1,15 @@
+using System;
+
+namespace JsonApiDotNetCore.Models.Links
+{
+    [Flags]
+    public enum Link
+    {
+        Self = 1 << 0,
+        Related = 1 << 1,
+        Paging = 1 << 2,
+        NotConfigured = 1 << 3,
+        None = 1 << 4,
+        All = Self | Related | Paging
+    }
+}