mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-20 07:48:32 +00:00
f15b167e85
Summary: I had a desire for interactive reordering in a personal project, so here's a first attempt at adding support in IGListKit. I figured I might as well get a WIP PR up for comments before I continue further as there are a few aspects to interactive reordering that don't interplay perfectly with IGListKit. As discussed in #291, I went after two prime use cases: 1. Moving items amongst a section 2. Rearranging whole sections I also "disabled" moving items between sections by having those moves revert, to mimic interactive reordering cancellation as closely as possible. You can see both in the Mixed Data example. Grid items can be moved within a section, while users can be moved to reorder whole sections. But trying to move a grid item out of a grid or a user item into a grid will auto-revert. The revert animation isn't as tight as it should be. It may be more desirable to disable the animation - though you lose the visual cue. There is a also a new example, `ReorderableViewController`, that demonstrates 2 in its pure form (likely the most desired use case), where all sections are reorderable single rows. Happy to take feedback -- this is my first experience working on IGListKit, so I would expect there to be gaps. (Ex. I haven't used `IGListStackedSectionController`, and its tests failed as I hadn't implemented reordering delegates for it. Those are simply stubbed out for now.) Issue fixed: #291 - [x] All tests pass. Demo project builds and runs. - [x] I added tests, an experiment, or detailed why my change isn't tested. - [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) - [x] Proper support in `IGListStackedSectionController` Closes https://github.com/Instagram/IGListKit/pull/976 Differential Revision: D6674493 Pulled By: rnystrom fbshipit-source-id: cd53c5fdc6fb59636edc4747c4bbd0f81a4610e5
263 lines
13 KiB
Objective-C
263 lines
13 KiB
Objective-C
/**
|
|
* Copyright (c) 2016-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*/
|
|
|
|
#import <XCTest/XCTest.h>
|
|
|
|
#import <IGListKit/IGListKit.h>
|
|
|
|
#import "IGListAdapterInternal.h"
|
|
#import "IGListTestSection.h"
|
|
#import "IGListTestAdapterDataSource.h"
|
|
#import "IGListTestAdapterReorderingDataSource.h"
|
|
#import "IGTestReorderableSection.h"
|
|
|
|
#import "UICollectionViewLayout+InteractiveReordering.h"
|
|
|
|
@interface IGReloadDataUpdaterTests : XCTestCase
|
|
|
|
@property (nonatomic, strong) UICollectionView *collectionView;
|
|
@property (nonatomic, strong) IGListAdapter *adapter;
|
|
@property (nonatomic, strong) IGListTestAdapterDataSource *dataSource;
|
|
@property (nonatomic, strong) UICollectionViewFlowLayout *layout;
|
|
@property (nonatomic, strong) UIWindow *window;
|
|
|
|
@end
|
|
|
|
@implementation IGReloadDataUpdaterTests
|
|
|
|
- (void)setUp {
|
|
[super setUp];
|
|
|
|
// minimum line spacing, item size, and minimum interim spacing are all set in IGListTestSection
|
|
self.window = [[UIWindow alloc] initWithFrame:CGRectMake(0, 0, 100, 100)];
|
|
|
|
self.layout = [[UICollectionViewFlowLayout alloc] init];
|
|
self.collectionView = [[UICollectionView alloc] initWithFrame:self.window.bounds collectionViewLayout:self.layout];
|
|
|
|
[self.window addSubview:self.collectionView];
|
|
|
|
// syncronous reloads so we dont have to do expectations or other nonsense
|
|
IGListReloadDataUpdater *updater = [[IGListReloadDataUpdater alloc] init];
|
|
|
|
self.dataSource = [[IGListTestAdapterDataSource alloc] init];
|
|
self.adapter = [[IGListAdapter alloc] initWithUpdater:updater
|
|
viewController:nil];
|
|
self.adapter.collectionView = self.collectionView;
|
|
self.adapter.dataSource = self.dataSource;
|
|
}
|
|
|
|
- (void)test_whenCompletionBlockExists_thatBlockExecuted {
|
|
__block BOOL executed = NO;
|
|
self.dataSource.objects = @[@0, @1, @2];
|
|
[self.adapter reloadDataWithCompletion:^(BOOL finished) {
|
|
executed = YES;
|
|
}];
|
|
XCTAssertTrue(executed);
|
|
}
|
|
|
|
- (void)test_whenInsertingIntoContext_thatCollectionViewUpdated {
|
|
self.dataSource.objects = @[@2];
|
|
[self.adapter reloadDataWithCompletion:nil];
|
|
XCTAssertEqual([self.collectionView numberOfItemsInSection:0], 2);
|
|
IGListTestSection *section = [self.adapter sectionControllerForObject:@2];
|
|
[section.collectionContext performBatchAnimated:YES updates:^(id<IGListBatchContext> batchContext) {
|
|
section.items = 3;
|
|
[batchContext insertInSectionController:section atIndexes:[NSIndexSet indexSetWithIndex:0]];
|
|
} completion:nil];
|
|
XCTAssertEqual([self.collectionView numberOfItemsInSection:0], 3);
|
|
}
|
|
|
|
- (void)test_whenDeletingFromContext_thatCollectionViewUpdated {
|
|
self.dataSource.objects = @[@2];
|
|
[self.adapter reloadDataWithCompletion:nil];
|
|
XCTAssertEqual([self.collectionView numberOfItemsInSection:0], 2);
|
|
IGListTestSection *section = [self.adapter sectionControllerForObject:@2];
|
|
[section.collectionContext performBatchAnimated:YES updates:^(id<IGListBatchContext> batchContext) {
|
|
section.items = 1;
|
|
[batchContext deleteInSectionController:section atIndexes:[NSIndexSet indexSetWithIndex:0]];
|
|
} completion:nil];
|
|
XCTAssertEqual([self.collectionView numberOfItemsInSection:0], 1);
|
|
}
|
|
|
|
- (void)test_whenReloadingInContext_thatCollectionViewUpdated {
|
|
self.dataSource.objects = @[@2];
|
|
[self.adapter reloadDataWithCompletion:nil];
|
|
XCTAssertEqual([self.collectionView numberOfItemsInSection:0], 2);
|
|
IGListTestSection *section = [self.adapter sectionControllerForObject:@2];
|
|
[section.collectionContext performBatchAnimated:YES updates:^(id<IGListBatchContext> batchContext) {
|
|
[batchContext reloadInSectionController:section atIndexes:[NSIndexSet indexSetWithIndex:0]];
|
|
} completion:nil];
|
|
XCTAssertEqual([self.collectionView numberOfItemsInSection:0], 2);
|
|
}
|
|
|
|
- (void)test_whenPerformingUpdate_thatCompletionExecuted {
|
|
__block BOOL executed = NO;
|
|
self.dataSource.objects = @[@0, @1, @2];
|
|
[self.adapter performUpdatesAnimated:NO completion:^(BOOL finished) {
|
|
executed = YES;
|
|
}];
|
|
XCTAssertTrue(executed);
|
|
}
|
|
|
|
- (void)test_whenMovingFromContext_thatCollectionViewUpdated {
|
|
self.dataSource.objects = @[@2];
|
|
[self.adapter reloadDataWithCompletion:nil];
|
|
XCTAssertEqual([self.collectionView numberOfItemsInSection:0], 2);
|
|
IGListTestSection *section = [self.adapter sectionControllerForObject:@2];
|
|
[section.collectionContext performBatchAnimated:YES updates:^(id<IGListBatchContext> batchContext) {
|
|
[batchContext moveInSectionController:section fromIndex:0 toIndex:1];
|
|
} completion:nil];
|
|
XCTAssertEqual([self.collectionView numberOfItemsInSection:0], 2);
|
|
}
|
|
|
|
- (NSIndexPath *)interpretedIndexPathFromIndexPath:(NSIndexPath *)fromIndexPath toIndexPath:(NSIndexPath *)toIndexPath {
|
|
UICollectionViewLayout *layout = self.collectionView.collectionViewLayout;
|
|
NSIndexPath *updatedIndexPath = [layout updatedTargetForInteractivelyMovingItem:fromIndexPath
|
|
toIndexPath:toIndexPath
|
|
adapter:self.adapter];
|
|
if (!updatedIndexPath) {
|
|
return toIndexPath;
|
|
}
|
|
return updatedIndexPath;
|
|
}
|
|
|
|
- (void)test_whenSectionIsInteractivelyReordered_thatIndexesUpdateCorrectly {
|
|
IGListTestAdapterReorderingDataSource *dataSource = [IGListTestAdapterReorderingDataSource new];
|
|
dataSource.objects = @[@0, @1, @2];
|
|
self.adapter.dataSource = dataSource;
|
|
self.adapter.moveDelegate = dataSource;
|
|
|
|
IGTestReorderableSection *section0 = (IGTestReorderableSection *)[self.adapter sectionControllerForSection:0];
|
|
IGTestReorderableSection *section1 = (IGTestReorderableSection *)[self.adapter sectionControllerForSection:1];
|
|
IGTestReorderableSection *section2 = (IGTestReorderableSection *)[self.adapter sectionControllerForSection:2];
|
|
section0.sectionObject = [IGTestReorderableSectionObject sectionWithObjects:@[@0]];
|
|
section1.sectionObject = [IGTestReorderableSectionObject sectionWithObjects:@[@0]];
|
|
section2.sectionObject = [IGTestReorderableSectionObject sectionWithObjects:@[@0]];
|
|
section2.isReorderable = YES;
|
|
|
|
[self.adapter performUpdatesAnimated:NO completion:nil];
|
|
|
|
NSIndexPath *fromIndexPath, *toIndexPath, *interpretedPath;
|
|
|
|
// move the last section into the second position, dropping into the end of the first section
|
|
fromIndexPath = [NSIndexPath indexPathForItem:0 inSection:2];
|
|
toIndexPath = [NSIndexPath indexPathForItem:1 inSection:0];
|
|
interpretedPath = [self interpretedIndexPathFromIndexPath:fromIndexPath toIndexPath:toIndexPath];
|
|
[self.adapter collectionView:self.collectionView moveItemAtIndexPath:fromIndexPath toIndexPath:interpretedPath];
|
|
|
|
XCTAssertEqual(section0, [self.adapter sectionControllerForSection:0]);
|
|
XCTAssertEqual(section2, [self.adapter sectionControllerForSection:1]);
|
|
XCTAssertEqual(section1, [self.adapter sectionControllerForSection:2]);
|
|
|
|
// move the last section into the first position, dropping into the start of the first section
|
|
fromIndexPath = [NSIndexPath indexPathForItem:0 inSection:2];
|
|
toIndexPath = [NSIndexPath indexPathForItem:0 inSection:0];
|
|
interpretedPath = [self interpretedIndexPathFromIndexPath:fromIndexPath toIndexPath:toIndexPath];
|
|
[self.adapter collectionView:self.collectionView moveItemAtIndexPath:fromIndexPath toIndexPath:interpretedPath];
|
|
|
|
XCTAssertEqual(section1, [self.adapter sectionControllerForSection:0]);
|
|
XCTAssertEqual(section0, [self.adapter sectionControllerForSection:1]);
|
|
XCTAssertEqual(section2, [self.adapter sectionControllerForSection:2]);
|
|
|
|
// move the first section into the middle position, dropping into the start of the last section
|
|
fromIndexPath = [NSIndexPath indexPathForItem:0 inSection:0];
|
|
toIndexPath = [NSIndexPath indexPathForItem:0 inSection:2];
|
|
interpretedPath = [self interpretedIndexPathFromIndexPath:fromIndexPath toIndexPath:toIndexPath];
|
|
[self.adapter collectionView:self.collectionView moveItemAtIndexPath:fromIndexPath toIndexPath:interpretedPath];
|
|
|
|
XCTAssertEqual(section0, [self.adapter sectionControllerForSection:0]);
|
|
XCTAssertEqual(section1, [self.adapter sectionControllerForSection:1]);
|
|
XCTAssertEqual(section2, [self.adapter sectionControllerForSection:2]);
|
|
|
|
// move the first section into the last position, dropping into the end of the last section
|
|
fromIndexPath = [NSIndexPath indexPathForItem:0 inSection:0];
|
|
toIndexPath = [NSIndexPath indexPathForItem:1 inSection:2];
|
|
interpretedPath = [self interpretedIndexPathFromIndexPath:fromIndexPath toIndexPath:toIndexPath];
|
|
[self.adapter collectionView:self.collectionView moveItemAtIndexPath:fromIndexPath toIndexPath:interpretedPath];
|
|
|
|
XCTAssertEqual(section1, [self.adapter sectionControllerForSection:0]);
|
|
XCTAssertEqual(section2, [self.adapter sectionControllerForSection:1]);
|
|
XCTAssertEqual(section0, [self.adapter sectionControllerForSection:2]);
|
|
}
|
|
|
|
- (void)test_whenItemsInSectionAreInteractivelyReordered_thatIndexesUpdateCorrectly {
|
|
IGListTestAdapterReorderingDataSource *dataSource = [IGListTestAdapterReorderingDataSource new];
|
|
dataSource.objects = @[@0];
|
|
self.adapter.dataSource = dataSource;
|
|
self.adapter.moveDelegate = dataSource;
|
|
|
|
NSArray *sectionObjects = @[@0, @1, @2];
|
|
|
|
IGTestReorderableSection *section = (IGTestReorderableSection *)[self.adapter sectionControllerForSection:0];
|
|
section.sectionObject = [IGTestReorderableSectionObject sectionWithObjects:sectionObjects];
|
|
section.isReorderable = YES;
|
|
|
|
[self.adapter performUpdatesAnimated:NO completion:nil];
|
|
|
|
NSIndexPath *fromIndexPath, *toIndexPath;
|
|
|
|
// move the last item into the first position
|
|
fromIndexPath = [NSIndexPath indexPathForItem:2 inSection:0];
|
|
toIndexPath = [NSIndexPath indexPathForItem:0 inSection:0];
|
|
[self.adapter collectionView:self.collectionView moveItemAtIndexPath:fromIndexPath toIndexPath:toIndexPath];
|
|
|
|
XCTAssertEqual(sectionObjects[2], section.sectionObject.objects[0]);
|
|
XCTAssertEqual(sectionObjects[0], section.sectionObject.objects[1]);
|
|
XCTAssertEqual(sectionObjects[1], section.sectionObject.objects[2]);
|
|
|
|
// move the last item into the middle position
|
|
fromIndexPath = [NSIndexPath indexPathForItem:2 inSection:0];
|
|
toIndexPath = [NSIndexPath indexPathForItem:1 inSection:0];
|
|
[self.adapter collectionView:self.collectionView moveItemAtIndexPath:fromIndexPath toIndexPath:toIndexPath];
|
|
|
|
XCTAssertEqual(sectionObjects[2], section.sectionObject.objects[0]);
|
|
XCTAssertEqual(sectionObjects[1], section.sectionObject.objects[1]);
|
|
XCTAssertEqual(sectionObjects[0], section.sectionObject.objects[2]);
|
|
}
|
|
|
|
- (void)test_whenItemsAreInteractivelyReorderedAcrossSections_thatIndexesRevertToOriginalState {
|
|
IGListTestAdapterReorderingDataSource *dataSource = [IGListTestAdapterReorderingDataSource new];
|
|
dataSource.objects = @[@0, @1];
|
|
self.adapter.dataSource = dataSource;
|
|
self.adapter.moveDelegate = dataSource;
|
|
|
|
NSArray *section0Objects = @[@0, @1, @2];
|
|
NSArray *section1Objects = @[@3, @4, @5];
|
|
|
|
IGTestReorderableSection *section0 = (IGTestReorderableSection *)[self.adapter sectionControllerForSection:0];
|
|
section0.sectionObject = [IGTestReorderableSectionObject sectionWithObjects:section0Objects];
|
|
IGTestReorderableSection *section1 = (IGTestReorderableSection *)[self.adapter sectionControllerForSection:1];
|
|
section1.sectionObject = [IGTestReorderableSectionObject sectionWithObjects:section1Objects];
|
|
section1.isReorderable = YES;
|
|
|
|
[self.adapter performUpdatesAnimated:NO completion:nil];
|
|
|
|
NSIndexPath *fromIndexPath, *toIndexPath;
|
|
|
|
// move an item from section 1 to section 0 and check that they are reverted
|
|
fromIndexPath = [NSIndexPath indexPathForItem:0 inSection:1];
|
|
toIndexPath = [NSIndexPath indexPathForItem:0 inSection:0];
|
|
|
|
[self.collectionView performBatchUpdates:^{
|
|
[self.collectionView moveItemAtIndexPath:fromIndexPath toIndexPath:toIndexPath];
|
|
|
|
[self.collectionView.dataSource collectionView:self.collectionView
|
|
moveItemAtIndexPath:fromIndexPath
|
|
toIndexPath:toIndexPath];
|
|
} completion:nil];
|
|
|
|
XCTAssertEqual(section0Objects[0], section0.sectionObject.objects[0]);
|
|
XCTAssertEqual(section0Objects[1], section0.sectionObject.objects[1]);
|
|
XCTAssertEqual(section0Objects[2], section0.sectionObject.objects[2]);
|
|
XCTAssertEqual(section1Objects[0], section1.sectionObject.objects[0]);
|
|
XCTAssertEqual(section1Objects[1], section1.sectionObject.objects[1]);
|
|
XCTAssertEqual(section1Objects[2], section1.sectionObject.objects[2]);
|
|
}
|
|
|
|
@end
|