refactor(relationships): provide a more specific definition

Author: jaredcnance

src/JsonApiDotNetCore/Builders/DocumentBuilder.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using JsonApiDotNetCore.Extensions;
 using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Models;
 using JsonApiDotNetCore.Services;
@@ -59,7 +60,7 @@ private DocumentData _getData(ContextEntity contextEntity, IIdentifiable entity)
                 return data;
 
             data.Attributes = new Dictionary<string, object>();
-            data.Relationships = new Dictionary<string, Dictionary<string, object>>();
+            data.Relationships = new Dictionary<string, RelationshipData>();
 
             contextEntity.Attributes.ForEach(attr =>
             {
@@ -76,10 +77,13 @@ private void _addRelationships(DocumentData data, ContextEntity contextEntity, I
             var linkBuilder = new LinkBuilder(_jsonApiContext);
 
             contextEntity.Relationships.ForEach(r => {
-                data.Relationships.Add("links", new Dictionary<string,object> {
-                    {"self", linkBuilder.GetSelfRelationLink(contextEntity.EntityName, entity.Id.ToString(), r.RelationshipName)},
-                    {"related", linkBuilder.GetRelatedRelationLink(contextEntity.EntityName, entity.Id.ToString(), r.RelationshipName)},
-                });
+                var relationshipData = new RelationshipData {
+                    Links = new Dictionary<string, string> {
+                        {"self", linkBuilder.GetSelfRelationLink(contextEntity.EntityName, entity.Id.ToString(), r.RelationshipName)},
+                        {"related", linkBuilder.GetRelatedRelationLink(contextEntity.EntityName, entity.Id.ToString(), r.RelationshipName)}
+                    }
+                };
+                data.Relationships.Add(r.RelationshipName.Dasherize(), relationshipData);
             });
         }
     }

src/JsonApiDotNetCore/Models/DocumentData.cs

@@ -23,6 +23,6 @@ public string Type
 
 
         [JsonProperty("relationships")]
-        public Dictionary<string, Dictionary<string, object>> Relationships { get; set; }
+        public Dictionary<string, RelationshipData> Relationships { get; set; }
     }
 }

src/JsonApiDotNetCore/Models/RelationshipData.cs

@@ -0,0 +1,33 @@
+using System.Collections;
+using System.Collections.Generic;
+using Newtonsoft.Json;
+
+namespace JsonApiDotNetCore.Models
+{
+    public class RelationshipData
+    {
+        [JsonProperty("links")]
+        public Dictionary<string, string> Links { get; set; }
+
+        [JsonProperty("data")]
+        public object ExposedData { 
+            get {
+                if(ManyData != null)
+                    return ManyData;
+                return SingleData;
+            }
+            set {
+                if(value is IEnumerable)
+                    ManyData = (List<Dictionary<string, string>>)value;
+                else
+                    SingleData = (Dictionary<string, string>)value;
+            }
+         }
+
+        [JsonIgnore]
+        public List<Dictionary<string, string>> ManyData { get; set; }
+        
+        [JsonIgnore]
+        public Dictionary<string, string> SingleData { get; set; }
+    }
+}

src/JsonApiDotNetCore/Serialization/JsonApiDeSerializer.cs

@@ -54,7 +54,7 @@ private static object _setEntityAttributes(
         }
 
         private static object _setRelationships(
-            object entity, ContextEntity contextEntity, Dictionary<string, Dictionary<string, object>> relationships)
+            object entity, ContextEntity contextEntity, Dictionary<string, RelationshipData> relationships)
         {
             if(relationships == null)
                 return entity;
@@ -68,10 +68,10 @@ private static object _setRelationships(
                 if (entityProperty == null)
                     throw new ArgumentException($"{contextEntity.EntityType.Name} does not contain an relationsip named {attr.RelationshipName}", nameof(entity));
 
-                Dictionary<string, object> relationshipData;
+                RelationshipData relationshipData;
                 if (relationships.TryGetValue(attr.RelationshipName.Dasherize(), out relationshipData))
                 {
-                    var data = ((JObject)relationshipData["data"]).ToObject<Dictionary<string,string>>();
+                    var data = (Dictionary<string,string>)relationshipData.ExposedData;
                     var newValue = data["id"];
                     var convertedValue = Convert.ChangeType(newValue, entityProperty.PropertyType);
                     entityProperty.SetValue(entity, convertedValue);

src/JsonApiDotNetCoreExample/README.md

@@ -23,7 +23,7 @@
 - [ ] Dasherized route support
 - [ ] Sorting/Filtering should be handled by the repository so that it is not dependeny on EF ?
 - [ ] Rename ContextEntity ?? 
-- [ ] Refactor relationships links to use an POCO that contains data and links objects
+- [x] Refactor relationships links to use an POCO that contains data and links objects
 
 ## Usage