Merge pull request #1286 from Fitzmaz/add-swipeFromEdge

Add support for swiping from the specified edge of the screen

KIF Tests/GestureTests.m

@@ -193,6 +193,34 @@ - (void)testSwipingDownWithIdentifier
     [tester waitForViewWithAccessibilityLabel:@"Down"];
 }
 
+- (void)testSwipingFromScreenEdgeLeft
+{
+    UIView *view = [tester waitForViewWithAccessibilityIdentifier:@"gestures.swipeMe"];
+    CGSize windowSize = view.window.bounds.size;
+    CGPoint point = CGPointMake(0.5, 200);
+    point = [view convertPoint:point fromView:view.window];
+    KIFDisplacement displacement = CGPointMake(windowSize.width * 0.5, 5);
+    [view dragFromPoint:point displacement:displacement steps:20];
+    [tester waitForAbsenceOfViewWithAccessibilityLabel:@"LeftEdge"];
+
+    [tester swipeFromEdge:UIRectEdgeLeft];
+    [tester waitForViewWithAccessibilityLabel:@"LeftEdge"];
+}
+
+- (void)testSwipingFromScreenEdgeRight
+{
+    UIView *view = [tester waitForViewWithAccessibilityIdentifier:@"gestures.swipeMe"];
+    CGSize windowSize = view.window.bounds.size;
+    CGPoint point = CGPointMake(windowSize.width - 0.5, 200);
+    point = [view convertPoint:point fromView:view.window];
+    KIFDisplacement displacement = CGPointMake(-windowSize.width * 0.5, 5);
+    [view dragFromPoint:point displacement:displacement steps:20];
+    [tester waitForAbsenceOfViewWithAccessibilityLabel:@"RightEdge"];
+
+    [tester swipeFromEdge:UIRectEdgeRight];
+    [tester waitForViewWithAccessibilityLabel:@"RightEdge"];
+}
+
 - (void)testScrolling
 {
     // Needs to be offset from the edge to prevent the navigation controller's interactivePopGestureRecognizer from triggering

KIF Tests/GestureTests_ViewTestActor.m

@@ -108,4 +108,16 @@ - (void)testMissingScrollableElement
     KIFExpectFailure([[[viewTester usingTimeout:0.25] usingIdentifier:@"Unknown"] scrollByFractionOfSizeHorizontal:0.5 vertical:0.5]);
 }
 
+- (void)testSwipingFromScreenEdgeLeft
+{
+    [viewTester swipeFromEdge:UIRectEdgeLeft];
+    [[viewTester usingLabel:@"LeftEdge"] waitForView];
+}
+
+- (void)testSwipingFromScreenEdgeRight
+{
+    [viewTester swipeFromEdge:UIRectEdgeRight];
+    [[viewTester usingLabel:@"RightEdge"] waitForView];
+}
+
 @end

Sources/KIF/Additions/UITouch-KIFAdditions.h

@@ -17,5 +17,6 @@
 
 - (void)setLocationInWindow:(CGPoint)location;
 - (void)setPhaseAndUpdateTimestamp:(UITouchPhase)phase;
+- (void)setIsFromEdge:(BOOL)isFromEdge;
 
 @end

Sources/KIF/Additions/UITouch-KIFAdditions.m

@@ -37,6 +37,7 @@ - (void)_setIsFirstTouchForView:(BOOL)firstTouchForView;
 - (void)_setIsTapToClick:(BOOL)tapToClick;
 
 - (void)_setHidEvent:(IOHIDEventRef)event;
+- (void)_setEdgeType:(NSInteger)edgeType;
 
 @end
 
@@ -117,6 +118,12 @@ - (void)setPhaseAndUpdateTimestamp:(UITouchPhase)phase
     [self setPhase:phase];
 }
 
