Can link data and included

Josh Holtz · Josh Holtz · commit 8102024ea463 · 2015-03-17T11:51:55.000-05:00
diff --git a/Classes/JSONAPI.h b/Classes/JSONAPI.h
@@ -21,6 +21,7 @@
 
 @property (readonly) id resource;
 @property (nonatomic, strong, readonly) NSArray *resources;
+@property (nonatomic, strong, readonly) NSDictionary *includedResources;
 
 @property (nonatomic, strong, readonly) NSError *internalError;
 
@@ -30,4 +31,6 @@
 - (instancetype)initWithDictionary:(NSDictionary*)dictionary;
 - (instancetype)initWithString:(NSString*)string;
 
+- (id)includedResource:(id)ID withType:(NSString*)type;
+
 @end
diff --git a/Classes/JSONAPI.m b/Classes/JSONAPI.m
@@ -60,48 +60,11 @@ - (id)resource {
     return _resources.firstObject;
 }
 
-//- (id)objectForKey:(NSString*)key {
-//    return [_dictionary objectForKey:key];
-//}
-
-//- (id)resource {
-//    NSString *key = @"data";
-//    if ([key isEqualToString:@"meta"] == YES || [key isEqualToString:@"linked"] == YES) {
-//        return nil;
-//    }
-//    
-//    NSDictionary *rawResource = [_dictionary objectForKey:key];
-//    JSONAPIResource *resource = nil;
-//    if ([rawResource isKindOfClass:[NSDictionary class]] == YES) {
-//        resource = [JSONAPIResource jsonAPIResource:rawResource withLinked:self.linked];
-//    }
-//    
-//    // Fall back to first element in array
-//    if (resource == nil) {
-//        id resources = [self resources];
-//        if ([resources isKindOfClass:[NSArray class]] == YES) {
-//            return [resources firstObject];
-//        }
-//    }
-//    
-//    return resource;
-//
-//}
-
-//- (NSArray*)resources {
-//    NSString *key = @"data";
-//    if ([key isEqualToString:@"meta"] == YES || [key isEqualToString:@"linked"] == YES) {
-//        return nil;
-//    }
-//    
-//    NSArray *rawResources = [_dictionary objectForKey:key];
-//    NSArray *resources = nil;
-//    if ([rawResources isKindOfClass:[NSArray class]] == YES) {
-//        resources = [JSONAPIResource jsonAPIResources:rawResources withLinked:self.linked];
-//    }
-//    
-//    return resources;
-//}
+- (id)includedResource:(id)ID withType:(NSString *)type {
+    if (ID == nil) return nil;
+    if (type == nil) return nil;
+    return _includedResources[type][ID];
+}
 
 #pragma mark - Private
 
@@ -133,37 +96,36 @@ - (void)inflateWithDictionary:(NSDictionary*)dictionary {
         if (resource) [resources addObject:resource];
     }
     _resources = resources;
+    
+    // Parses included resources
+    NSArray *included = _dictionary[@"included"];
+    NSMutableDictionary *includedResources = @{}.mutableCopy;
+    for (NSDictionary *data in included) {
+        
+        JSONAPIResource *resource = [self inflateResourceData:data];
+        if (resource) {
+
+            NSMutableDictionary *typeDict = includedResources[resource.type] ?: @{}.mutableCopy;
+            typeDict[resource.ID] = resource;
+            
+            includedResources[resource.type] = typeDict;
+        }
+    }
+    _includedResources = includedResources;
+    
+    // Link included with included
+    // TODO: Need to look into / stop circular references
+    for (NSDictionary *typeIncluded in _includedResources.allValues) {
+        for (JSONAPIResource *resource in typeIncluded.allValues) {
+            [resource linkWithIncluded:self];
+        }
+    }
+    
+    // Link data with included
+    for (JSONAPIResource *resource in _resources) {
+        [resource linkWithIncluded:self];
+    }
 
