add tests for index array delegate, edge cases

Author: morganchen12

FirebaseDatabaseUITests/FirebaseArrayTestUtils.h

@@ -97,4 +97,14 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic, copy) void (^didMoveObject)(FirebaseArray *array, id object, NSUInteger fromIndex, NSUInteger toIndex);
 @end
 
+@interface FUIFirebaseIndexArrayTestDelegate : NSObject <FirebaseIndexArrayDelegate>
+@property (nonatomic, copy) void (^didLoad)(FirebaseIndexArray *array, FIRDatabaseReference *ref, FIRDataSnapshot *snap, NSUInteger index);
+@property (nonatomic, copy) void (^didFail)(FirebaseIndexArray *array, FIRDatabaseReference *ref, NSUInteger index, NSError *error);
+@property (nonatomic, copy) void (^queryCancelled)(FirebaseIndexArray *array, NSError *error);
+@property (nonatomic, copy) void (^didAddQuery)(FirebaseIndexArray *array, FIRDatabaseReference *query, NSUInteger index);
+@property (nonatomic, copy) void (^didChangeQuery)(FirebaseIndexArray *array, FIRDatabaseReference *query, NSUInteger index);
+@property (nonatomic, copy) void (^didRemoveQuery)(FirebaseIndexArray *array, FIRDatabaseReference *query, NSUInteger index);
+@property (nonatomic, copy) void (^didMoveQuery)(FirebaseIndexArray *array, FIRDatabaseReference *query, NSUInteger fromIndex, NSUInteger toIndex);
+@end
+
 NS_ASSUME_NONNULL_END

FirebaseDatabaseUITests/FirebaseArrayTestUtils.m

@@ -251,3 +251,51 @@ - (void)array:(FirebaseArray *)array queryCancelledWithError:(NSError *)error {
 }
 
 @end
+
+@implementation FUIFirebaseIndexArrayTestDelegate
+
+- (void)array:(FirebaseIndexArray *)array
+    reference:(nonnull FIRDatabaseReference *)ref
+didLoadObject:(nonnull FIRDataSnapshot *)object
+      atIndex:(NSUInteger)index {
+  if (self.didLoad != NULL) {
+    self.didLoad(array, ref, object, index);
+  }
+}
+
+- (void)array:(FirebaseIndexArray *)array reference:(nonnull FIRDatabaseReference *)ref
+      atIndex:(NSUInteger)index didFailLoadWithError:(nonnull NSError *)error {
+  if (self.didFail != NULL) {
+    self.didFail(array, ref, index, error);
+  }
+}
+
+- (void)array:(FirebaseIndexArray *)array didAddReference:(nonnull FIRDatabaseReference *)ref
+      atIndex:(NSUInteger)index {
+  if (self.didAddQuery != NULL) {
+    self.didAddQuery(array, ref, index);
+  }
+}
+
+- (void)array:(FirebaseIndexArray *)array didChangeReference:(nonnull FIRDatabaseReference *)ref
+      atIndex:(NSUInteger)index {
+  if (self.didChangeQuery != NULL) {
+    self.didChangeQuery(array, ref, index);
+  }
+}
+
+- (void)array:(FirebaseIndexArray *)array didRemoveReference:(nonnull FIRDatabaseReference *)ref
+      atIndex:(NSUInteger)index {
+  if (self.didRemoveQuery != nil) {
+    self.didRemoveQuery(array, ref, index);
+  }
+}
+
+- (void)array:(FirebaseIndexArray *)array didMoveReference:(nonnull FIRDatabaseReference *)ref
+    fromIndex:(NSUInteger)fromIndex toIndex:(NSUInteger)toIndex {
+  if (self.didMoveQuery != NULL) {
+    self.didMoveQuery(array, ref, fromIndex, toIndex);
+  }
+}
+
+@end

FirebaseDatabaseUITests/FirebaseIndexArrayTest.m

@@ -28,6 +28,7 @@ @interface FirebaseIndexArrayTest : XCTestCase
 @property (nonatomic) FUITestObservable *index;
 @property (nonatomic) FUITestObservable *data;
 @property (nonatomic) FirebaseIndexArray *array;
+@property (nonatomic) FUIFirebaseIndexArrayTestDelegate *arrayDelegate;
 
 @property (nonatomic) NSMutableDictionary *dict;
 @end
