cheat at subclassing to expose less public mutability

Author: morganchen12

FirebaseDatabaseUI/FUIArray.h

@@ -137,40 +137,36 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  * Called when the Firebase query sends a FIRDataEventTypeChildAdded event. Override this
- * to provide custom insertion logic.
+ * to provide custom insertion logic. Don't call this method directly.
  * @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.
+ * to provide custom removal logic. Don't call this method directly.
  * @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.
+ * to provide custom on change logic. Don't call this method directly.
  * @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.
+ * to provide custom move logic. Don't call this method directly.
  * @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

FirebaseDatabaseUI/FUIIndexArray.m

@@ -71,6 +71,7 @@ - (instancetype)initWithIndex:(id<FUIDataObservable>)index
 
 - (void)observeQueries {
   _indexArray = [[FUIArray alloc] initWithQuery:self.index delegate:self];
+  [_indexArray observeQuery];
 }
 
 - (NSArray <FIRDataSnapshot *> *)items {

FirebaseDatabaseUI/FUIIndexTableViewDataSource.h

@@ -104,11 +104,11 @@ didFailLoadAtIndex:(NSUInteger)index
  *   view is in use.
  */
 - (FUIIndexTableViewDataSource *)bindToIndexedQuery:(FIRDatabaseQuery *)index
-                                                    data:(FIRDatabaseReference *)data
-                                                delegate:(id<FUIIndexTableViewDataSourceDelegate>)delegate
-                                            populateCell:(UITableViewCell *(^)(UITableView *view,
-                                                                               NSIndexPath *indexPath,
-                                                                               FIRDataSnapshot *_Nullable snap))populateCell;
+                                               data:(FIRDatabaseReference *)data
+                                           delegate:(id<FUIIndexTableViewDataSourceDelegate>)delegate
+                                       populateCell:(UITableViewCell *(^)(UITableView *view,
+                                                                          NSIndexPath *indexPath,
+                                                                          FIRDataSnapshot *_Nullable snap))populateCell __attribute__((warn_unused_result));
 
 @end
 

FirebaseDatabaseUI/FUIIndexTableViewDataSource.m

@@ -48,8 +48,8 @@ - (instancetype)initWithIndex:(FIRDatabaseQuery *)indexQuery
   self = [super init];
   if (self != nil) {
     _array = [[FUIIndexArray alloc] initWithIndex:indexQuery
-                                                  data:dataQuery
-                                              delegate:self];
+                                             data:dataQuery
+                                         delegate:self];
     _tableView = tableView;
     tableView.dataSource = self;
     _populateCell = populateCell;
@@ -139,17 +139,17 @@ - (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger
 @implementation UITableView (FUIIndexTableViewDataSource)
 
 - (FUIIndexTableViewDataSource *)bindToIndexedQuery:(FIRDatabaseQuery *)index
-                                                    data:(FIRDatabaseReference *)data
-                                                delegate:(id<FUIIndexTableViewDataSourceDelegate>)delegate
-                                            populateCell:(UITableViewCell *(^)(UITableView *,
-                                                                               NSIndexPath *,
-                                                                               FIRDataSnapshot *))populateCell {
+                                               data:(FIRDatabaseReference *)data
+                                           delegate:(id<FUIIndexTableViewDataSourceDelegate>)delegate
+                                       populateCell:(UITableViewCell *(^)(UITableView *,
+                                                                          NSIndexPath *,
+                                                                          FIRDataSnapshot *))populateCell {
   FUIIndexTableViewDataSource *dataSource =
     [[FUIIndexTableViewDataSource alloc] initWithIndex:index
-                                                       data:data
-                                                  tableView:self
-                                                   delegate:delegate
-                                               populateCell:populateCell];
+                                                  data:data
+                                             tableView:self
+                                              delegate:delegate
+                                          populateCell:populateCell];
   self.dataSource = dataSource;
   return dataSource;
 }

FirebaseDatabaseUI/FUIQueryObserver.m

@@ -44,9 +44,9 @@ - (instancetype)initWithQuery:(id<FUIDataObservable>)query {
 }
 
 + (FUIQueryObserver *)observerForQuery:(id<FUIDataObservable>)query
-                                 completion:(void (^)(FUIQueryObserver *obs,
-                                                      FIRDataSnapshot *snap,
-                                                      NSError *error))completion {
+                            completion:(void (^)(FUIQueryObserver *obs,
+                                                 FIRDataSnapshot *snap,
+                                                 NSError *error))completion {
   FUIQueryObserver *obs = [[FUIQueryObserver alloc] initWithQuery:query];
 
   void (^observerBlock)(FIRDataSnapshot *, NSString *) = ^(FIRDataSnapshot *snap,

FirebaseDatabaseUI/FUISortedArray.h

@@ -27,7 +27,7 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, readonly, copy) NSArray<FIRDataSnapshot *> *items;
 
-- (instancetype)initWithQuery:(id<FIRDataObservable>)query NS_UNAVAILABLE;
+- (instancetype)initWithQuery:(id<FUIDataObservable>)query NS_UNAVAILABLE;
 
 /**
  * Initializes a sorted collection.

FirebaseDatabaseUI/FUISortedArray.m

@@ -23,6 +23,11 @@ @interface FUISortedArray ()
  */
 @property (nonatomic, copy, nonnull) NSComparisonResult (^sortDescriptor)(FIRDataSnapshot *, FIRDataSnapshot *);
 
+/**
+ * The backing collection that holds all of the array's data.
+ */
+@property (strong, nonatomic) NSMutableArray<FIRDataSnapshot *> *snapshots;
+
 /**
  * A set containing the query observer handles that should be released when
  * this array is freed.
@@ -32,6 +37,9 @@ @interface FUISortedArray ()
 @end
 
 @implementation FUISortedArray
+// Cheating at subclassing, but this @dynamic avoids
+// duplicating storage without exposing mutability publicly
+@dynamic snapshots;
 
 - (instancetype)initWithQuery:(FIRDatabaseQuery *)query
                      delegate:(id<FUICollectionDelegate>)delegate
@@ -57,7 +65,7 @@ - (void)removeSnapshot:(FIRDataSnapshot *)snap withPreviousChildKey:(NSString *)
   NSInteger index = [self indexForKey:snap.key];
   if (index == NSNotFound) { /* error */ return; }
 
-  [self removeSnapshotAtIndex:index];
+  [self.snapshots removeObjectAtIndex:index];
   if ([self.delegate respondsToSelector:@selector(array:didRemoveObject:atIndex:)]) {
     [self.delegate array:self didRemoveObject:snap atIndex:index];
   }
@@ -71,7 +79,7 @@ - (void)changeSnapshot:(FIRDataSnapshot *)snap withPreviousChildKey:(NSString *)
 
   // Since changes can change ordering, model changes as a deletion and an insertion.
   FIRDataSnapshot *removed = [self snapshotAtIndex:index];
-  [self removeSnapshotAtIndex:index];
+  [self.snapshots removeObjectAtIndex:index];
   if ([self.delegate respondsToSelector:@selector(array:didRemoveObject:atIndex:)]) {
     [self.delegate array:self didRemoveObject:removed atIndex:index];
   }
@@ -92,29 +100,29 @@ - (NSArray *)items {
 
 - (NSInteger)insertSnapshot:(FIRDataSnapshot *)snapshot {
   if (self.count == 0) {
-    [self addSnapshot:snapshot];
+    [self.snapshots addObject:snapshot];
     return 0;
   }
   if (self.count == 1) {
     NSComparisonResult result = self.sortDescriptor(snapshot, [self snapshotAtIndex:0]);
     switch (result) {
       case NSOrderedDescending:
-        [self addSnapshot:snapshot];
+        [self.snapshots addObject:snapshot];
         return 1;
       default:
-        [self insertSnapshot:snapshot atIndex:0];
+        [self.snapshots insertObject:snapshot atIndex:0];
         return 0;
     }
   }
 
   NSInteger index = self.count / 2;
   while (index >= 0 && index <= self.count) {
     if (index == 0) {
-      [self insertSnapshot:snapshot atIndex:index];
+      [self.snapshots insertObject:snapshot atIndex:index];
       return 0;
     }
     if (index == self.count) {
-      [self addSnapshot:snapshot];
+      [self.snapshots addObject:snapshot];
       return index;
     }
 
@@ -136,7 +144,7 @@ - (NSInteger)insertSnapshot:(FIRDataSnapshot *)snapshot {
       NSAssert(NO, @"FUISortedArray %@'s sort descriptor returned inconsistent results!", self);
     } else {
       // good
-      [self insertSnapshot:snapshot atIndex:index];
+      [self.snapshots insertObject:snapshot atIndex:index];
       return index;
     }
   }