-//    // Sets linked
-//    NSMutableDictionary *creatingLinked = [NSMutableDictionary dictionary];
-//    NSDictionary *rawLinked = [dictionary objectForKey:@"linked"];
-//    if ([rawLinked isKindOfClass:[NSArray class]] == YES) {
-//        
-//        NSMutableArray *linkedToLinkWithLinked = [NSMutableArray array];
-//        
-//        // Loops through linked arrays
-//        for (NSDictionary *resourceDictionary in rawLinked) {
-//            
-//            NSString *type = resourceDictionary[@"type"];
-//            NSMutableDictionary *resources = creatingLinked[type] ?: @{}.mutableCopy;
-//            [creatingLinked setObject:resources forKey:type];
-//            
-//            JSONAPIResource *resource = [JSONAPIResource jsonAPIResource:resourceDictionary withLinked:nil];
-//            if (resource.ID != nil) {
-//                [resources setObject:resource forKey:resource.ID];
-//                [linkedToLinkWithLinked addObject:resource];
-//            }
-//            
-//        }
-//        
-//        // Linked the linked
-//        for (JSONAPIResource *resource in linkedToLinkWithLinked) {
-//            [resource linkLinks:creatingLinked];
-//        }
-//        
-//    }
-//    
-//    _linked = creatingLinked;
 }
 
 - (id)inflateResourceData:(NSDictionary*)data {
diff --git a/Classes/JSONAPIResource.h b/Classes/JSONAPIResource.h
@@ -8,6 +8,8 @@
 
 #import <Foundation/Foundation.h>
 
+@class JSONAPI;
+
 @interface JSONAPIResource : NSObject<NSCopying, NSCoding>
 
 @property (nonatomic, strong) id ID;
@@ -18,5 +20,6 @@
 + (NSArray*)jsonAPIResources:(NSArray*)array;
 
 - (NSDictionary *)mapKeysToProperties;
+- (void)linkWithIncluded:(JSONAPI*)jsonAPI;
 
 @end
diff --git a/Classes/JSONAPIResource.m b/Classes/JSONAPIResource.m
@@ -8,6 +8,7 @@
 
 #import "JSONAPIResource.h"
 
+#import "JSONAPI.h"
 #import "JSONAPIResourceFormatter.h"
 #import "JSONAPIResourceLinker.h"
 #import "JSONAPIResourceModeler.h"
@@ -98,6 +99,7 @@ - (void)setWithDictionary:(NSDictionary*)dict {
     [map addEntriesFromDictionary:@{
                                          @"id" : @"ID",
                                          @"href" : @"href",
+                                         @"type" : @"type",
                                          @"links" : @"links"
                                          }];
     
@@ -134,64 +136,75 @@ - (void)setWithDictionary:(NSDictionary*)dict {
     }
 }
 
-//- (void)linkLinks:(NSDictionary*)linked {
-//    
-//    // Loops through links of resources
-//    for (NSString *linkKey in self.links.allKeys) {
-//        
-//        // Gets linked objects for the resource
-//        id linksTo = [self.links objectForKey:linkKey];
-//        if ([linksTo isKindOfClass:[NSDictionary class]] == YES) {
-//            
-//            NSString *linkType = linksTo[@"type"];
-//            linkType = [JSONAPIResourceLinker linkedType:linkType] ?: linkType;
-//            
-//            if (linksTo[@"id"] != nil) {
-//                id linksToId = linksTo[@"id"];
-//                
-//                JSONAPIResource *linkedResource = [[linked objectForKey:linkType] objectForKey:linksToId];
-//                if (linkedResource != nil) {
-//                    [self.__resourceLinks setObject:linkedResource forKey:linkKey];
-//                }
-//            } else if (linksTo[@"ids"] != nil) {
-//                id linksToIds = linksTo[@"ids"];
-//                
-//                NSMutableArray *linkedResources = [NSMutableArray array];
-//                [self.__resourceLinks setObject:linkedResources forKey:linkKey];
-//                
-//                for (id linkedId in linksToIds) {
-//                    JSONAPIResource *linkedResource = [[linked objectForKey:linkType] objectForKey:linkedId];
-//                    if (linkedResource != nil) {
-//                        [linkedResources addObject:linkedResource];
-//                    }
-//                }
-//            }
-//            
-//            
-//        }
-//    }
-//    
-//    // Link links for mapped key to properties
-//    for (NSString *key in [self mapKeysToProperties]) {
-//        if ([key hasPrefix:@"links."] == YES) {
-//            
-//            NSString *propertyName = [[self mapKeysToProperties] objectForKey:key];
-//            NSString *linkedResource = [key stringByReplacingOccurrencesOfString:@"links." withString:@""];
-//            
-//            id resource = [self linkedResourceForKey:linkedResource];
-//            if (resource != nil) {
-//                
-//                @try {
-//                    [self setValue:resource forKey:propertyName];
-//                }
-//                @catch (NSException *exception) {
-//                    NSLog(@"JSONAPIResource Warning - %@", [exception description]);
-//                }
-//            }
-//            
-//        }
-//    }
-//}
+- (void)linkWithIncluded:(JSONAPI*)jsonAPI {
+    
+    NSDictionary *included = jsonAPI.includedResources;
+    
+    // Loops through links of resources
+    for (NSString *linkKey in self.links.allKeys) {
+        
+        // Gets linked objects for the resource
+        id linksTo = self.links[linkKey];
+        if ([linksTo isKindOfClass:[NSDictionary class]] == YES) {
+            
+            id linkage = linksTo[@"linkage"];
+            if ([linkage isKindOfClass:[NSDictionary class]] == YES) {
+
+                NSString *linkType = linkage[@"type"];
+                linkType = [JSONAPIResourceLinker linkedType:linkType] ?: linkType;
+                
+                if (linkage[@"id"] != nil) {
+                    id linksToId = linkage[@"id"];
+                    
+                    JSONAPIResource *linkedResource = included[linkType][linksToId];
+                    if (linkedResource != nil) {
+                        [self.__resourceLinks setObject:linkedResource forKey:linkKey];
+                    }
+                }
+
+            } else if ([linkage isKindOfClass:[NSArray class]] == YES) {
+                
+                NSMutableArray *linkedResources = @[].mutableCopy;
+                for (NSDictionary *linkageData in linkage) {
+                    NSString *linkType = linkageData[@"type"];
+                    linkType = [JSONAPIResourceLinker linkedType:linkType] ?: linkType;
+                    
+                    if (linkageData[@"id"] != nil) {
+                        id linksToId = linkageData[@"id"];
+                        
+                        JSONAPIResource *linkedResource = included[linkType][linksToId];
+                        if (linkedResource != nil) {
+                            [linkedResources addObject:linkedResources];
+                        }
+                    }
+                }
+                [self.__resourceLinks setObject:linkedResources forKey:linkKey];
+                
+            }
+        }
+    }
+    
+    // Link links for mapped key to properties
+    for (NSString *key in [self mapKeysToProperties]) {
+        if ([key hasPrefix:@"links."] == YES) {
+            
+            NSString *propertyName = [[self mapKeysToProperties] objectForKey:key];
+            NSString *linkedResource = [key stringByReplacingOccurrencesOfString:@"links." withString:@""];
+            
+            id resource = [self linkedResourceForKey:linkedResource];
+            if (resource != nil) {
+                
+                @try {
+                    [self setValue:resource forKey:propertyName];
+                }
+                @catch (NSException *exception) {
+                    NSLog(@"JSONAPIResource Warning - %@", [exception description]);
+                }
+            }
+            
+        }
+    }
+}
 
 #pragma mark - NSCopying
 
diff --git a/Project/JSONAPI/CommentResource.h b/Project/JSONAPI/CommentResource.h
@@ -8,8 +8,11 @@
 
 #import "JSONAPIResource.h"
 
+@class PeopleResource;
+
 @interface CommentResource : JSONAPIResource
 
 @property (nonatomic, strong) NSString *text;
+@property (nonatomic, strong) PeopleResource *author;
 
 @end
diff --git a/Project/JSONAPI/CommentResource.m b/Project/JSONAPI/CommentResource.m
@@ -12,7 +12,8 @@ @implementation CommentResource
 
 - (NSDictionary *)mapKeysToProperties {
     return @{
-             @"text" : @"text"
+             @"text" : @"text",
+             @"links.author" : @"author",
              };
 }
 
diff --git a/Project/JSONAPITests/JSONAPITests.m b/Project/JSONAPITests/JSONAPITests.m
@@ -10,6 +10,8 @@
 
 #import "JSONAPI.h"
 
+#import "CommentResource.h"
+#import "PeopleResource.h"
 #import "PostResource.h"
 
 @interface JSONAPITests : XCTestCase
@@ -21,6 +23,8 @@ @implementation JSONAPITests
 - (void)setUp {
     [super setUp];
 
+    [JSONAPIResourceModeler useResource:[CommentResource class] toLinkedType:@"comments"];
+    [JSONAPIResourceModeler useResource:[PeopleResource class] toLinkedType:@"people"];
     [JSONAPIResourceModeler useResource:[PostResource class] toLinkedType:@"posts"];
 }
 
@@ -50,6 +54,34 @@ - (void)testDataPosts {
     XCTAssertEqualObjects(post.title, @"JSON API paints my bikeshed!", @"Post title should be 'JSON API paints my bikeshed!'");
 }
 
+- (void)testIncludedPeopleAndComments {
+    NSDictionary *json = [self mainExampleJSON];
+    JSONAPI *jsonAPI = [JSONAPI jsonAPIWithDictionary:json];
+    
+    XCTAssertNotNil(jsonAPI.includedResources, @"Included resources should not be nil");
+    XCTAssertEqual(jsonAPI.includedResources.count, 2, @"Included resources should contain 2 types");
+    
+}
+
+- (void)testDataPostAuthorAndComments {
+    NSDictionary *json = [self mainExampleJSON];
+    JSONAPI *jsonAPI = [JSONAPI jsonAPIWithDictionary:json];
+    
+    PostResource *post = jsonAPI.resource;
+    XCTAssertNotNil(post.author, @"Post's author should not be nil");
+    XCTAssertNotNil(post.comments, @"Post's comments should not be nil");
+    XCTAssertEqual(post.comments.count, 2, @"Post should contain 2 comments");
+}
+
+- (void)testIncludedIsLinked {
+    NSDictionary *json = [self mainExampleJSON];
+    JSONAPI *jsonAPI = [JSONAPI jsonAPIWithDictionary:json];
+    
+    CommentResource *comment = [jsonAPI includedResource:@"5" withType:@"comments"];
+    XCTAssertNotNil(comment.author, @"Comment's author should not be nil");
+    XCTAssertEqualObjects(comment.author.ID, @"9", @"Comment's author's ID should be 9");
+}
+
 #pragma mark - Private
 
 - (NSDictionary*)mainExampleJSON {
diff --git a/Project/JSONAPITests/main_example.json b/Project/JSONAPITests/main_example.json

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,8 @@ @implementation CommentResource`
`12`	`12`
`13`	`13`	`- (NSDictionary *)mapKeysToProperties {`
`14`	`14`	`return @{`
`15`		`- @"text" : @"text"`
	`15`	`+ @"text" : @"text",`
	`16`	`+ @"links.author" : @"author",`
`16`	`17`	`};`
`17`	`18`	`}`
`18`	`19`