+- (void)setIsFromEdge:(BOOL)isFromEdge
+{
+    NSInteger edgeType = isFromEdge ? 4 : 0;
+    [self _setEdgeType:edgeType];
+}
+
 - (void)kif_setHidEvent {
     IOHIDEventRef event = kif_IOHIDEventWithTouches(@[self]);
     [self _setHidEvent:event];

Sources/KIF/Additions/UIView-KIFAdditions.h

@@ -53,6 +53,7 @@ typedef CGPoint KIFDisplacement;
 - (void)dragFromPoint:(CGPoint)startPoint toPoint:(CGPoint)endPoint;
 - (void)dragFromPoint:(CGPoint)startPoint toPoint:(CGPoint)endPoint steps:(NSUInteger)stepCount;
 - (void)dragFromPoint:(CGPoint)startPoint displacement:(KIFDisplacement)displacement steps:(NSUInteger)stepCount;
+- (void)dragFromEdge:(UIRectEdge)startEdge toEdge:(UIRectEdge)endEdge;
 - (void)dragAlongPathWithPoints:(CGPoint *)points count:(NSInteger)count;
 - (void)twoFingerPanFromPoint:(CGPoint)startPoint toPoint:(CGPoint)toPoint steps:(NSUInteger)stepCount;
 - (void)pinchAtPoint:(CGPoint)centerPoint distance:(CGFloat)distance steps:(NSUInteger)stepCount;

Sources/KIF/Additions/UIView-KIFAdditions.m

@@ -636,6 +636,27 @@ - (void)dragFromPoint:(CGPoint)startPoint displacement:(KIFDisplacement)displace
     [self dragPointsAlongPaths:@[path]];
 }
 
