Saving and loading tutorial state

RobertBiehl · RobertBiehl · commit 8d616a7db22c · 2015-10-08T14:11:18.000+02:00
diff --git a/FFXInteractiveTutorial/FFXInteractiveTutorial.h b/FFXInteractiveTutorial/FFXInteractiveTutorial.h
@@ -44,17 +44,38 @@
 
 @end
 
+
+@class FFXInteractiveTutorial;
+@protocol FFXInteractiveTutorialDelegate <NSObject>
+
+@optional
+
+- (BOOL) tutorial:(FFXInteractiveTutorial*) tutorial shouldFulfillItem:(NSString*)requirement;
+
+@end
+
 @interface FFXInteractiveTutorial : NSObject
 
 + (instancetype) defaultTutorial;
 
+@property (nonatomic, weak) id<FFXInteractiveTutorialDelegate> delegate;
+
 @property (nonatomic, readonly) FFXInteractiveTutorialMetrics* metrics;
 
-- (instancetype)initWithWindow:(UIWindow*) window items:(NSArray<FFXInteractiveTutorialItem*>*)tutorialItems;
+/**
+ *  Load previous tutorial state
+ *
+ *  @param window
+ *
+ *  @return tutorial instance or nil
+ */
++ (instancetype) restoreTutorialInWindow:(UIWindow*) window;
+
+- (instancetype) initWithWindow:(UIWindow*) window items:(NSArray<FFXInteractiveTutorialItem*>*)tutorialItems;
 
-- (instancetype)initWithWindow:(UIWindow*) window file:(NSString*) path;
+- (instancetype) initWithWindow:(UIWindow*) window file:(NSString*) path;
 
-- (void) fullfillItemWithIdentifier:(NSString*) identifier;
+- (void) fulfillItemWithIdentifier:(NSString*) identifier;
 
 /**
  *  Enable the tutorial and start scanning the view hierarchy for tutorial elements
@@ -66,4 +87,9 @@
  */
 - (void) stop;
 
+/**
+ *  Save the tutorial state to restore it later with restoreTutorialInWindow:
+ */
+- (void) save;
+
 @end
diff --git a/FFXInteractiveTutorial/FFXInteractiveTutorial.m b/FFXInteractiveTutorial/FFXInteractiveTutorial.m
@@ -17,6 +17,8 @@
 
 #define FFX_INTERACTIVE_TUTORIAL_HIDE_ITEM_INTERVAL 60.0
 
+NSString* const FFXInteractiveTutorialStorageKey = @"FFXInteractiveTutorial";
+
 @implementation FFXInteractiveTutorialMetrics
 @end
 
