de-duplicate code, at the cost of exposing everything publicly

morganchen12 · morganchen12 · commit cdb1207bcf2c · 2016-11-07T11:33:23.000-08:00
diff --git a/FirebaseDatabaseUI/FUIArray.h b/FirebaseDatabaseUI/FUIArray.h
@@ -66,7 +66,7 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  * The items currently in the array.
  */
-@property(nonatomic, readonly, copy) NSArray *items;
+@property (nonatomic, readonly, copy) NSArray *items;
 
 #pragma mark - Initializer methods
 
@@ -135,6 +135,42 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (NSUInteger)indexForKey:(NSString *)key;
 
+/**
+ * Called when the Firebase query sends a FIRDataEventTypeChildAdded event. Override this
+ * to provide custom insertion logic.
+ * @param snap The snapshot that was inserted.
+ * @param previous The key of the sibling preceding the inserted snapshot.
+ */
+- (void)insertSnapshot:(FIRDataSnapshot *)snap withPreviousChildKey:(nullable NSString *)previous;
+
+/**
+ * Called when the Firebase query sends a FIRDataEventTypeChildRemoved event. Override this
+ * to provide custom removal logic.
+ * @param snap The snapshot that was removed.
+ * @param previous The key of the sibling preceding the removed snapshot.
+ */
+- (void)removeSnapshot:(FIRDataSnapshot *)snap withPreviousChildKey:(nullable NSString *)previous;
+
+/**
+ * Called when the Firebase query sends a FIRDataEventTypeChildChanged event. Override this
+ * to provide custom on change logic.
+ * @param snap The snapshot whose value was changed.
+ * @param previous The key of the sibling preceding the changed snapshot.
+ */
+- (void)changeSnapshot:(FIRDataSnapshot *)snap withPreviousChildKey:(nullable NSString *)previous;
+
+/**
+ * Called when the Firebase query sends a FIRDataEventTypeChildMoved event. Override this
+ * to provide custom move logic.
+ * @param snap The snapshot that was moved.
+ * @param previous The key of the sibling preceding the moved snapshot at its new location.
+ */
+- (void)moveSnapshot:(FIRDataSnapshot *)snap withPreviousChildKey:(nullable NSString *)previous;
+
+- (void)removeSnapshotAtIndex:(NSUInteger)index;
+- (void)insertSnapshot:(FIRDataSnapshot *)snap atIndex:(NSUInteger)index;
+- (void)addSnapshot:(FIRDataSnapshot *)snap;
+
 @end
 
 NS_ASSUME_NONNULL_END
diff --git a/FirebaseDatabaseUI/FUIArray.m b/FirebaseDatabaseUI/FUIArray.m
@@ -25,13 +25,13 @@ @interface FUIArray ()
 /**
  * The backing collection that holds all of the array's data.
  */
-@property(strong, nonatomic) NSMutableArray<FIRDataSnapshot *> *snapshots;
+@property (strong, nonatomic) NSMutableArray<FIRDataSnapshot *> *snapshots;
 
 /**
  * A set containing the query observer handles that should be released when
  * this array is freed.
  */
-@property(strong, nonatomic) NSMutableSet<NSNumber *> *handles;
+@property (strong, nonatomic) NSMutableSet<NSNumber *> *handles;
 
 @end
 
