Unit tests for batch fetching

rnystrom · rnystrom · commit b3ae15858a9d · 2015-02-26T22:26:25.000-08:00
diff --git a/AsyncDisplayKit.xcodeproj/project.pbxproj b/AsyncDisplayKit.xcodeproj/project.pbxproj
@@ -145,6 +145,9 @@
 		292C59A31A956527007E5DD6 /* ASRangeHandlerRender.h in Headers */ = {isa = PBXBuildFile; fileRef = 292C599D1A956527007E5DD6 /* ASRangeHandlerRender.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		292C59A41A956527007E5DD6 /* ASRangeHandlerRender.mm in Sources */ = {isa = PBXBuildFile; fileRef = 292C599E1A956527007E5DD6 /* ASRangeHandlerRender.mm */; };
 		299DA1A91A828D2900162D41 /* ASBatchContext.h in Headers */ = {isa = PBXBuildFile; fileRef = 299DA1A71A828D2900162D41 /* ASBatchContext.h */; };
+		296A0A2E1A9516B2005ACEAA /* ASBatchFetching.h in Headers */ = {isa = PBXBuildFile; fileRef = 296A0A2C1A9516B2005ACEAA /* ASBatchFetching.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		296A0A2F1A9516B2005ACEAA /* ASBatchFetching.m in Sources */ = {isa = PBXBuildFile; fileRef = 296A0A2D1A9516B2005ACEAA /* ASBatchFetching.m */; };
+		296A0A351A951ABF005ACEAA /* ASBatchFetchingTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 296A0A341A951ABF005ACEAA /* ASBatchFetchingTests.m */; };
 		299DA1A91A828D2900162D41 /* ASBatchContext.h in Headers */ = {isa = PBXBuildFile; fileRef = 299DA1A71A828D2900162D41 /* ASBatchContext.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		299DA1AA1A828D2900162D41 /* ASBatchContext.m in Sources */ = {isa = PBXBuildFile; fileRef = 299DA1A81A828D2900162D41 /* ASBatchContext.m */; };
 		3C9C128519E616EF00E942A0 /* ASTableViewTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 3C9C128419E616EF00E942A0 /* ASTableViewTests.m */; settings = {COMPILER_FLAGS = "-fno-objc-arc"; }; };
@@ -299,6 +302,10 @@
 		292C599C1A956527007E5DD6 /* ASRangeHandler.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ASRangeHandler.h; sourceTree = "<group>"; };
 		292C599D1A956527007E5DD6 /* ASRangeHandlerRender.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ASRangeHandlerRender.h; sourceTree = "<group>"; };
 		292C599E1A956527007E5DD6 /* ASRangeHandlerRender.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = ASRangeHandlerRender.mm; sourceTree = "<group>"; };
+		296A0A2C1A9516B2005ACEAA /* ASBatchFetching.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ASBatchFetching.h; sourceTree = "<group>"; };
+		296A0A2D1A9516B2005ACEAA /* ASBatchFetching.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = ASBatchFetching.m; sourceTree = "<group>"; };
+		296A0A311A951715005ACEAA /* ASScrollDirection.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = ASScrollDirection.h; path = AsyncDisplayKit/Details/ASScrollDirection.h; sourceTree = SOURCE_ROOT; };
+		296A0A341A951ABF005ACEAA /* ASBatchFetchingTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = ASBatchFetchingTests.m; sourceTree = "<group>"; };
 		299DA1A71A828D2900162D41 /* ASBatchContext.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ASBatchContext.h; sourceTree = "<group>"; };
 		299DA1A81A828D2900162D41 /* ASBatchContext.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = ASBatchContext.m; sourceTree = "<group>"; };
 		3C9C128419E616EF00E942A0 /* ASTableViewTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = ASTableViewTests.m; sourceTree = "<group>"; };
@@ -432,6 +439,7 @@
 		058D09C5195D04C000B7D73C /* AsyncDisplayKitTests */ = {
 			isa = PBXGroup;
 			children = (
+				296A0A341A951ABF005ACEAA /* ASBatchFetchingTests.m */,
 				2911485B1A77147A005D0878 /* ASControlNodeTests.m */,
 				058D0A2D195D057000B7D73C /* ASDisplayLayerTests.m */,
 				058D0A2E195D057000B7D73C /* ASDisplayNodeAppearanceTests.m */,
@@ -472,6 +480,8 @@
 				054963481A1EA066000F8E56 /* ASBasicImageDownloader.mm */,
 				299DA1A71A828D2900162D41 /* ASBatchContext.h */,
 				299DA1A81A828D2900162D41 /* ASBatchContext.m */,
+				296A0A2C1A9516B2005ACEAA /* ASBatchFetching.h */,
+				296A0A2D1A9516B2005ACEAA /* ASBatchFetching.m */,
 				464052191A3F83C40061C0BA /* ASDataController.h */,
 				4640521A1A3F83C40061C0BA /* ASDataController.mm */,
 				05A6D05819D0EB64002DD95E /* ASDealloc2MainObject.h */,
@@ -497,6 +507,7 @@
 				292C599C1A956527007E5DD6 /* ASRangeHandler.h */,
 				292C599D1A956527007E5DD6 /* ASRangeHandlerRender.h */,
 				292C599E1A956527007E5DD6 /* ASRangeHandlerRender.mm */,
+				296A0A311A951715005ACEAA /* ASScrollDirection.h */,
 				058D09EA195D050800B7D73C /* ASTextNodeCoreTextAdditions.h */,
 				058D09EB195D050800B7D73C /* ASTextNodeCoreTextAdditions.m */,
 				058D09EC195D050800B7D73C /* ASTextNodeRenderer.h */,
@@ -600,6 +611,7 @@
 				058D0A4F195D05CB00B7D73C /* ASImageNode.h in Headers */,
 				058D0A50195D05CB00B7D73C /* ASImageNode.mm in Headers */,
 				058D0A51195D05CB00B7D73C /* ASTextNode.h in Headers */,
+				296A0A2E1A9516B2005ACEAA /* ASBatchFetching.h in Headers */,
 				058D0A52195D05CB00B7D73C /* ASTextNode.mm in Headers */,
 				055F1A3819ABD413004DAFF1 /* ASRangeController.h in Headers */,
 				292C59A31A956527007E5DD6 /* ASRangeHandlerRender.h in Headers */,
@@ -832,6 +844,7 @@
 				058D0A29195D050800B7D73C /* ASDisplayNode+DebugTiming.mm in Sources */,
 				058D0A22195D050800B7D73C /* _ASAsyncTransaction.m in Sources */,
 				055F1A3919ABD413004DAFF1 /* ASRangeController.mm in Sources */,
+				296A0A2F1A9516B2005ACEAA /* ASBatchFetching.m in Sources */,
 				D785F6631A74327E00291744 /* ASScrollNode.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -841,6 +854,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				2911485C1A77147A005D0878 /* ASControlNodeTests.m in Sources */,
+				296A0A351A951ABF005ACEAA /* ASBatchFetchingTests.m in Sources */,
 				058D0A3E195D057000B7D73C /* ASTextNodeRendererTests.m in Sources */,
 				058D0A3D195D057000B7D73C /* ASTextNodeCoreTextAdditionsTests.m in Sources */,
 				058D0A3C195D057000B7D73C /* ASMutableAttributedStringBuilderTests.m in Sources */,
diff --git a/AsyncDisplayKit/ASCollectionView.h b/AsyncDisplayKit/ASCollectionView.h
@@ -185,7 +185,7 @@
  * If not implemented, the collectionView assumes that it should notify its asyncDelegate when batch fetching
  * should occur.
  */
-- (BOOL)shouldBatchFetchForCollectionView:(UICollectionView *)collectionView;
+- (BOOL)shouldBatchFetchForCollectionView:(ASCollectionView *)collectionView;
 
 /**
  * Receive a message that the collectionView is near the end of its data set and more data should be fetched if 
@@ -200,7 +200,7 @@
  * UICollectionView currently only supports batch events for tail loads. If you require a head load, consider
  * implementing a UIRefreshControl.
  */
-- (void)collectionView:(UICollectionView *)collectionView beginBatchFetchingWithContext:(ASBatchContext *)context;
+- (void)collectionView:(ASCollectionView *)collectionView beginBatchFetchingWithContext:(ASBatchContext *)context;
 
 @end
 
diff --git a/AsyncDisplayKit/ASCollectionView.mm b/AsyncDisplayKit/ASCollectionView.mm
@@ -13,6 +13,7 @@
 #import "ASRangeController.h"
 #import "ASDataController.h"
 #import "ASDisplayNodeInternal.h"
+#import "ASBatchFetching.h"
 
 const static NSUInteger kASCollectionViewAnimationNone = 0;
 
@@ -144,6 +145,8 @@ - (instancetype)initWithFrame:(CGRect)frame collectionViewLayout:(UICollectionVi
 
   _batchContext = [[ASBatchContext alloc] init];
 
+  _leadingScreensForBatching = 1.0;
+
   _proxyDelegate = [[_ASCollectionViewProxy alloc] initWithTarget:nil interceptor:self];
   super.delegate = (id<UICollectionViewDelegate>)_proxyDelegate;
 
@@ -386,40 +389,20 @@ - (BOOL)shouldFetchBatch
   if ([self.asyncDelegate respondsToSelector:@selector(shouldBatchFetchForCollectionView:)]) {
     return [self.asyncDelegate shouldBatchFetchForCollectionView:self];
   } else {
-    return YES;
+    // if the delegate does not respond to this method, there is no point in starting to fetch
+    return [self.asyncDelegate respondsToSelector:@selector(collectionView:beginBatchFetchingWithContext:)];
   }
 }
 
 - (void)handleBatchFetchScrollingToOffset:(CGPoint)targetOffset
 {
   ASDisplayNodeAssert(_batchContext != nil, @"Batch context should exist");
 
-  // Bail if we are already fetching, the delegate doesn't care, or we're told not to fetch
-  if ([_batchContext isFetching] ||
-      ![self.asyncDelegate respondsToSelector:@selector(collectionView:beginBatchFetchingWithContext:)] ||
-      ![self shouldFetchBatch]) {
+  if (![self shouldFetchBatch]) {
     return;
   }
 
-  ASScrollDirection scrollDirection = [self scrollDirection];
-  CGFloat viewSize, offset, contentSize;
-
-  if (scrollDirection == ASScrollDirectionUp) {
-    viewSize = CGRectGetHeight(self.bounds);
-    offset = targetOffset.y;
-    contentSize = self.contentSize.height;
-  } else { // horizontal
-    viewSize = CGRectGetWidth(self.bounds);
-    offset = targetOffset.x;
-    contentSize = self.contentSize.width;
-  }
-
-  CGFloat triggerDistance = viewSize * _leadingScreensForBatching;
-
-  // Determine if the offset that we are headed to is within the number of screens we have defined
-  // ASCollectionView supports tail loading only currently, hence the check against Up and Left
-  BOOL supportedBatchScrollDirection = scrollDirection == ASScrollDirectionUp || ASScrollDirectionLeft;
-  if (supportedBatchScrollDirection && contentSize - (viewSize + offset) <= triggerDistance) {
+  if (ASDisplayShouldFetchBatchForContext(_batchContext, [self scrollDirection], self.bounds, self.contentSize, targetOffset, _leadingScreensForBatching)) {
     [_batchContext beginBatchFetching];
     [self.asyncDelegate collectionView:self beginBatchFetchingWithContext:_batchContext];
   }
diff --git a/AsyncDisplayKit/ASTableView.h b/AsyncDisplayKit/ASTableView.h
@@ -190,7 +190,7 @@
  * If not implemented, the tableView assumes that it should notify its asyncDelegate when batch fetching
  * should occur.
  */
-- (BOOL)shouldBatchFetchForTableView:(UITableView *)tableView;
+- (BOOL)shouldBatchFetchForTableView:(ASTableView *)tableView;
 
 /**
  * Receive a message that the tableView is near the end of its data set and more data should be fetched if necessary.
@@ -204,7 +204,7 @@
  * ASTableView currently only supports batch events for tail loads. If you require a head load, consider implementing a
  * UIRefreshControl.
  */
-- (void)tableView:(UITableView *)tableView beginBatchFetchingWithContext:(ASBatchContext *)context;
+- (void)tableView:(ASTableView *)tableView beginBatchFetchingWithContext:(ASBatchContext *)context;
 
 @end
 
diff --git a/AsyncDisplayKit/ASTableView.mm b/AsyncDisplayKit/ASTableView.mm
@@ -14,7 +14,7 @@
 #import "ASLayoutController.h"
 #import "ASRangeController.h"
 #import "ASDisplayNodeInternal.h"
-
+#import "ASBatchFetching.h"
 
 
 #pragma mark -
@@ -395,30 +395,20 @@ - (BOOL)shouldFetchBatch
   if ([self.asyncDelegate respondsToSelector:@selector(shouldBatchFetchForTableView:)]) {
     return [self.asyncDelegate shouldBatchFetchForTableView:self];
   } else {
-    return YES;
+    // if the delegate does not respond to this method, there is no point in starting to fetch
+    return [self.asyncDelegate respondsToSelector:@selector(tableView:beginBatchFetchingWithContext:)];
   }
 }
 
 - (void)handleBatchFetchScrollingToOffset:(CGPoint)targetOffset
 {
   ASDisplayNodeAssert(_batchContext != nil, @"Batch context should exist");
 
-  // Bail if we are already fetching, the delegate doesn't care, or we're told not to fetch
-  if ([_batchContext isFetching] ||
-      ![self.asyncDelegate respondsToSelector:@selector(tableView:beginBatchFetchingWithContext:)] ||
-      ![self shouldFetchBatch]) {
+  if (![self shouldFetchBatch]) {
     return;
   }
 
-  CGFloat viewHeight = CGRectGetHeight(self.bounds);
-  CGFloat triggerDistance = viewHeight * _leadingScreensForBatching;
-  CGFloat offset = targetOffset.y;
-  CGFloat contentHeight = self.contentSize.height;
-
-  // Determine if the offset that we are headed to is within the number of screens we have defined
-  // ASTableView supports tail loading only currently, hence the check against ASScrollDirectionUp
-  if ([self scrollDirection] == ASScrollDirectionUp &&
-      contentHeight - (viewHeight + offset) <= triggerDistance) {
+  if (ASDisplayShouldFetchBatchForContext(_batchContext, [self scrollDirection], self.bounds, self.contentSize, targetOffset, _leadingScreensForBatching)) {
     [_batchContext beginBatchFetching];
     [self.asyncDelegate tableView:self beginBatchFetchingWithContext:_batchContext];
   }
diff --git a/AsyncDisplayKit/Details/ASBatchContext.h b/AsyncDisplayKit/Details/ASBatchContext.h
@@ -6,6 +6,8 @@
  * of patent rights can be found in the PATENTS file in the same directory.
  */
 
+#import <Foundation/Foundation.h>
+
 /**
  * @abstract A context object to notify when batch fetches are finished or cancelled.
  */
@@ -29,8 +31,6 @@
  */
 - (void)completeBatchFetching:(BOOL)didComplete;
 
-- (void)beginBatchFetching;
-
 /**
  * Ask the context object if the batch fetching process was cancelled by the context owner.
  *
@@ -49,4 +49,12 @@
  */
 - (void)cancelBatchFetching;
 
+/**
+ * Notify the context object that fetching has started.
+ *
+ * @discussion Call this method only when you are beginning a fetch process. This should really only be called by the 
+ * context object's owner. Calling this method should be complimented with -completeBatchFetching:.
+ */
+- (void)beginBatchFetching;
+
 @end
diff --git a/AsyncDisplayKit/Details/ASBatchFetching.h b/AsyncDisplayKit/Details/ASBatchFetching.h
@@ -0,0 +1,36 @@
+/* Copyright (c) 2014-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 <UIKit/UIKit.h>
+
+#import "ASBatchContext.h"
+#import "ASScrollDirection.h"
+#import "ASBaseDefines.h"
+
+ASDISPLAYNODE_EXTERN_C_BEGIN
+
+/**
+ @abstract Determine if batch fetching should begin based on the state of the parameters.
+ @param context The batch fetching context that contains knowledge about in-flight fetches.
+ @param scrollDirection The current scrolling direction of the scroll view.
+ @param bounds The bounds of the scrollview.
+ @param contentSize The content size of the scrollview.
+ @param targetOffset The offset that the scrollview will scroll to.
+ @param leadingScreens How many screens in the remaining distance will trigger batch fetching.
+ @return Whether or not the current state should proceed with batch fetching.
+ @discussion This method is broken into a category for unit testing purposes and should be used with the ASTableView and
+ * ASCollectionView batch fetching API.
+ */
+extern BOOL ASDisplayShouldFetchBatchForContext(ASBatchContext *context,
+                                                ASScrollDirection scrollDirection,
+                                                CGRect bounds,
+                                                CGSize contentSize,
+                                                CGPoint targetOffset,
+                                                CGFloat leadingScreens);
+
+ASDISPLAYNODE_EXTERN_C_END
diff --git a/AsyncDisplayKit/Details/ASBatchFetching.m b/AsyncDisplayKit/Details/ASBatchFetching.m
@@ -0,0 +1,51 @@
+/* Copyright (c) 2014-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 "ASBatchFetching.h"
+
+BOOL ASDisplayShouldFetchBatchForContext(ASBatchContext *context,
+                                    ASScrollDirection scrollDirection,
+                                    CGRect bounds,
+                                    CGSize contentSize,
+                                    CGPoint targetOffset,
+                                    CGFloat leadingScreens) {
+  // do not allow fetching if a batch is already in-flight and hasn't been completed or cancelled
+  if ([context isFetching]) {
+    return NO;
+  }
+
+  // no fetching for null states
+  if (leadingScreens <= 0.0 ||
+      CGPointEqualToPoint(targetOffset, CGPointZero) ||
+      CGSizeEqualToSize(contentSize, CGSizeZero) ||
+      CGRectEqualToRect(bounds, CGRectZero)) {
+    return NO;
+  }
+
+  // only Up and Left scrolls are currently supported (tail loading)
+  if (scrollDirection != ASScrollDirectionUp && scrollDirection != ASScrollDirectionLeft) {
+    return NO;
+  }
+
+  CGFloat viewLength, offset, contentLength;
+
+  if (scrollDirection == ASScrollDirectionUp) {
+    viewLength = bounds.size.height;
+    offset = targetOffset.y;
+    contentLength = contentSize.height;
+  } else { // horizontal
+    viewLength = bounds.size.width;
+    offset = targetOffset.x;
+    contentLength = contentSize.width;
+  }
+
+  CGFloat triggerDistance = viewLength * leadingScreens;
+  CGFloat remainingDistance = contentLength - viewLength - offset;
+
+  return remainingDistance <= triggerDistance;
+}
diff --git a/AsyncDisplayKit/Details/ASLayoutController.h b/AsyncDisplayKit/Details/ASLayoutController.h
@@ -10,20 +10,14 @@
 
 #import <AsyncDisplayKit/ASBaseDefines.h>
 #import <AsyncDisplayKit/ASLayoutRangeType.h>
+#import "ASScrollDirection.h"
+
 
 typedef struct {
   CGFloat leadingBufferScreenfuls;
   CGFloat trailingBufferScreenfuls;
 } ASRangeTuningParameters;
 
-typedef NS_ENUM(NSInteger, ASScrollDirection) {
-  ASScrollDirectionNone,
-  ASScrollDirectionRight,
-  ASScrollDirectionLeft,
-  ASScrollDirectionUp,
-  ASScrollDirectionDown,
-};
-
 @protocol ASLayoutController <NSObject>
 
 /**
diff --git a/AsyncDisplayKit/Details/ASScrollDirection.h b/AsyncDisplayKit/Details/ASScrollDirection.h
@@ -0,0 +1,17 @@
+/* Copyright (c) 2014-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 <Foundation/Foundation.h>
+
+typedef NS_ENUM(NSInteger, ASScrollDirection) {
+  ASScrollDirectionNone,
+  ASScrollDirectionRight,
+  ASScrollDirectionLeft,
+  ASScrollDirectionUp,
+  ASScrollDirectionDown,
+};
diff --git a/AsyncDisplayKitTests/ASBatchFetchingTests.m b/AsyncDisplayKitTests/ASBatchFetchingTests.m
