refactor(JsonApiContext): begin interface separation

remove redundant IsRelationship property

Author: jaredcnance

src/JsonApiDotNetCore/Builders/DocumentBuilder.cs

@@ -13,9 +13,9 @@ public class DocumentBuilder : IDocumentBuilder
         private readonly IJsonApiContext _jsonApiContext;
         private readonly IContextGraph _contextGraph;
         private readonly IRequestMeta _requestMeta;
-        private readonly DocumentBuilderOptions _documentBuilderOptions; 
+        private readonly DocumentBuilderOptions _documentBuilderOptions;
 
-        public DocumentBuilder(IJsonApiContext jsonApiContext, IRequestMeta requestMeta=null, IDocumentBuilderOptionsProvider documentBuilderOptionsProvider=null)
+        public DocumentBuilder(IJsonApiContext jsonApiContext, IRequestMeta requestMeta = null, IDocumentBuilderOptionsProvider documentBuilderOptionsProvider = null)
         {
             _jsonApiContext = jsonApiContext;
             _contextGraph = jsonApiContext.ContextGraph;
@@ -107,7 +107,7 @@ public DocumentData GetData(ContextEntity contextEntity, IIdentifiable entity)
                 Id = entity.StringId
             };
 
-            if (_jsonApiContext.IsRelationshipData)
+            if (_jsonApiContext.IsRelationshipPath)
                 return data;
 
             data.Attributes = new Dictionary<string, object>();
@@ -243,7 +243,8 @@ private List<ResourceIdentifierObject> GetRelationships(IEnumerable<object> enti
             var relationships = new List<ResourceIdentifierObject>();
             foreach (var entity in entities)
             {
-                relationships.Add(new ResourceIdentifierObject {
+                relationships.Add(new ResourceIdentifierObject
+                {
                     Type = typeName.EntityName,
                     Id = ((IIdentifiable)entity).StringId
                 });
@@ -256,7 +257,8 @@ private ResourceIdentifierObject GetRelationship(object entity)
 
             var typeName = _jsonApiContext.ContextGraph.GetContextEntity(objType);
 
-            return new ResourceIdentifierObject {
+            return new ResourceIdentifierObject
+            {
                 Type = typeName.EntityName,
                 Id = ((IIdentifiable)entity).StringId
             };

src/JsonApiDotNetCore/Services/EntityResourceService.cs

@@ -80,10 +80,7 @@ private async Task<T> GetWithRelationshipsAsync(TId id)
         }
 
         public virtual async Task<object> GetRelationshipsAsync(TId id, string relationshipName)
-        {
-            _jsonApiContext.IsRelationshipData = true;
-            return await GetRelationshipAsync(id, relationshipName);
-        }
+            => await GetRelationshipAsync(id, relationshipName);
 
         public virtual async Task<object> GetRelationshipAsync(TId id, string relationshipName)
         {

src/JsonApiDotNetCore/Services/IJsonApiContext.cs

@@ -10,27 +10,113 @@
 
 namespace JsonApiDotNetCore.Services
 {
-    public interface IJsonApiContext
+    public interface IJsonApiApplication
     {
         JsonApiOptions Options { get; set; }
-        IJsonApiContext ApplyContext<T>(object controller);
         IContextGraph ContextGraph { get; set; }
-        ContextEntity RequestEntity { get; set; }
-        string BasePath { get; set; }
-        QuerySet QuerySet { get; set; }
-        bool IsRelationshipData { get; set; }
+    }
+
+    public interface IQueryRequest
+    {
         List<string> IncludedRelationships { get; set; }
-        bool IsRelationshipPath { get; }
+        QuerySet QuerySet { get; set; }
         PageManager PageManager { get; set; }
-        IMetaBuilder MetaBuilder { get; set; }
-        IGenericProcessorFactory GenericProcessorFactory { get; set; }
+    }
+
+    public interface IUpdateRequest
+    {
         Dictionary<AttrAttribute, object> AttributesToUpdate { get; set; }
         Dictionary<RelationshipAttribute, object> RelationshipsToUpdate { get; set; }
+    }
+
+    public interface IJsonApiRequest : IJsonApiApplication, IUpdateRequest, IQueryRequest
+    {
+        /// <summary>
+        /// The request namespace. This may be an absolute or relative path
+        /// depending upon the configuration.
+        /// </summary>
+        /// <example>
+        /// Absolute: https://example.com/api/v1
+        /// 
+        /// Relative: /api/v1
+        /// </example>
+        string BasePath { get; set; }
+
+        /// <summary>
+        /// Stores information to set relationships for the request resource. 
+        /// These relationships must already exist and should not be re-created.
+        /// By default, it is the responsibility of the repository to use the 
+        /// relationship pointers to persist the relationship.
+        /// 
+        /// The expected use case is POST-ing or PATCH-ing an entity with HasMany 
+        /// relaitonships:
+        /// <code>
+        /// {
+        ///    "data": {
+        ///      "type": "photos",
+        ///      "attributes": {
+        ///        "title": "Ember Hamster",
+        ///        "src": "http://example.com/images/productivity.png"
+        ///      },
+        ///      "relationships": {
+        ///        "tags": {
+        ///          "data": [
+        ///            { "type": "tags", "id": "2" },
+        ///            { "type": "tags", "id": "3" }
+        ///          ]
+        ///        }
+        ///      }
+        ///    }
+        ///  }
+        /// </code>
+        /// </summary>
+        HasManyRelationshipPointers HasManyRelationshipPointers { get; }
+
+        /// <summary>
+        /// If the request is a bulk json:api v1.1 operations request.
+        /// This is determined by the `
+        /// <see cref="JsonApiDotNetCore.Serialization.JsonApiDeSerializer" />` class.
+        /// 
+        /// See [json-api/1254](https://github.com/json-api/json-api/pull/1254) for details.
+        /// </summary>
+        bool IsBulkOperationRequest { get; set; }
+
+        /// <summary>
+        /// The `<see cref="ContextEntity" />`for the target route.
+        /// </summary>
+        /// 
+        /// <example>
+        /// For a `GET /articles` request, `RequestEntity` will be set
+        /// to the `Article` resource representation on the `JsonApiContext`.
+        /// </example>
+        ContextEntity RequestEntity { get; set; }
+
+        /// <summary>
+        /// The concrete type of the controller that was activated by the MVC routing middleware
+        /// </summary>
         Type ControllerType { get; set; }
+
+        /// <summary>
+        /// The json:api meta data at the document level
+        /// </summary>
         Dictionary<string, object> DocumentMeta { get; set; }
-        bool IsBulkOperationRequest { get; set; }
-        HasManyRelationshipPointers HasManyRelationshipPointers { get; }
 
+        /// <summary>
+        /// If the request is on the `{id}/relationships/{relationshipName}` route
+        /// </summary>
+        bool IsRelationshipPath { get; }
+
+        [Obsolete("Use `IsRelationshipPath` instead.")]
+        bool IsRelationshipData { get; set; }
+    }
+
+    public interface IJsonApiContext : IJsonApiRequest
+    {
+        IJsonApiContext ApplyContext<T>(object controller);
+        IMetaBuilder MetaBuilder { get; set; }
+        IGenericProcessorFactory GenericProcessorFactory { get; set; }
+
+        [Obsolete("Use the proxied method IControllerContext.GetControllerAttribute instead.")]
         TAttribute GetControllerAttribute<TAttribute>() where TAttribute : Attribute;
     }
 }