IGListKit/Tests/IGListBindingSingleSectionControllerTests.m
Zhisheng Huang b4dc116e20 Add a IGListBindingSingleSectionController
Summary:
= Problem =

Most of the UICollectionView/List UI only needs to deal with 1 dimensional array of data. The current N section N item setup is a big more complicated for most use case who only deals with 1 dimensional array.

In fact, the IGListDiff algorithm works pretty with 1 dimensional array. Then inside `IGListAdapterUpdater`, we do a lot changes to ensure UICollectionVie do not crash:
1. Convert section moves -> delete+insert;
2. Convert section reload -> delete+insert;

This results in the animation limitation for the UI updates, we lose the move animation support by UICollectionView and the updates for delete+insert does not look great.

= Solution =

Hence I am proposing to use simple **Single Item** Section Controller, and we can apply the diffing result directly to the UICollectionView, which is much simpler.

However, for the inline section update, we need to support update at the right timing: inside -didUpdateObject:, and now we want to get back the existing cell, and apply data to it.

Ideally, `IGListSingleSectionController` is the right call but `IGListSingleSectionController` is not subclassable and we would also need to change the way -didUpdateObject: works in that class.

Hence I am building this `IGListBindingSingleSectionController`, which only contains single item, and it can update/bind the cell whenever item is updated.

Reviewed By: iperry90

Differential Revision: D18942974

fbshipit-source-id: 539fbe2b72691b649e3ae3d8ed725006bc54b705
2019-12-16 17:50:50 -08:00

134 lines
5.9 KiB
Objective-C

