Add (currently broken) support for persisting objects to disk.

Author: newsyc

Classes/HNKit/HNAPISearch.m

@@ -63,7 +63,7 @@ - (void)handleResponse {
 		NSDictionary *item = [self itemFromRaw:[result objectForKey:@"item"]];
 		HNEntry *entry = [HNEntry entryWithIdentifier:[item objectForKey:@"identifier"]];
 
-		[entry loadFromDictionary:item];
+		[entry loadContentsDictionary:item];
 		[entries addObject:entry];
 	}
 	[responseString release];

Classes/HNKit/HNContainer.h

@@ -9,7 +9,7 @@
 #import "HNShared.h"
 #import "HNObject.h"
 
-#define kHNContainerLoadingStateLoadingMore 0x00010000
+#define kHNContainerLoadingStateLoadingMore (0x1 << 16)
 
 @interface HNContainer : HNObject {
     NSArray *entries;
@@ -25,7 +25,6 @@
 - (BOOL)isLoadingMore;
 - (void)cancelLoadingMore;
 
-- (void)loadFromDictionary:(NSDictionary *)response;
-- (void)loadFromDictionary:(NSDictionary *)response entries:(NSArray **)outEntries;
+- (void)loadContentsDictionary:(NSDictionary *)contents entries:(NSArray **)outEntries;
 
 @end

Classes/HNKit/HNContainer.m

@@ -28,25 +28,43 @@ - (void)beginLoadingMore {
     [moreRequest performRequestWithPath:@"x" parameters:parameters];
 }
 
-- (void)loadFromDictionary:(NSDictionary *)response entries:(NSArray **)outEntries {
+- (void)loadContentsDictionary:(NSDictionary *)contents entries:(NSArray **)outEntries {
     return;
 }
 
-- (void)loadFromDictionary:(NSDictionary *)response {
-    [self loadFromDictionary:response entries:NULL];
-}
-
-- (void)loadFromDictionary:(NSDictionary *)response append:(BOOL)append {
+- (void)loadContentsDictionary:(NSDictionary *)contents {
     NSArray *children = nil;
-    [self loadFromDictionary:response entries:&children];
-    
-    if (append) {
+    [self loadContentsDictionary:contents entries:&children];
+
+    if ([[contents objectForKey:@"append"] boolValue]) {
         [self setEntries:[entries arrayByAddingObjectsFromArray:children]];
     } else {
         [self setEntries:children];
     }
-    
-    [self setMoreToken:[response objectForKey:@"more"]];
+
+    [self setMoreToken:[contents objectForKey:@"more"]];
+
+    [super loadContentsDictionary:contents];
+}
+
+- (void)loadContentsDictionary:(NSDictionary *)contents append:(BOOL)append {
+    NSMutableDictionary *mutableContents = [[contents mutableCopy] autorelease];
+    [mutableContents setObject:[NSNumber numberWithBool:append] forKey:@"append"];
+    [self loadContentsDictionary:mutableContents];
+}
+
+- (NSDictionary *)contentsDictionary {
+    NSMutableDictionary *dictionary = [[[super contentsDictionary] mutableCopy] autorelease];
+
+    if (moreToken != nil) [dictionary setObject:moreToken forKey:@"more"];
+
+    NSMutableArray *children = [NSMutableArray array];
+    for (HNEntry *child in entries) {
+        [children addObject:[child contentsDictionary]];
+    }
+    [dictionary setObject:children forKey:@"children"];
+
+    return dictionary;
 }
 
 - (void)cancelLoadingMore {
@@ -67,7 +85,7 @@ - (void)moreRequest:(HNAPIRequest *)request completedWithResponse:(NSDictionary
     moreRequest = nil;
 
     if (error == nil) {
-        [self loadFromDictionary:response append:YES];
+        [self loadContentsDictionary:response append:YES];
 
         [[NSNotificationCenter defaultCenter] postNotificationName:kHNObjectFinishedLoadingNotification object:self];
     } else {
@@ -77,7 +95,7 @@ - (void)moreRequest:(HNAPIRequest *)request completedWithResponse:(NSDictionary
 
 - (void)finishLoadingWithResponse:(NSDictionary *)response error:(NSError *)error {
     if (error == nil) {
-        [self loadFromDictionary:response append:NO];
+        [self loadContentsDictionary:response append:NO];
     }
 }
 

Classes/HNKit/HNEntry.h

@@ -42,7 +42,7 @@
 @property (nonatomic, readonly) HNEntryBodyRenderer *renderer;
 #endif
 
-- (void)loadFromDictionary:(NSDictionary *)response entries:(NSArray **)outEntries withSubmission:(HNEntry *)submission_;
+- (void)loadContentsDictionary:(NSDictionary *)response entries:(NSArray **)outEntries withSubmission:(HNEntry *)submission_;
 
 - (BOOL)isComment;
 - (BOOL)isSubmission;

Classes/HNKit/HNEntry.m

@@ -53,17 +53,16 @@ - (BOOL)isComment {
 }
 
 - (BOOL)isSubmission {
-    // Checking submission rather than something like title since this will be set
-    // even when the entry hasn't been loaded.
+    // This is counterintuitive, but we are essentially checking for a parent.
     return [self submission] == nil;
 }
 
-- (void)loadFromDictionary:(NSDictionary *)response entries:(NSArray **)outEntries {
-    if ([response objectForKey:@"submission"]) {
-        [self setSubmission:[HNEntry entryWithIdentifier:[response objectForKey:@"submission"]]];
+- (void)loadContentsDictionary:(NSDictionary *)contents entries:(NSArray **)outEntries {
+    if ([contents objectForKey:@"submission"]) {
+        [self setSubmission:[HNEntry entryWithIdentifier:[contents objectForKey:@"submission"]]];
     }
 
-    id parentId = [response objectForKey:@"parent"];
+    id parentId = [contents objectForKey:@"parent"];
     if (parentId) {
         HNEntry *parent_ = [HNEntry entryWithIdentifier:parentId];
 
@@ -76,27 +75,24 @@ - (void)loadFromDictionary:(NSDictionary *)response entries:(NSArray **)outEntri
         [self setParent:parent_];
     }
 
-    [self loadFromDictionary:response entries:outEntries withSubmission:[self submission] ?: self];
+    [self loadContentsDictionary:contents entries:outEntries withSubmission:[self submission] ?: self];
 }
 
-- (void)loadChildrenFromDictionary:(NSDictionary *)response {
-}
-
-- (void)loadFromDictionary:(NSDictionary *)response entries:(NSArray **)outEntries withSubmission:(HNEntry *)submission_ {
-    if ([response objectForKey:@"url"] != nil) [self setDestination:[NSURL URLWithString:[response objectForKey:@"url"]]];
-    if ([response objectForKey:@"user"] != nil) [self setSubmitter:[HNUser userWithIdentifier:[response objectForKey:@"user"]]];
-    if ([response objectForKey:@"body"] != nil) [self setBody:[response objectForKey:@"body"]];
-    if ([response objectForKey:@"date"] != nil) [self setPosted:[response objectForKey:@"date"]];
-    if ([response objectForKey:@"title"] != nil) [self setTitle:[response objectForKey:@"title"]];
-    if ([response objectForKey:@"points"] != nil) [self setPoints:[[response objectForKey:@"points"] intValue]];
+- (void)loadContentsDictionary:(NSDictionary *)contents entries:(NSArray **)outEntries withSubmission:(HNEntry *)submission_ {
+    if ([contents objectForKey:@"url"] != nil) [self setDestination:[NSURL URLWithString:[contents objectForKey:@"url"]]];
+    if ([contents objectForKey:@"user"] != nil) [self setSubmitter:[HNUser userWithIdentifier:[contents objectForKey:@"user"]]];
+    if ([contents objectForKey:@"body"] != nil) [self setBody:[contents objectForKey:@"body"]];
+    if ([contents objectForKey:@"date"] != nil) [self setPosted:[contents objectForKey:@"date"]];
+    if ([contents objectForKey:@"title"] != nil) [self setTitle:[contents objectForKey:@"title"]];
+    if ([contents objectForKey:@"points"] != nil) [self setPoints:[[contents objectForKey:@"points"] intValue]];
 
     NSMutableArray *comments = [NSMutableArray array];    
-    if ([response objectForKey:@"children"] != nil) {
-        for (NSDictionary *child in [response objectForKey:@"children"]) {
+    if ([contents objectForKey:@"children"] != nil) {
+        for (NSDictionary *child in [contents objectForKey:@"children"]) {
             HNEntry *childEntry = [HNEntry entryWithIdentifier:[child objectForKey:@"identifier"]];
             NSArray *childEntries = nil;
 
-            [childEntry loadFromDictionary:child entries:&childEntries withSubmission:submission_];
+            [childEntry loadContentsDictionary:child entries:&childEntries withSubmission:submission_];
             [childEntry setEntries:childEntries];
             [childEntry setParent:self];
             [childEntry setSubmission:submission_];
@@ -115,8 +111,8 @@ - (void)loadFromDictionary:(NSDictionary *)response entries:(NSArray **)outEntri
         }
     }
 
-    if ([response objectForKey:@"numchildren"] != nil) {
-        int count = [[response objectForKey:@"numchildren"] intValue];
+    if ([contents objectForKey:@"numchildren"] != nil) {
+        int count = [[contents objectForKey:@"numchildren"] intValue];
         [self setChildren:count];
     } else {
         int count = [comments count];
@@ -126,4 +122,18 @@ - (void)loadFromDictionary:(NSDictionary *)response entries:(NSArray **)outEntri
     }
 }
 
+- (NSDictionary *)contentsDictionary {
+    NSMutableDictionary *dictionary = [[[super contentsDictionary] mutableCopy] autorelease];
+
+    if (destination != nil) [dictionary setObject:destination forKey:@"url"];
+    if (submitter != nil) [dictionary setObject:[submitter identifier] forKey:@"user"];
+    if (body != nil) [dictionary setObject:body forKey:@"body"];
+    if (posted != nil) [dictionary setObject:posted forKey:@"date"];
+    if (title != nil) [dictionary setObject:title forKey:@"title"];
+    [dictionary setObject:[NSNumber numberWithInt:points] forKey:@"points"];
+    [dictionary setObject:[NSNumber numberWithInt:children] forKey:@"numchildren"];
+
+    return dictionary;
+}
+
 @end

Classes/HNKit/HNEntryList.h

@@ -12,6 +12,8 @@
 
 typedef NSString *HNEntryListIdentifier;
 
+#define kHNContainerLoadingStatePartial (0x1 << 17)
+
 #define kHNEntryListIdentifierSubmissions @"news"
 #define kHNEntryListIdentifierNewSubmissions @"newest"
 #define kHNEntryListIdentifierBestSubmissions @"best"

Classes/HNKit/HNEntryList.m

@@ -73,21 +73,26 @@ - (NSDictionary *)infoDictionary {
     }
 }
 
-- (void)loadFromDictionary:(NSDictionary *)response entries:(NSArray **)outEntries {
+- (void)loadContentsDictionary:(NSDictionary *)contents entries:(NSArray **)outEntries {
     NSMutableArray *children = [NSMutableArray array];
 
-    for (NSDictionary *entryDictionary in [response objectForKey:@"children"]) {
+    for (NSDictionary *entryDictionary in [contents objectForKey:@"children"]) {
         HNEntry *entry = [HNEntry entryWithIdentifier:[entryDictionary objectForKey:@"identifier"]];
-        [entry loadFromDictionary:entryDictionary];
+        [entry loadContentsDictionary:entryDictionary];
         [children addObject:entry];
-        
-        // XXX: should the entry be set to loaded here? probably not, since
-        //      it isn't fully loaded (as the loaded state represents).
+
+        [entry addLoadingState:kHNContainerLoadingStatePartial];
     }
 
     if (outEntries != NULL) {
         *outEntries = children;
     }
 }
 
+- (NSDictionary *)contentsDictionary {
+    NSMutableDictionary *dictionary = [[[super contentsDictionary] mutableCopy] autorelease];
+
+    return dictionary;
+}
+
 @end

Classes/HNKit/HNObject.h

@@ -30,6 +30,7 @@ typedef enum {
     id identifier;
     NSURL *url;
 
+    NSDate *lastUpdatedDate;
     HNObjectLoadingState loadingState;
 
     HNAPIRequest *apiRequest;
@@ -38,14 +39,7 @@ typedef enum {
 @property (nonatomic, copy) id identifier;
 @property (nonatomic, copy) NSURL *URL;
 @property (nonatomic, readonly) HNObjectLoadingState loadingState;
-
-+ (BOOL)isValidURL:(NSURL *)url_;
-+ (NSDictionary *)infoDictionaryForURL:(NSURL *)url_;
-+ (id)identifierForURL:(NSURL *)url_;
-
-+ (NSString *)pathForURLWithIdentifier:(id)identifier_ infoDictionary:(NSDictionary *)info;
-+ (NSDictionary *)parametersForURLWithIdentifier:(id)identifier_ infoDictionary:(NSDictionary *)info;
-+ (NSURL *)generateURLWithIdentifier:(id)identifier_ infoDictionary:(NSDictionary *)info;
+@property (nonatomic, readonly) NSDate *lastUpdatedDate;
 
 // These methods don't necessarily create a new instance if it's already in the
 // cache. The cache's keyed on (class, identifier, info) tuples inside HNObject.
@@ -68,16 +62,26 @@ typedef enum {
 
 @end
 
-@interface HNObject (Subclassing)
+@interface HNObject (Private)
 
-@property (nonatomic, copy) NSDictionary *contentsDictionary;
++ (NSString *)pathForURLWithIdentifier:(id)identifier_ infoDictionary:(NSDictionary *)info;
++ (NSDictionary *)parametersForURLWithIdentifier:(id)identifier_ infoDictionary:(NSDictionary *)info;
++ (NSURL *)generateURLWithIdentifier:(id)identifier_ infoDictionary:(NSDictionary *)info;
+
++ (BOOL)isValidURL:(NSURL *)url_;
++ (id)identifierForURL:(NSURL *)url_;
++ (NSDictionary *)infoDictionaryForURL:(NSURL *)url_;
 
 - (void)beginLoadingWithState:(HNObjectLoadingState)state_;
 - (void)addLoadingState:(HNObjectLoadingState)state_;
 - (void)clearLoadingState:(HNObjectLoadingState)state_;
 - (BOOL)hasLoadingState:(HNObjectLoadingState)state_;
 
+- (NSDictionary *)infoDictionary;
 - (void)loadInfoDictionary:(NSDictionary *)info;
 
+- (NSDictionary *)contentsDictionary;
+- (void)loadContentsDictionary:(NSDictionary *)contents;
+
 @end