@@ -86,6 +88,28 @@ - (FFXInteractiveTutorialMetrics*) defaultMetrics{
 
 static FFXInteractiveTutorial *defaultTutorial = nil;
 
++ (instancetype)restoreTutorialInWindow:(UIWindow *)window{
+    NSUserDefaults* defaults = [NSUserDefaults standardUserDefaults];
+    id data = [defaults objectForKey:FFXInteractiveTutorialStorageKey];
+    if ([data isKindOfClass:[NSData class]]) {
+        NSError* error = nil;
+        id obj = [NSKeyedUnarchiver unarchiveObjectWithData:data];
+        if([obj isKindOfClass:[NSArray class]]){
+            NSArray* items = obj;
+            // ensure correct class
+            for (id item in items) {
+                if (![item isKindOfClass:[FFXInteractiveTutorialItem class]]) {
+                    return nil;
+                }
+            }
+            NSLog(@"loaded items: %@", items);
+            return [[FFXInteractiveTutorial alloc] initWithWindow:window items:items];
+        }
+    }
+    
+    return nil;
+}
+
 + (instancetype) defaultTutorial{
     return defaultTutorial;
 }
@@ -142,6 +166,21 @@ -(void)setWindow:(UIWindow *)window{
 
 - (void)start{
     if (!_timer) {
+        // revalidate tutorial items
+        if ([self.delegate respondsToSelector:@selector(tutorial:shouldFulfillItem:)]) {
+            for (FFXInteractiveTutorialItem* item in self.items) {
+                FFXInteractiveTutorialItem* theItem = item;
+                while (theItem) {
+                    BOOL fulfilled = [self.delegate tutorial:self shouldFulfillItem:theItem.identifier];
+                    if (fulfilled) {
+                        [theItem fulfill];
+                    }
+                    theItem = theItem.nextItem;
+                }
+            }
+        }
+        
+        // set up timer
         _timer = [NSTimer scheduledTimerWithTimeInterval:0.1 target:self selector:@selector(triggerCheck) userInfo:nil repeats:YES];
     }
 }
@@ -151,6 +190,13 @@ - (void)stop{
     _timer = nil;
 }
 
+- (void)save{
+    NSUserDefaults* defaults = [NSUserDefaults standardUserDefaults];
+    [defaults setValue:[NSKeyedArchiver archivedDataWithRootObject:self.items] forKey:FFXInteractiveTutorialStorageKey];
+    NSLog(@"stored items: %@", self.items);
+    [defaults synchronize];
+}
+
 -(void)triggerCheck{
     NSMutableArray* candidates = [NSMutableArray array];
     
@@ -212,7 +258,7 @@ -(void)triggerCheck{
     [self showItems:self.activeItems];
 }
 
-- (void)fullfillItemWithIdentifier:(NSString *)identifier{
+- (void)fulfillItemWithIdentifier:(NSString *)identifier{
     NSUInteger index = [self.items indexOfObjectPassingTest:^BOOL(FFXInteractiveTutorialItem* _Nonnull item, NSUInteger idx, BOOL * _Nonnull stop) {
         return [item.identifier isEqualToString:identifier];
     }];
diff --git a/FFXInteractiveTutorial/FFXInteractiveTutorialItem.h b/FFXInteractiveTutorial/FFXInteractiveTutorialItem.h
@@ -30,7 +30,7 @@ typedef enum : NSUInteger {
     FFXTutorialItemFullfillmentInteractionDefault = FFXTutorialItemFullfillmentInteractionCustom,
 } FFXTutorialItemFullfillmentInteraction;
 
-@interface FFXInteractiveTutorialItem : NSObject<NSCopying>
+@interface FFXInteractiveTutorialItem : NSObject<NSCopying,NSCoding>
 
 + (instancetype) itemWithIdentifier:(NSString*)identifier viewPath:(NSString*)viewPath title:(NSString*)title;
 
diff --git a/FFXInteractiveTutorial/FFXInteractiveTutorialItem.m b/FFXInteractiveTutorial/FFXInteractiveTutorialItem.m
@@ -53,8 +53,8 @@ - (instancetype) initWithIdentifier:(NSString *)identifier viewPath:(NSString *)
 }
 
 - (NSString *)description{
-    return [NSString stringWithFormat:@"<%@: %p, identifier:%@; viewPath: %@>",
-            NSStringFromClass([self class]), self, self.identifier, self.viewPath];
+    return [NSString stringWithFormat:@"<%@: %p, identifier:%@; viewPath: %@; active: %d;>",
+            NSStringFromClass([self class]), self, self.identifier, self.viewPath, self.active];
 }
 
 - (void)setValue:(id)value forKey:(NSString *)key{
@@ -126,4 +126,28 @@ - (id)copyWithZone:(NSZone *)zone{
     return copy;
 }
 
+#pragma mark NSCoding
+
+- (instancetype)initWithCoder:(NSCoder *)aDecoder{
+    self = [super init];
+    if (self) {
+        self.identifier = [aDecoder decodeObjectForKey:@"identifier"];
+        self.viewPath = [aDecoder decodeObjectForKey:@"viewPath"];
+        self.title = [aDecoder decodeObjectForKey:@"title"];
+        self.subtitle = [aDecoder decodeObjectForKey:@"subtitle"];
+        self.unique = [aDecoder decodeBoolForKey:@"unique"];
+        self.highlightView = [aDecoder decodeBoolForKey:@"highlightView"];
+    }
+    return self;
+}
+
+- (void)encodeWithCoder:(NSCoder *)aCoder{
+    [aCoder encodeObject:self.identifier forKey:@"identifier"];
+    [aCoder encodeObject:self.viewPath forKey:@"viewPath"];
+    [aCoder encodeObject:self.title forKey:@"title"];
+    [aCoder encodeObject:self.subtitle forKey:@"subtitle"];
+    [aCoder encodeBool:self.unique forKey:@"unique"];
+    [aCoder encodeBool:self.highlightView forKey:@"highlightView"];
+}
+
 @end
