Merge pull request #68 from material-foundation/firebase_v1_a

Add support for remote controllers and delete old code

Author: Andrés

examples/objc/RemixerExample/AppDelegate.m

@@ -35,7 +35,7 @@ - (BOOL)application:(UIApplication *)application
   [self.window makeKeyAndVisible];
 
   // Start Remixer.
-  [RMXRemixer startInMode:RMXStorageModeLocal];
+  [RMXRemixer start];
 
   return YES;
 }

examples/objc/RemixerExample/FontViewController.m

@@ -37,6 +37,7 @@ - (void)viewDidLoad {
 
   [RMXStringVariable stringVariableWithKey:@"labelText"
                               defaultValue:@"This is a customizable label"
+                            possibleValues:nil
                                updateBlock:^(RMXStringVariable *variable, NSString *selectedValue) {
                                  _fontLabel.text = selectedValue;
                                  [self.view setNeedsLayout];

src/core/RMXRemixer.h

@@ -20,8 +20,6 @@
 
 @class RMXOverlayWindow;
 
-typedef NS_ENUM(NSInteger, RMXStorageMode) { RMXStorageModeLocal = 0, RMXStorageModeCloud = 1 };
-
 NS_ASSUME_NONNULL_BEGIN
 
 /**
@@ -31,14 +29,11 @@ NS_ASSUME_NONNULL_BEGIN
 @interface RMXRemixer : NSObject
 
 /** Starts Remixer */
-+ (void)startInMode:(RMXStorageMode)mode;
++ (void)start;
 
 /** Stops the current Remixer session. */
 + (void)stop;
 
-/** Sends an invitation to the web dashboard. */
-+ (void)sendEmailInvite;
-
 /** A unique session id. */
 + (NSString *)sessionId;
 
@@ -82,11 +77,17 @@ NS_ASSUME_NONNULL_BEGIN
 /** Removes all Variables and empties the dictionary of Variables. */
 + (void)removeAllVariables;
 
-/** Saves the Variable using one of the storage options. */
+/**
+ Saves the Variable using one of the storage options.
+ @param variable The variable to save.
+ */
 + (void)saveVariable:(RMXVariable *)variable;
 
-/** Update an existing Variable using a version from one of our storage sources. */
-+ (void)updateVariable:(RMXVariable *)variable usingStoredVariable:(RMXVariable *)storedVariable;
+/**
+ Sets and saves the updated selectedValue and triggers a notification to update the control.
+ @param value The new value that the variable should be set to.
+ */
++ (void)updateVariable:(RMXVariable *)variable fromRemoteControllerToValue:(id)value;
 
 @end
 

src/core/RMXRemixer.m

@@ -21,12 +21,13 @@
 #import "RMXRemixer.h"
 
 #import "RMXLocalStorageController.h"
+#import "RMXRemoteController.h"
 #import "RMXVariable.h"
 #import "UI/RMXOverlayViewController.h"
 #import "UI/RMXOverlayWindow.h"
 
 #ifdef REMIXER_CLOUD_FIREBASE
-#import "RMXFirebaseStorageController.h"
+#import "RMXFirebaseRemoteController.h"
 #endif
 
 #if TARGET_OS_SIMULATOR
@@ -37,8 +38,8 @@
 
 @interface RMXRemixer () <UIGestureRecognizerDelegate>
 @property(nonatomic, strong) NSMutableDictionary *variables;
-@property(nonatomic, assign) RMXStorageMode storageMode;
 @property(nonatomic, strong) id<RMXStorageController> storage;
+@property(nonatomic, strong) id<RMXRemoteController> remoteController;
 @property(nonatomic, strong) RMXOverlayViewController *overlayController;
 @property(nonatomic, strong) UISwipeGestureRecognizer *swipeUpGesture;
 @property(nonatomic, strong) RMXOverlayWindow *overlayWindow;
@@ -63,12 +64,6 @@ + (instancetype)sharedInstance {
   return sharedInstance;
 }
 
-+ (void)startInMode:(RMXStorageMode)mode {
-  RMXRemixer *instance = [self sharedInstance];
-  instance.storageMode = mode;
-  [self start];
-}
-
 + (void)start {
   UIWindow *keyWindow = [[UIApplication sharedApplication] keyWindow];
   if (!keyWindow) {
@@ -88,24 +83,18 @@ + (void)start {
   instance.overlayController = [[RMXOverlayViewController alloc] init];
   instance.overlayWindow.rootViewController = instance.overlayController;
 
-  if (instance.storageMode == RMXStorageModeLocal) {
-    instance.storage = [[RMXLocalStorageController alloc] init];
-  } else {
+  instance.storage = [[RMXLocalStorageController alloc] init];
+
 #ifdef REMIXER_CLOUD_FIREBASE
-    instance.storage = [[RMXFirebaseStorageController alloc] init];
-#else
-    instance.storage = [[RMXLocalStorageController alloc] init];
-// TODO(chuga): Print out a warning.
+  instance.remoteController = [[RMXFirebaseRemoteController alloc] init];
+  [instance.remoteController startObservingUpdates];
 #endif
-  }
-  [instance.storage setup];
-  [instance.storage startObservingUpdates];
 }
 
 + (void)stop {
-  RMXRemixer *instance = [self sharedInstance];
-  [instance.storage stopObservingUpdates];
-  [instance.storage shutDown];
+#ifdef REMIXER_CLOUD_FIREBASE
+  [[[self sharedInstance] remoteController] stopObservingUpdates];
+#endif
 }
 
 + (NSString *)sessionId {
@@ -141,22 +130,6 @@ - (void)didSwipe:(UISwipeGestureRecognizer *)recognizer {
   [_overlayController showPanelAnimated:YES];
 }
 
-#pragma mark - Email
-
-+ (void)sendEmailInvite {
-  // Genrates a mailto: URL string.
-  NSString *sessionId = [self sessionId];
-  NSString *remixerURL =
-      [NSString stringWithFormat:@"https://remix-4d1f9.firebaseapp.com/#/composer/%@", sessionId];
-  NSString *subject = [NSString stringWithFormat:@"Invitation to Remixer session %@", sessionId];
-  NSString *body = [NSString stringWithFormat:@"You have been invited to a Remixer session. \n\n"
-                                              @"Follow this link to log in: <a href='%@'>%@</a>",
-                                              remixerURL, sessionId];
-  NSString *mailTo = [NSString stringWithFormat:@"mailto:?subject=%@&body=%@", subject, body];
-  NSString *url = [mailTo stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
-  [[UIApplication sharedApplication] openURL:[NSURL URLWithString:url]];
-}
-
 #pragma mark - Variables
 
 + (nullable RMXVariable *)variableForKey:(NSString *)key {
@@ -167,9 +140,9 @@ + (__kindof RMXVariable *)addVariable:(RMXVariable *)variable {
   RMXVariable *existingVariable = [self variableForKey:variable.key];
   if (!existingVariable) {
     [[[self sharedInstance] variables] setObject:variable forKey:variable.key];
-    RMXVariable *storedVariable = [[[self sharedInstance] storage] variableForKey:variable.key];
-    if (storedVariable) {
-      [self updateVariable:variable usingStoredVariable:storedVariable];
+    id storedValue = [[[self sharedInstance] storage] selectedValueForVariableKey:variable.key];
+    if (storedValue) {
+      [variable setSelectedValue:storedValue];
     } else {
       [variable executeUpdateBlocks];
     }
@@ -178,39 +151,44 @@ + (__kindof RMXVariable *)addVariable:(RMXVariable *)variable {
     variable = existingVariable;
   }
 
-  // TODO(chuga): Figure out when and how to do the initial |saveRemix|.
+  [[[self sharedInstance] remoteController] addVariable:variable];
   [[[self sharedInstance] overlayController] reloadData];
   return variable;
 }
 
 + (void)removeVariable:(RMXVariable *)variable {
   [[[self sharedInstance] variables] removeObjectForKey:variable.key];
+  [[[self sharedInstance] remoteController] removeVariable:variable];
 }
 
 + (void)removeVariableWithKey:(NSString *)key {
   RMXVariable *variable = [self variableForKey:key];
   [[self sharedInstance] removeVariable:variable];
-}
-
-+ (NSArray<RMXVariable *> *)allVariables {
-  return [[[self sharedInstance] variables] allValues];
+  [[[self sharedInstance] remoteController] removeVariable:variable];
 }
 
 + (void)removeAllVariables {
   [[[self sharedInstance] variables] removeAllObjects];
   [[[self sharedInstance] overlayController] reloadData];
+  [[[self sharedInstance] remoteController] removeAllVariables];
+}
+
++ (NSArray<RMXVariable *> *)allVariables {
+  return [[[self sharedInstance] variables] allValues];
 }
 
 + (void)saveVariable:(RMXVariable *)variable {
-  [[[self sharedInstance] storage] saveVariable:variable];
+  [[[self sharedInstance] storage] saveSelectedValueOfVariable:variable];
+  [[[self sharedInstance] remoteController] updateVariable:variable];
 }
 
-+ (void)updateVariable:(RMXVariable *)variable usingStoredVariable:(RMXVariable *)storedVariable {
-  RMXRemixer *instance = [self sharedInstance];
-  if (instance.storageMode == RMXStorageModeCloud) {
-    [variable updateToStoredVariable:storedVariable];
-  } else {
-    [variable setSelectedValue:storedVariable.selectedValue];
++ (void)updateVariable:(RMXVariable *)variable fromRemoteControllerToValue:(id)value {
+  // TODO(chuga): Improve this check for equality.
+  if (![variable.selectedValue isEqual:value]) {
+    [variable setSelectedValue:value];
+    [[NSNotificationCenter defaultCenter] postNotificationName:RMXVariableUpdateNotification
+                                                        object:variable];
+    [[[self sharedInstance] storage] saveSelectedValueOfVariable:variable];
   }
 }
 

src/core/UI/RMXOverlayViewController.m

@@ -91,9 +91,6 @@ - (void)viewDidLoad {
   [(UIButton *)item.leftBarButtonItem.customView addTarget:self
                                                     action:@selector(dismissOverlay:)
                                           forControlEvents:UIControlEventTouchUpInside];
-  [(UIButton *)item.rightBarButtonItem.customView addTarget:self
-                                                     action:@selector(sendEmailInvite:)
-                                           forControlEvents:UIControlEventTouchUpInside];
   _panGestureRecognizer =
       [[UIPanGestureRecognizer alloc] initWithTarget:self action:@selector(didPan:)];
   _panGestureRecognizer.delegate = self;
@@ -228,10 +225,6 @@ - (void)reloadData {
   [self.view.tableView reloadData];
 }
 
-- (void)sendEmailInvite:(id)sender {
-  [RMXRemixer sendEmailInvite];
-}
-
 #pragma mark - UITableViewDataSource
 
 - (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {

src/core/UI/cells/RMXCellStepper.m

@@ -95,6 +95,7 @@ - (void)layoutSubviews {
 - (void)stepperUpdated:(UIStepper *)stepperControl {
   [self.variable setSelectedFloatValue:stepperControl.value];
   [self.variable save];
+  self.textLabel.text = [NSString stringWithFormat:@"%.2f", self.variable.selectedFloatValue];
 }
 
 @end

src/core/remixes/RMXBooleanVariable.m

@@ -28,12 +28,6 @@ + (instancetype)booleanVariableWithKey:(NSString *)key
   return [RMXRemixer addVariable:variable];
 }
 
-+ (instancetype)variableFromDictionary:(NSDictionary *)dictionary {
-  NSString *key = [dictionary objectForKey:RMXDictionaryKeyKey];
-  BOOL selectedValue = [[dictionary objectForKey:RMXDictionaryKeySelectedValue] boolValue];
-  return [[self alloc] initWithKey:key defaultValue:selectedValue updateBlock:nil];
-}
-
 - (NSDictionary *)toJSON {
   NSMutableDictionary *json = [super toJSON];
   json[RMXDictionaryKeySelectedValue] = @([self selectedBooleanValue]);

src/core/remixes/RMXColorVariable.h

@@ -36,15 +36,7 @@ typedef void (^RMXColorUpdateBlock)(RMXColorVariable *variable, UIColor *selecte
 /** Designated initializer. */
 + (instancetype)colorVariableWithKey:(NSString *)key
                         defaultValue:(UIColor *)defaultValue
-                      possibleValues:(NSArray<UIColor *> *)possibleValues
-                         updateBlock:(RMXColorUpdateBlock)updateBlock;
-
-/**
- * Convenience initializer for when this Variable isn't limited to a set of possible values or when
- * those values are defined in the cloud.
- */
-+ (instancetype)colorVariableWithKey:(NSString *)key
-                        defaultValue:(UIColor *)defaultValue
+                      possibleValues:(nullable NSArray<UIColor *> *)possibleValues
                          updateBlock:(RMXColorUpdateBlock)updateBlock;
 
 @end

src/core/remixes/RMXColorVariable.m

@@ -43,31 +43,6 @@ + (instancetype)colorVariableWithKey:(NSString *)key
   return variable;
 }
 
-+ (instancetype)colorVariableWithKey:(NSString *)key
-                        defaultValue:(UIColor *)defaultValue
-                         updateBlock:(RMXColorUpdateBlock)updateBlock {
-  // These default values are just temporary. We change them to the right values as soon as we
-  // get the data from the cloud service.
-  RMXColorVariable *variable = [[self alloc] initWithKey:key
-                                            defaultValue:defaultValue
-                                          possibleValues:nil
-                                             updateBlock:updateBlock];
-  return [RMXRemixer addVariable:variable];
-}
-
-+ (instancetype)variableFromDictionary:(NSDictionary *)dictionary {
-  id selectedValue = [dictionary objectForKey:RMXDictionaryKeySelectedValue];
-  selectedValue = [self colorFromRGBADictionary:selectedValue];
-  NSMutableArray *possibleValues = [NSMutableArray array];
-  for (NSDictionary *colorDict in [dictionary objectForKey:RMXDictionaryKeyPossibleValues]) {
-    [possibleValues addObject:[self colorFromRGBADictionary:colorDict]];
-  }
-  return [[self alloc] initWithKey:[dictionary objectForKey:RMXDictionaryKeyKey]
-                      defaultValue:selectedValue
-                    possibleValues:possibleValues
-                       updateBlock:nil];
-}
-
 - (NSDictionary *)toJSON {
   NSMutableDictionary *json = [super toJSON];
   json[RMXDictionaryKeySelectedValue] = [[self class] rgbaDictionaryFromColor:self.selectedValue];
@@ -77,10 +52,11 @@ - (NSDictionary *)toJSON {
   return json;
 }
 
-- (void)updateToStoredVariable:(RMXVariable *)storedVariable {
-  self.controlType =
-      storedVariable.possibleValues.count > 0 ? RMXControlTypeColorList : RMXControlTypeColorPicker;
-  [super updateToStoredVariable:storedVariable];
+- (void)setSelectedValue:(id)selectedValue {
+  if ([selectedValue isKindOfClass:[NSDictionary class]]) {
+    selectedValue = [[self class] colorFromRGBADictionary:selectedValue];
+  }
+  [super setSelectedValue:selectedValue];
 }
 
 #pragma mark - Private

src/core/remixes/RMXNumberVariable.h

@@ -37,15 +37,7 @@ typedef void (^RMXNumberUpdateBlock)(RMXNumberVariable *variable, CGFloat select
 /** Designated initializer. */
 + (instancetype)numberVariableWithKey:(NSString *)key
                          defaultValue:(CGFloat)defaultValue
-                       possibleValues:(NSArray<NSNumber *> *)possibleValues
-                          updateBlock:(RMXNumberUpdateBlock)updateBlock;
-
-/**
- * Convenience initializer for when this Variable isn't limited to a set of possible values or when
- * those values are defined in the cloud.
- */
-+ (instancetype)numberVariableWithKey:(NSString *)key
-                         defaultValue:(CGFloat)defaultValue
+                       possibleValues:(nullable NSArray<NSNumber *> *)possibleValues
                           updateBlock:(RMXNumberUpdateBlock)updateBlock;
 
 @end