'Cancel' for PromiseKit

Author: dougzilla32

Cartfile.resolved

@@ -1 +1 @@
-github "mxcl/PromiseKit" "6.3.3"
+github "mxcl/PromiseKit" "6.3.4"

Sources/MKDirections+Promise.swift

@@ -24,3 +24,35 @@ extension MKDirections {
         return Promise { calculateETA(completionHandler: $0.resolve) }
     }
 }
+
+//////////////////////////////////////////////////////////// Cancellation
+
+fileprivate class MKDirectionsTask: CancellableTask {
+    let directions: MKDirections
+    var cancelAttempted = false
+    
+    init(_ directions: MKDirections) {
+        self.directions = directions
+    }
+    
+    func cancel() {
+        directions.cancel()
+        cancelAttempted = true
+    }
+    
+    var isCancelled: Bool {
+        return cancelAttempted && !directions.isCalculating
+    }
+}
+
+extension MKDirections {
+    /// Begins calculating the requested route information asynchronously.
+    public func calculateCC() -> CancellablePromise<MKDirectionsResponse> {
+        return CancellablePromise(task: MKDirectionsTask(self)) { calculate(completionHandler: $0.resolve) }
+    }
+
+    /// Begins calculating the requested travel-time information asynchronously.
+    public func calculateETACC() -> CancellablePromise<MKETAResponse> {
+        return CancellablePromise(task: MKDirectionsTask(self)) { calculateETA(completionHandler: $0.resolve) }
+    }
+}

Sources/MKMapSnapshotter+Promise.swift

@@ -19,3 +19,30 @@ extension MKMapSnapshotter {
         return Promise { start(completionHandler: $0.resolve) }
     }
 }
+
+//////////////////////////////////////////////////////////// Cancellation
+
+fileprivate class MKMapSnapshotterTask: CancellableTask {
+    let snapshotter: MKMapSnapshotter
+    var cancelAttempted = false
+    
+    init(_ snapshotter: MKMapSnapshotter) {
+        self.snapshotter = snapshotter
+    }
+    
+    func cancel() {
+        snapshotter.cancel()
+        cancelAttempted = true
+    }
+    
+    var isCancelled: Bool {
+        return cancelAttempted && !snapshotter.isLoading
+    }
+}
+
+extension MKMapSnapshotter {
+    /// Starts generating the snapshot using the options set in this object.
+    public func startCC() -> CancellablePromise<MKMapSnapshot> {
+        return CancellablePromise(task: MKMapSnapshotterTask(self)) { start(completionHandler: $0.resolve) }
+    }
+}

Tests/TestMapKit.swift

@@ -61,3 +61,70 @@ class Test_MKSnapshotter_Swift: XCTestCase {
         waitForExpectations(timeout: 1, handler: nil)
     }
 }
+
+//////////////////////////////////////////////////////////// Cancellation
+
+extension Test_MKDirections_Swift {
+    func test_cancel_directions_response() {
+        let ex = expectation(description: "")
+
+        class MockDirections: MKDirections {
+            override func calculate(completionHandler: @escaping MKDirectionsHandler) {
+                completionHandler(MKDirectionsResponse(), nil)
+            }
+        }
+
+        let rq = MKDirectionsRequest()
+        let directions = MockDirections(request: rq)
+
+        directions.calculateCC().done { _ in
+            XCTFail()
+        }.catch(policy: .allErrors) {
+            $0.isCancelled ? ex.fulfill() : XCTFail()
+        }.cancel()
+
+        waitForExpectations(timeout: 1, handler: nil)
+    }
+
+
+    func test_cancel_ETA_response() {
+        let ex = expectation(description: "")
+
+        class MockDirections: MKDirections {
+            override func calculateETA(completionHandler: @escaping MKETAHandler) {
+                completionHandler(MKETAResponse(), nil)
+            }
+        }
+
+        let rq = MKDirectionsRequest()
+        MockDirections(request: rq).calculateETACC().done { _ in
+            XCTFail()
+        }.catch(policy: .allErrors) {
+            $0.isCancelled ? ex.fulfill() : XCTFail()
+        }.cancel()
+
+        waitForExpectations(timeout: 1, handler: nil)
+    }
+
+}
+
+extension Test_MKSnapshotter_Swift {
+    func test_cancel() {
+        let ex = expectation(description: "")
+
+        class MockSnapshotter: MKMapSnapshotter {
+            override func start(completionHandler: @escaping MKMapSnapshotCompletionHandler) {
+                completionHandler(MKMapSnapshot(), nil)
+            }
+        }
+
+        let snapshotter = MockSnapshotter()
+        snapshotter.startCC().done { _ in
+            XCTFail()
+        }.catch(policy: .allErrors) {
+            $0.isCancelled ? ex.fulfill() : XCTFail()
+        }.cancel()
+
+        waitForExpectations(timeout: 1, handler: nil)
+    }
+}