+- (void)dragFromEdge:(UIRectEdge)startEdge toEdge:(UIRectEdge)endEdge
+{
+    CGFloat width = self.bounds.size.width;
+    CGFloat height = self.bounds.size.height;
+    CGFloat edgeInset = 0.5;
+    NSDictionary *edgeToPoint = @{
+        @(UIRectEdgeTop): @(CGPointMake(width / 2, edgeInset)),
+        @(UIRectEdgeLeft): @(CGPointMake(edgeInset, height / 2)),
+        @(UIRectEdgeBottom): @(CGPointMake(width / 2, height - edgeInset)),
+        @(UIRectEdgeRight): @(CGPointMake(width - edgeInset, height / 2)),
+    };
+    CGPoint startPoint = [edgeToPoint[@(startEdge)] CGPointValue];
+    CGPoint endPoint = [edgeToPoint[@(endEdge)] CGPointValue];
+
+    CGPoint screenPoint = [self convertPoint:startPoint toView:self.window];
+    BOOL isFromScreenEdge = (screenPoint.x < 1 || screenPoint.x > self.window.bounds.size.width - 1);
+
+    NSArray<NSValue *> *path = [self pointsFromStartPoint:startPoint toPoint:endPoint steps:20];
+    [self dragPointsAlongPaths:@[path] isFromEdge:isFromScreenEdge];
+}
+
 - (void)dragAlongPathWithPoints:(CGPoint *)points count:(NSInteger)count;
 {
     // convert point array into NSArray with NSValue
@@ -648,6 +669,10 @@ - (void)dragAlongPathWithPoints:(CGPoint *)points count:(NSInteger)count;
 }
 
 - (void)dragPointsAlongPaths:(NSArray<NSArray<NSValue *> *> *)arrayOfPaths {
+    [self dragPointsAlongPaths:arrayOfPaths isFromEdge:NO];
+}
+
+- (void)dragPointsAlongPaths:(NSArray<NSArray<NSValue *> *> *)arrayOfPaths isFromEdge:(BOOL)isFromEdge {
     // There must be at least one path with at least one point
     if (arrayOfPaths.count == 0 || arrayOfPaths.firstObject.count == 0)
     {
@@ -692,6 +717,7 @@ - (void)dragPointsAlongPaths:(NSArray<NSArray<NSValue *> *> *)arrayOfPaths {
                 point = [self convertPoint:point fromView:self.window];
                 UITouch *touch = [[UITouch alloc] initAtPoint:point inView:self];
                 [touch setPhaseAndUpdateTimestamp:UITouchPhaseBegan];
+                [touch setIsFromEdge:isFromEdge];
                 [touches addObject:touch];
             }
             UIEvent *eventDown = [self eventWithTouches:[NSArray arrayWithArray:touches]];

Sources/KIF/Classes/KIFUITestActor.h

@@ -322,6 +322,12 @@ typedef NS_ENUM(NSUInteger, KIFPullToRefreshTiming) {
  */
 - (void)tapScreenAtPoint:(CGPoint)screenPoint;
 
+/*!
+ @abstract Performs a swipe gesture starting from the specified edge of the screen.
+ @param edge The edge from which the swipe gesture should start.
+ */
+- (void)swipeFromEdge:(UIRectEdge)edge;
+
 /*!
  @abstract Performs a long press on a particular view in the view hierarchy.
  @discussion The view or accessibility element with the given label is searched for in the view hierarchy. If the element isn't found or isn't currently tappable, then the step will attempt to wait until it is. Once the view is present and tappable, touch events are simulated in the center of the view or element.

Sources/KIF/Classes/KIFUITestActor.m

@@ -366,18 +366,7 @@ - (void)tapAccessibilityElement:(UIAccessibilityElement *)element inView:(UIView
 - (void)tapScreenAtPoint:(CGPoint)screenPoint
 {
     [self runBlock:^KIFTestStepResult(NSError **error) {
-
-        // Try all the windows until we get one back that actually has something in it at the given point
-        UIView *view = nil;
-        for (UIWindow *window in [[[UIApplication sharedApplication] windowsWithKeyWindow] reverseObjectEnumerator]) {
-            CGPoint windowPoint = [window convertPoint:screenPoint fromView:nil];
-            view = [window hitTest:windowPoint withEvent:nil];
-
-            // If we hit the window itself, then skip it.
-            if (view != window && view != nil) {
-                break;
-            }
-        }
+        UIView *view = [self viewAtPoint:screenPoint];
 
         KIFTestWaitCondition(view, error, @"No view was found at the point %@", NSStringFromCGPoint(screenPoint));
 
@@ -389,6 +378,45 @@ - (void)tapScreenAtPoint:(CGPoint)screenPoint
     }];
 }
 
+- (void)swipeFromEdge:(UIRectEdge)edge
+{
+    CGSize screenSize = UIScreen.mainScreen.bounds.size;
+    CGPoint screenPoint;
+    if (edge == UIRectEdgeLeft) {
+        screenPoint = CGPointMake(0.3, screenSize.height / 2);
+    } else if (edge == UIRectEdgeRight) {
+        screenPoint = CGPointMake(screenSize.width - 0.3, screenSize.height / 2);
+    } else {
+        return;
+    }
+    [self runBlock:^KIFTestStepResult(NSError **error) {
+        UIView *view = [self viewAtPoint:screenPoint];
+
+        KIFTestWaitCondition(view, error, @"No view was found at the point %@", NSStringFromCGPoint(screenPoint));
+
+        UIRectEdge endEdge = (UIRectEdgeLeft | UIRectEdgeRight) - edge;
+        [view dragFromEdge:edge toEdge:endEdge];
+
+        return KIFTestStepResultSuccess;
+    }];
+}
+
+- (UIView *)viewAtPoint:(CGPoint)screenPoint
+{
+    // Try all the windows until we get one back that actually has something in it at the given point
+    UIView *view = nil;
+    for (UIWindow *window in [[[UIApplication sharedApplication] windowsWithKeyWindow] reverseObjectEnumerator]) {
+        CGPoint windowPoint = [window convertPoint:screenPoint fromView:nil];
+        view = [window hitTest:windowPoint withEvent:nil];
+
+        // If we hit the window itself, then skip it.
+        if (view != window && view != nil) {
+            break;
+        }
+    }
+    return view;
+}
+
 - (void)longPressViewWithAccessibilityLabel:(NSString *)label duration:(NSTimeInterval)duration;
 {
     [self longPressViewWithAccessibilityLabel:label value:nil traits:UIAccessibilityTraitNone duration:duration];

Sources/KIF/Classes/KIFUIViewTestActor.h

@@ -165,6 +165,12 @@ extern NSString *const inputFieldTestString;
  */
 - (void)swipeInDirection:(KIFSwipeDirection)direction;
 
+/*!
+ @abstract Performs a swipe gesture starting from the specified edge of the screen.
+ @param edge The edge from which the swipe gesture should start.
+ */
+- (void)swipeFromEdge:(UIRectEdge)edge;
+
 #pragma mark Waiting & Finding
 
 /*!

Sources/KIF/Classes/KIFUIViewTestActor.m

@@ -380,6 +380,11 @@ - (void)swipeInDirection:(KIFSwipeDirection)direction;
     }
 }
 
+- (void)swipeFromEdge:(UIRectEdge)edge
+{
+    [self.actor swipeFromEdge:edge];
+}
+
 #pragma mark - Scroll/Table/CollectionView Actions
 
 - (void)scrollByFractionOfSizeHorizontal:(CGFloat)horizontalFraction vertical:(CGFloat)verticalFraction;