Remove convenience initializers and add documentaion

Author: Andres Ugarte

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.m

@@ -87,13 +87,14 @@ + (void)start {
 
 #ifdef REMIXER_CLOUD_FIREBASE
   instance.remoteController = [[RMXFirebaseRemoteController alloc] init];
-  [instance.remoteController setup];
   [instance.remoteController startObservingUpdates];
 #endif
 }
 
 + (void)stop {
-  // No-op
+#ifdef REMIXER_CLOUD_FIREBASE
+  [[[self sharedInstance] remoteController] stopObservingUpdates];
+#endif
 }
 
 + (NSString *)sessionId {

src/core/remixes/RMXColorVariable.h

@@ -36,7 +36,7 @@ typedef void (^RMXColorUpdateBlock)(RMXColorVariable *variable, UIColor *selecte
 /** Designated initializer. */
 + (instancetype)colorVariableWithKey:(NSString *)key
                         defaultValue:(UIColor *)defaultValue
-                      possibleValues:(NSArray<UIColor *> *)possibleValues
+                      possibleValues:(nullable NSArray<UIColor *> *)possibleValues
                          updateBlock:(RMXColorUpdateBlock)updateBlock;
 
 @end

src/core/remixes/RMXNumberVariable.h

@@ -37,7 +37,7 @@ typedef void (^RMXNumberUpdateBlock)(RMXNumberVariable *variable, CGFloat select
 /** Designated initializer. */
 + (instancetype)numberVariableWithKey:(NSString *)key
                          defaultValue:(CGFloat)defaultValue
-                       possibleValues:(NSArray<NSNumber *> *)possibleValues
+                       possibleValues:(nullable NSArray<NSNumber *> *)possibleValues
                           updateBlock:(RMXNumberUpdateBlock)updateBlock;
 
 @end

src/core/remixes/RMXStringVariable.h

@@ -34,7 +34,7 @@ typedef void (^RMXStringUpdateBlock)(RMXStringVariable *variable, NSString *sele
 /** Designated initializer. */
 + (instancetype)stringVariableWithKey:(NSString *)key
                          defaultValue:(NSString *)defaultValue
-                       possibleValues:(NSArray<NSString *> *)possibleValues
+                       possibleValues:(nullable NSArray<NSString *> *)possibleValues
                           updateBlock:(RMXStringUpdateBlock)updateBlock;
 
 @end

src/core/remote/RMXFirebaseRemoteController.h

@@ -19,6 +19,7 @@
 
 @class RMXVariable;
 
+/** A Firebase implementation of Remote Controllers.  */
 @interface RMXFirebaseRemoteController : NSObject<RMXRemoteController>
 
 @end

src/core/remote/RMXFirebaseRemoteController.m

@@ -25,9 +25,9 @@
 #import "RMXRemixer.h"
 
 static NSString *const kFirebasePath = @"Remixer";
-static NSString *const kFirebaseDeviceKey = @"device_id";
 
 @implementation RMXFirebaseRemoteController {
+  NSString *_deviceKey;
   FIRDatabaseReference *_ref;
   NSMutableDictionary<NSString *, RMXVariable *> *_storedVariables;
 }
@@ -41,14 +41,13 @@ + (instancetype)sharedInstance {
   return sharedInstance;
 }
 
-- (void)setup {
+- (void)startObservingUpdates {
+  _deviceKey = [[[NSUUID UUID] UUIDString] substringToIndex:8];
   [FIRApp configure];
   _ref = [[FIRDatabase database] referenceWithPath:kFirebasePath];
   _storedVariables = [NSMutableDictionary dictionary];
-}
 
-- (void)startObservingUpdates {
-  [[_ref child:kFirebaseDeviceKey]
+  [[_ref child:_deviceKey]
        observeEventType:FIRDataEventTypeChildChanged
        withBlock:^(FIRDataSnapshot *_Nonnull snapshot) {
          NSDictionary *jsonDictionary = snapshot.value;
@@ -61,27 +60,23 @@ - (void)startObservingUpdates {
 }
 
 - (void)stopObservingUpdates {
-  [[_ref child:kFirebaseDeviceKey] removeAllObservers];
-}
-
-- (void)shutDown {
-  // No-op.
+  [[_ref child:_deviceKey] removeAllObservers];
 }
 
 - (void)addVariable:(RMXVariable *)variable {
-  [[[_ref child:kFirebaseDeviceKey] child:variable.key] setValue:[variable toJSON]];
+  [[[_ref child:_deviceKey] child:variable.key] setValue:[variable toJSON]];
 }
 
 - (void)updateVariable:(RMXVariable *)variable {
-  [[[_ref child:kFirebaseDeviceKey] child:variable.key] setValue:[variable toJSON]];
+  [[[_ref child:_deviceKey] child:variable.key] setValue:[variable toJSON]];
 }
 
 - (void)removeVariable:(RMXVariable *)variable {
-  [[[_ref child:kFirebaseDeviceKey] child:variable.key] removeValue];
+  [[[_ref child:_deviceKey] child:variable.key] removeValue];
 }
 
 - (void)removeAllVariables {
-  [[_ref child:kFirebaseDeviceKey] removeValue];
+  [[_ref child:_deviceKey] removeValue];
 }
 
 @end

src/core/remote/RMXRemoteController.h

@@ -18,20 +18,28 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-/** */
+/** Interface for the different types of remote controllers supported by Remixer */
 @protocol RMXRemoteController <NSObject>
 
 @required
 
+/** Called when Remixer is ready to start receiving updates from remote controllers */
+- (void)startObservingUpdates;
+
+/** Called when Remixer wants to stop receiving updates from remote controllers */
+- (void)stopObservingUpdates;
+
+/** Adds a variable to the remote controllers */
 - (void)addVariable:(RMXVariable *)variable;
+
+/** Updates a variable in the remote controllers */
 - (void)updateVariable:(RMXVariable *)variable;
+
+/** Removes a variable from the remote controllers */
 - (void)removeVariable:(RMXVariable *)variable;
-- (void)removeAllVariables;
 
-- (void)setup;
-- (void)startObservingUpdates;
-- (void)stopObservingUpdates;
-- (void)shutDown;
+/** Removes all variables from the remote controllers */
+- (void)removeAllVariables;
 
 @end
 

src/core/storage/RMXStorageController.h

@@ -18,13 +18,21 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-/** Interface for they different types of storage supported by Remixer. */
+/** Interface for the different types of storage options supported by Remixer. */
 @protocol RMXStorageController <NSObject>
 
 @required
 
+/**
+ Retrieves the saved value for a variable's key
+ @param key The variable's key
+ */
 - (nullable id)selectedValueForVariableKey:(NSString *)key;
 
+/**
+ Saves the selected value of the variable
+ @param variable The variable whos selected value we want to save
+ */
 - (void)saveSelectedValueOfVariable:(RMXVariable *)variable;
 
 @end