@@ -72,16 +72,7 @@ - (void)observeQuery {
   FIRDatabaseHandle handle;
   handle = [self.query observeEventType:FIRDataEventTypeChildAdded
       andPreviousSiblingKeyWithBlock:^(FIRDataSnapshot *snapshot, NSString *previousChildKey) {
-        NSUInteger index = 0;
-        if (previousChildKey != nil) {
-          index = [self indexForKey:previousChildKey] + 1;
-        }
-
-        [self.snapshots insertObject:snapshot atIndex:index];
-
-        if ([self.delegate respondsToSelector:@selector(array:didAddObject:atIndex:)]) {
-          [self.delegate array:self didAddObject:snapshot atIndex:index];
-        }
+        [self insertSnapshot:snapshot withPreviousChildKey:previousChildKey];
       }
       withCancelBlock:^(NSError *error) {
         if ([self.delegate respondsToSelector:@selector(array:queryCancelledWithError:)]) {
@@ -92,13 +83,7 @@ - (void)observeQuery {
 
   handle = [self.query observeEventType:FIRDataEventTypeChildChanged
       andPreviousSiblingKeyWithBlock:^(FIRDataSnapshot *snapshot, NSString *previousChildKey) {
-        NSUInteger index = [self indexForKey:snapshot.key];
-
-        [self.snapshots replaceObjectAtIndex:index withObject:snapshot];
-
-        if ([self.delegate respondsToSelector:@selector(array:didChangeObject:atIndex:)]) {
-          [self.delegate array:self didChangeObject:snapshot atIndex:index];
-        }
+        [self changeSnapshot:snapshot withPreviousChildKey:previousChildKey];
       }
       withCancelBlock:^(NSError *error) {
         if ([self.delegate respondsToSelector:@selector(array:queryCancelledWithError:)]) {
@@ -109,13 +94,7 @@ - (void)observeQuery {
 
   handle = [self.query observeEventType:FIRDataEventTypeChildRemoved
       andPreviousSiblingKeyWithBlock:^(FIRDataSnapshot *snapshot, NSString *previousSiblingKey) {
-        NSUInteger index = [self indexForKey:snapshot.key];
-
-        [self.snapshots removeObjectAtIndex:index];
-
-        if ([self.delegate respondsToSelector:@selector(array:didRemoveObject:atIndex:)]) {
-          [self.delegate array:self didRemoveObject:snapshot atIndex:index];
-        }
+        [self removeSnapshot:snapshot withPreviousChildKey:previousSiblingKey];
       }
       withCancelBlock:^(NSError *error) {
         if ([self.delegate respondsToSelector:@selector(array:queryCancelledWithError:)]) {
@@ -126,22 +105,7 @@ - (void)observeQuery {
 
   handle = [self.query observeEventType:FIRDataEventTypeChildMoved
       andPreviousSiblingKeyWithBlock:^(FIRDataSnapshot *snapshot, NSString *previousChildKey) {
-        NSUInteger fromIndex = [self indexForKey:snapshot.key];
-        [self.snapshots removeObjectAtIndex:fromIndex];
-
-        NSUInteger toIndex = 0;
-        if (previousChildKey != nil) {
-            NSUInteger prevIndex = [self indexForKey:previousChildKey];
-            if (prevIndex != NSNotFound) {
-                toIndex = prevIndex + 1;
-            }
-        }
-
-        [self.snapshots insertObject:snapshot atIndex:toIndex];
-
-        if ([self.delegate respondsToSelector:@selector(array:didMoveObject:fromIndex:toIndex:)]) {
-          [self.delegate array:self didMoveObject:snapshot fromIndex:fromIndex toIndex:toIndex];
-        }
+        [self moveSnapshot:snapshot withPreviousChildKey:previousChildKey];
       }
       withCancelBlock:^(NSError *error) {
         if ([self.delegate respondsToSelector:@selector(array:queryCancelledWithError:)]) {
@@ -168,6 +132,69 @@ - (NSUInteger)indexForKey:(NSString *)key {
   return NSNotFound;
 }
 
+- (void)insertSnapshot:(FIRDataSnapshot *)snap withPreviousChildKey:(NSString *)previous {
+  NSUInteger index = 0;
+  if (previous != nil) {
+    index = [self indexForKey:previous] + 1;
+  }
+
+  [self.snapshots insertObject:snap atIndex:index];
+
+  if ([self.delegate respondsToSelector:@selector(array:didAddObject:atIndex:)]) {
+    [self.delegate array:self didAddObject:snap atIndex:index];
+  }
+}
+
+- (void)removeSnapshot:(FIRDataSnapshot *)snap withPreviousChildKey:(NSString *)previous {
+  NSUInteger index = [self indexForKey:snap.key];
+
+  [self.snapshots removeObjectAtIndex:index];
+
+  if ([self.delegate respondsToSelector:@selector(array:didRemoveObject:atIndex:)]) {
+    [self.delegate array:self didRemoveObject:snap atIndex:index];
+  }
+}
+
+- (void)changeSnapshot:(FIRDataSnapshot *)snap withPreviousChildKey:(NSString *)previous {
+  NSUInteger index = [self indexForKey:snap.key];
+
+  [self.snapshots replaceObjectAtIndex:index withObject:snap];
+
+  if ([self.delegate respondsToSelector:@selector(array:didChangeObject:atIndex:)]) {
+    [self.delegate array:self didChangeObject:snap atIndex:index];
+  }
+}
+
+- (void)moveSnapshot:(FIRDataSnapshot *)snap withPreviousChildKey:(NSString *)previous {
+  NSUInteger fromIndex = [self indexForKey:snap.key];
+  [self.snapshots removeObjectAtIndex:fromIndex];
+
+  NSUInteger toIndex = 0;
+  if (previous != nil) {
+    NSUInteger prevIndex = [self indexForKey:previous];
+    if (prevIndex != NSNotFound) {
+      toIndex = prevIndex + 1;
+    }
+  }
+  [self.snapshots insertObject:snap atIndex:toIndex];
+
+  if ([self.delegate respondsToSelector:@selector(array:didMoveObject:fromIndex:toIndex:)]) {
+    [self.delegate array:self didMoveObject:snap fromIndex:fromIndex toIndex:toIndex];
+  }
+}
+
+- (void)removeSnapshotAtIndex:(NSUInteger)index {
+  [self.snapshots removeObjectAtIndex:index];
+}
+
+- (void)insertSnapshot:(FIRDataSnapshot *)snap atIndex:(NSUInteger)index {
+  [self.snapshots insertObject:snap atIndex:index];
+}
+
+- (void)addSnapshot:(FIRDataSnapshot *)snap {
+  [self.snapshots addObject:snap];
+}
+
 #pragma mark - Public API methods
 
 - (NSArray *)items {
diff --git a/FirebaseDatabaseUI/FUISortedArray.h b/FirebaseDatabaseUI/FUISortedArray.h
@@ -20,19 +20,14 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-@interface FUISortedArray : NSObject <FUICollection>
+@interface FUISortedArray : FUIArray <FUICollection>
 
 /**
  * A copy of the snapshots currently in the array.
  */
 @property (nonatomic, readonly, copy) NSArray<FIRDataSnapshot *> *items;
 
-/**
- * The delegate that should receive events from the sorted array.
- */
-@property (nonatomic, weak, readwrite, nullable) id<FUICollectionDelegate> delegate;
-
-- (instancetype)init NS_UNAVAILABLE;
+- (instancetype)initWithQuery:(id<FIRDataObservable>)query NS_UNAVAILABLE;
 
 /**
  * Initializes a sorted collection.
diff --git a/FirebaseDatabaseUI/FUISortedArray.m b/FirebaseDatabaseUI/FUISortedArray.m