/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
#import <XCTest/XCTest.h>
#import "IGTestCell.h"
#import "IGListTestCase.h"
#import "IGListAdapterInternal.h"
#import "IGTestCell.h"
#import "IGTestBindingSingleItemDataSource.h"
@interface IGListBindingSingleSectionControllerTests : IGListTestCase
@end
@implementation IGListBindingSingleSectionControllerTests
- (void)setUp {
self.dataSource = [IGTestBindingSingleItemDataSource new];
self.frame = CGRectMake(0, 0, 100, 1000);
[super setUp];
}
- (void)test_whenSetupWithObjects_collectionViewHasSections {
[self setupWithObjects:@[
genTestObject(@1, @"Foo"),
genTestObject(@2, @"Bar"),
genTestObject(@3, @"Baz"),
]];
XCTAssertEqual([self.collectionView numberOfSections], 3);
XCTAssertEqual([self.collectionView numberOfItemsInSection:0], 1);
XCTAssertEqual([self.collectionView numberOfItemsInSection:1], 1);
XCTAssertEqual([self.collectionView numberOfItemsInSection:2], 1);
}
- (void)test_whenSetupWithObjects_sizeIsCalled {
[self setupWithObjects:@[
genTestObject(@1, @"Foo"),
genTestObject(@2, @"Bar"),
genTestObject(@3, @"Baz"),
]];
IGTestCell *cell1 = (IGTestCell *)[self.collectionView cellForItemAtIndexPath:[NSIndexPath indexPathForItem:0 inSection:0]];
IGTestCell *cell2 = (IGTestCell *)[self.collectionView cellForItemAtIndexPath:[NSIndexPath indexPathForItem:0 inSection:1]];
IGTestCell *cell3 = (IGTestCell *)[self.collectionView cellForItemAtIndexPath:[NSIndexPath indexPathForItem:0 inSection:2]];
// Check the size is set in `IGTestBindingSingleSectionController`
XCTAssertEqual(cell1.frame.size.height, 44);
XCTAssertEqual(cell2.frame.size.height, 44);
XCTAssertEqual(cell3.frame.size.height, 44);
XCTAssertEqual(cell1.frame.size.width, 100);
XCTAssertEqual(cell2.frame.size.width, 100);
XCTAssertEqual(cell3.frame.size.width, 100);
}
- (void)test_whenSetupWithObjects_cellsAreConfigured {
[self setupWithObjects:@[
genTestObject(@1, @"Foo"),
genTestObject(@2, @"Bar"),
genTestObject(@3, @"Baz"),
]];
IGTestCell *cell1 = (IGTestCell *)[self.collectionView cellForItemAtIndexPath:[NSIndexPath indexPathForItem:0 inSection:0]];
IGTestCell *cell2 = (IGTestCell *)[self.collectionView cellForItemAtIndexPath:[NSIndexPath indexPathForItem:0 inSection:1]];
IGTestCell *cell3 = (IGTestCell *)[self.collectionView cellForItemAtIndexPath:[NSIndexPath indexPathForItem:0 inSection:2]];
// Check the cell is configured in `IGTestBindingSingleSectionController`
XCTAssertEqualObjects(cell1.label.text, @"Foo");
XCTAssertEqualObjects(cell2.label.text, @"Bar");
XCTAssertEqualObjects(cell3.label.text, @"Baz");
}
- (void)test_whenSetupWithObjects_cellClassIsExpected {
[self setupWithObjects:@[
genTestObject(@1, @"Foo"),
genTestObject(@2, @"Bar"),
genTestObject(@3, @"Baz"),
]];
UICollectionViewCell *cell = [self.collectionView cellForItemAtIndexPath:[NSIndexPath indexPathForItem:0 inSection:0]];
XCTAssertTrue([cell isKindOfClass:[IGTestCell class]]);
}
- (void)test_whenDidSelectIsCalled_subclassIsCalled {
[self setupWithObjects:@[
genTestObject(@1, @"Foo"),
]];
IGListSectionController *controller = [self.adapter sectionControllerForSection:0];
[controller didSelectItemAtIndex:0];
IGTestCell *cell1 = (IGTestCell *)[self.collectionView cellForItemAtIndexPath:[NSIndexPath indexPathForItem:0 inSection:0]];
// Check the cell label is updated in `IGTestBindingSingleSectionController`
XCTAssertEqualObjects(cell1.label.text, @"did-select");
}
- (void)test_whenDidDeselectIsCalled_subclassIsCalled {
[self setupWithObjects:@[
genTestObject(@1, @"Foo"),
]];
IGListSectionController *controller = [self.adapter sectionControllerForSection:0];
[controller didDeselectItemAtIndex:0];
IGTestCell *cell1 = (IGTestCell *)[self.collectionView cellForItemAtIndexPath:[NSIndexPath indexPathForItem:0 inSection:0]];
// Check the cell label is updated in `IGTestBindingSingleSectionController`
XCTAssertEqualObjects(cell1.label.text, @"did-deselect");
}
- (void)test_whenDidHighlightIsCalled_subclassIsCalled {
[self setupWithObjects:@[
genTestObject(@1, @"Foo"),
]];
IGListSectionController *controller = [self.adapter sectionControllerForSection:0];
[controller didHighlightItemAtIndex:0];
IGTestCell *cell1 = (IGTestCell *)[self.collectionView cellForItemAtIndexPath:[NSIndexPath indexPathForItem:0 inSection:0]];
// Check the cell label is updated in `IGTestBindingSingleSectionController`
XCTAssertEqualObjects(cell1.label.text, @"did-highlight");
}
- (void)test_whenDidUnhighlightIsCalled_subclassIsCalled {
[self setupWithObjects:@[
genTestObject(@1, @"Foo"),
]];
IGListSectionController *controller = [self.adapter sectionControllerForSection:0];
[controller didUnhighlightItemAtIndex:0];
IGTestCell *cell1 = (IGTestCell *)[self.collectionView cellForItemAtIndexPath:[NSIndexPath indexPathForItem:0 inSection:0]];
// Check the cell label is updated in `IGTestBindingSingleSectionController`
XCTAssertEqualObjects(cell1.label.text, @"did-unhighlight");
}
@end