@@ -60,13 +61,16 @@ - (void)setUp {
   self.data = [[FUITestObservable alloc] initWithDictionary:database()[@"data"]];
   self.array = [[FirebaseIndexArray alloc] initWithIndex:self.index
                                                     data:self.data];
+  self.arrayDelegate = [[FUIFirebaseIndexArrayTestDelegate alloc] init];
+  self.array.delegate = self.arrayDelegate;
   self.dict = [database() mutableCopy];
 }
 
 - (void)tearDown {
   [super tearDown];
   [self.array invalidate];
   self.array = nil;
+  self.arrayDelegate = nil;
 }
 
 - (void)testItHasContents {
@@ -86,10 +90,25 @@ - (void)testItUpdatesOnInsertion {
   NSArray *items = self.array.items;
   XCTAssert(items.count == 3, @"expected %i keys, got %li", 3, items.count);
 
+  // test delegate
+  __block BOOL delegateWasCalled = NO;
+  __block BOOL expectedParametersWereCorrect = NO;
+
+  self.arrayDelegate.didAddQuery = ^(FirebaseIndexArray *array, FIRDatabaseReference *query, NSUInteger index) {
+    delegateWasCalled = YES;
+    expectedParametersWereCorrect = (
+      array == self.array &&
+      index == 3
+    );
+  };
+
   // insert item
   [self.data addObject:@{ @"data": @"4" } forKey:@"4"];
   [self.index addObject:@(YES) forKey:@"4"];
 
+  XCTAssert(delegateWasCalled, @"expected insertion to call method on delegate");
+  XCTAssert(expectedParametersWereCorrect, @"expected insertion to call delegate method with correct params");
+
   items = self.array.items;
 
   NSArray *expected = @[
@@ -107,10 +126,25 @@ - (void)testItUpdatesOnDeletion {
   NSArray *items = self.array.items;
   XCTAssert(items.count == 3, @"expected %i keys, got %li", 3, items.count);
 
+  // test delegate
+  __block BOOL delegateWasCalled = NO;
+  __block BOOL expectedParametersWereCorrect = NO;
+
+  self.arrayDelegate.didRemoveQuery = ^(FirebaseIndexArray *array, FIRDatabaseReference *query, NSUInteger index) {
+    delegateWasCalled = YES;
+    expectedParametersWereCorrect = (
+      array == self.array &&
+      index == 1
+    );
+  };
+
   // delete item
   [self.data removeObjectForKey:@"2"];
   [self.index removeObjectForKey:@"2"];
 
+  XCTAssert(delegateWasCalled, @"expected deletion to call method on delegate");
+  XCTAssert(expectedParametersWereCorrect, @"expected deletion to call delegate method with correct params");
+
   items = self.array.items;
 
   NSArray *expected = @[
@@ -121,15 +155,70 @@ - (void)testItUpdatesOnDeletion {
   XCTAssertEqualObjects(items, expected, @"expected contents to equal %@", expected);
 }
 
+- (void)testItCanDeleteEdgeCases {
+  // check expected number of items
+  NSArray *items = self.array.items;
+  XCTAssert(items.count == 3, @"expected %i keys, got %li", 3, items.count);
+
+  // delete first item
+  [self.data removeObjectForKey:@"1"];
+  [self.index removeObjectForKey:@"1"];
+
+  items = self.array.items;
+
+  NSArray *expected = @[
+    [FUIFakeSnapshot snapWithKey:@"data" value:@"2"],
+    [FUIFakeSnapshot snapWithKey:@"data" value:@"3"],
+  ];
+
+  XCTAssertEqualObjects(items, expected, @"expected contents to equal %@", expected);
+
+  // delete last item
+  [self.data removeObjectForKey:@"3"];
+  [self.index removeObjectForKey:@"3"];
+
+  items = self.array.items;
+
+  expected = @[
+    [FUIFakeSnapshot snapWithKey:@"data" value:@"2"],
+  ];
+
+  XCTAssertEqualObjects(items, expected, @"expected contents to equal %@", expected);
+
+  // delete single item
+  [self.index removeObjectForKey:@"2"];
+
+  items = self.array.items;
+
+  expected = @[];
+
+  XCTAssertEqualObjects(items, expected, @"expected contents to equal %@", expected);
+}
+
 - (void)testItUpdatesOnChange {
   // check expected number of items
   NSArray *items = self.array.items;
   XCTAssert(items.count == 3, @"expected %i keys, got %li", 3, items.count);
 
+  // test delegate
+  __block BOOL delegateWasCalled = NO;
+  __block BOOL expectedParametersWereCorrect = NO;
+
+  self.arrayDelegate.didChangeQuery = ^(FirebaseIndexArray *array, FIRDatabaseReference *query, NSUInteger index) {
+    delegateWasCalled = YES;
+    expectedParametersWereCorrect = (
+      array == self.array &&
+      index == 1
+    );
+  };
+
   // change item
   [self.data changeObject:@{ @"data": @"changed" } forKey:@"2"];
   [self.index changeObject:@(YES) forKey:@"2"];
 
+  XCTAssert(delegateWasCalled, @"expected change to call method on delegate");
+  XCTAssert(expectedParametersWereCorrect, @"expected change to call delegate method with correct params");
+
   items = self.array.items;
 
   NSArray *expected = @[
@@ -146,10 +235,29 @@ - (void)testItUpdatesOnMove {
   NSArray *items = self.array.items;
   XCTAssert(items.count == 3, @"expected %i keys, got %li", 3, items.count);
 
+  // test delegate
+  __block BOOL delegateWasCalled = NO;
+  __block BOOL expectedParametersWereCorrect = NO;
+
+  self.arrayDelegate.didMoveQuery = ^(FirebaseIndexArray *array,
+                                      FIRDatabaseReference *query,
+                                      NSUInteger from,
+                                      NSUInteger to) {
+    delegateWasCalled = YES;
+    expectedParametersWereCorrect = (
+      array == self.array &&
+      from == 0 &&
+      to == 2
+    );
+  };
+
   // move item to back
   [self.data moveObjectFromIndex:0 toIndex:2];
   [self.index moveObjectFromIndex:0 toIndex:2];
 
+  XCTAssert(delegateWasCalled, @"expected move to call method on delegate");
+  XCTAssert(expectedParametersWereCorrect, @"expected move to call delegate method with correct params");
+
   items = self.array.items;
 
   NSArray *expected = @[