'Cancel' for PromiseKit --

    * Delete CancellableGuarantee and all its usages
    * In PromiseKit Core: instead of using additional functions and methods with the 'CC' suffix, created a new 'cancellable' function to wrap any Promise or Guarantee
    * In the extensions: Rename methods with 'CC' suffix to 'cancellable' prefix (may revisit this)
    * Fix the CancellableCatchable 'recover' methods to properly handle cancellation errors
    * Added an 'afterTask' property to Guarantee, to keep track of the task for calls to 'after'. This way the timer can be appropriately cancelled if the returned Guarantee is passed to the new 'cancellable' function. (may revisit this)
    * Update all cancellable tests for the cancellable API changes

Author: dougzilla32

Sources/NSNotificationCenter+Promise.swift

@@ -36,7 +36,7 @@ extension NotificationCenter {
 
 extension NotificationCenter {
     /// Observe the named notification once
-    public func observeCC(once name: Notification.Name, object: Any? = nil) -> CancellablePromise<Notification> {
+    public func cancellableObserve(once name: Notification.Name, object: Any? = nil) -> CancellablePromise<Notification> {
         let (promise, resolver) = CancellablePromise<Notification>.pending()
 #if !os(Linux)
         let id = addObserver(forName: name, object: object, queue: nil, using: resolver.fulfill)

Sources/NSObject+Promise.swift

@@ -64,7 +64,7 @@ extension NSObject {
      - Warning: *Important* The promise must not outlive the object under observation.
      - SeeAlso: Apple’s KVO documentation.
      */
-    public func observeCC(_: PMKNamespacer, keyPath: String) -> CancellablePromise<Any?> {
+    public func cancellableObserve(_: PMKNamespacer, keyPath: String) -> CancellablePromise<Any?> {
         var task: CancellableTask!
         var reject: ((Error) -> Void)!
 

Sources/NSURLSession+Promise.swift

@@ -220,7 +220,7 @@ extension URLSession {
      Example usage with explicit cancel context:
 
          let context = firstly {
-             URLSession.shared.dataTaskCC(.promise, with: rq)
+             URLSession.shared.cancellableDataTask(.promise, with: rq)
          }.compactMap { data, _ in
              try JSONSerialization.jsonObject(with: data) as? [String: Any]
          }.then { json in
@@ -232,7 +232,7 @@ extension URLSession {
      Example usage with implicit cancel context:
 
          let promise = firstly {
-             URLSession.shared.dataTaskCC(.promise, with: rq)
+             URLSession.shared.cancellableDataTask(.promise, with: rq)
          }.compactMap { data, _ in
              try JSONSerialization.jsonObject(with: data) as? [String: Any]
          }.then { json in
@@ -245,7 +245,7 @@ extension URLSession {
 
          let context = firstly {
              let rq = OMGHTTPURLRQ.POST(url, json: parameters)
-             URLSession.shared.dataTaskCC(.promise, with: rq)
+             URLSession.shared.cancellableDataTask(.promise, with: rq)
          }.then { data, urlResponse in
              //…
          }.cancelContext
@@ -255,7 +255,7 @@ extension URLSession {
      We provide a convenience initializer for `String` specifically for this promise:
 
          let context = firstly {
-             URLSession.shared.dataTaskCC(.promise, with: rq)
+             URLSession.shared.cancellableDataTask(.promise, with: rq)
          }.compactMap(String.init).then { string in
              // decoded per the string encoding specified by the server
          }.then { string in
@@ -267,7 +267,7 @@ extension URLSession {
      Other common types can be easily decoded using compactMap also:
 
          let context = firstly {
-             URLSession.shared.dataTaskCC(.promise, with: rq)
+             URLSession.shared.cancellableDataTask(.promise, with: rq)
          }.compactMap {
              UIImage(data: $0)
          }.then {
@@ -280,7 +280,7 @@ extension URLSession {
      first as this will improve main thread performance when rendering the image:
 
          let context = firstly {
-             URLSession.shared.dataTaskCC(.promise, with: rq)
+             URLSession.shared.cancellableDataTask(.promise, with: rq)
          }.compactMap(on: QoS.userInitiated) { data, _ in
              guard let img = UIImage(data: data) else { return nil }
              _ = cgImage?.dataProvider?.data
@@ -298,7 +298,7 @@ extension URLSession {
 
      [OMGHTTPURLRQ]: https://github.com/mxcl/OMGHTTPURLRQ
      */
-    public func dataTaskCC(_: PMKNamespacer, with convertible: URLRequestConvertible) -> CancellablePromise<(data: Data, response: URLResponse)> {
+    public func cancellableDataTask(_: PMKNamespacer, with convertible: URLRequestConvertible) -> CancellablePromise<(data: Data, response: URLResponse)> {
         var task: URLSessionTask!
         var reject: ((Error) -> Void)!
 
@@ -313,7 +313,7 @@ extension URLSession {
     }
 
     /// Wraps the (Data?, URLResponse?, Error?) response from URLSession.uploadTask(with:from:) as CancellablePromise<(Data,URLResponse)>
-    public func uploadTaskCC(_: PMKNamespacer, with convertible: URLRequestConvertible, from data: Data) -> CancellablePromise<(data: Data, response: URLResponse)> {
+    public func cancellableUploadTask(_: PMKNamespacer, with convertible: URLRequestConvertible, from data: Data) -> CancellablePromise<(data: Data, response: URLResponse)> {
         var task: URLSessionTask!
         var reject: ((Error) -> Void)!
 
@@ -328,7 +328,7 @@ extension URLSession {
     }
 
     /// Wraps the (Data?, URLResponse?, Error?) response from URLSession.uploadTask(with:fromFile:) as CancellablePromise<(Data,URLResponse)>
-    public func uploadTaskCC(_: PMKNamespacer, with convertible: URLRequestConvertible, fromFile file: URL) -> CancellablePromise<(data: Data, response: URLResponse)> {
+    public func cancellableUploadTask(_: PMKNamespacer, with convertible: URLRequestConvertible, fromFile file: URL) -> CancellablePromise<(data: Data, response: URLResponse)> {
         var task: URLSessionTask!
         var reject: ((Error) -> Void)!
 
@@ -346,7 +346,7 @@ extension URLSession {
      Wraps the URLSesstionDownloadTask response from URLSession.downloadTask(with:) as CancellablePromise<(URL,URLResponse)>
      - Remark: we force a `to` parameter because Apple deletes the downloaded file immediately after the underyling completion handler returns.
      */
-    public func downloadTaskCC(_: PMKNamespacer, with convertible: URLRequestConvertible, to saveLocation: URL) -> CancellablePromise<(saveLocation: URL, response: URLResponse)> {
+    public func cancellableDownloadTask(_: PMKNamespacer, with convertible: URLRequestConvertible, to saveLocation: URL) -> CancellablePromise<(saveLocation: URL, response: URLResponse)> {
         var task: URLSessionTask!
         var reject: ((Error) -> Void)!
 

Sources/Process+Promise.swift

@@ -164,7 +164,7 @@ extension Process {
          let proc = Process()
          proc.launchPath = "/bin/ls"
          proc.arguments = ["/bin"]
-         let context = proc.launchCC(.promise).compactMap { std in
+         let context = proc.cancellableLaunch(.promise).compactMap { std in
              String(data: std.out.fileHandleForReading.readDataToEndOfFile(), encoding: .utf8)
          }.then { stdout in
              print(str)
@@ -174,7 +174,7 @@ extension Process {
 
          context.cancel()
      */
-    public func launchCC(_: PMKNamespacer) -> CancellablePromise<(out: Pipe, err: Pipe)> {
+    public func cancellableLaunch(_: PMKNamespacer) -> CancellablePromise<(out: Pipe, err: Pipe)> {
         return CancellablePromise(task: self, self.launch(.promise))
     }
 }

Sources/afterlife.swift

@@ -31,7 +31,7 @@ private class GrimReaper: NSObject {
  - Returns: A cancellable promise that resolves when the provided object deallocates, and can be unregistered and rejected by calling 'cancel'
  - Important: The promise is not guarenteed to resolve immediately when the provided object is deallocated. So you cannot write code that depends on exact timing.
  */
-public func afterCC(life object: NSObject) -> CancellablePromise<Void> {
+public func cancellableAfter(life object: NSObject) -> CancellablePromise<Void> {
     var reaper = objc_getAssociatedObject(object, &cancellableHandle) as? CancellableGrimReaper
     if reaper == nil {
         reaper = CancellableGrimReaper()

Tests/TestNSNotificationCenter.swift

@@ -28,7 +28,7 @@ extension NSNotificationCenterTests {
         let ex = expectation(description: "")
         let userInfo = ["a": 1]
 
-        NotificationCenter.default.observeCC(once: PMKTestNotification).done { value in
+        NotificationCenter.default.cancellableObserve(once: PMKTestNotification).done { value in
             XCTFail()
         }.catch(policy: .allErrors) {
             $0.isCancelled ? ex.fulfill() : XCTFail()

Tests/TestNSObject.swift

@@ -82,7 +82,7 @@ extension NSObjectTests {
         let ex = expectation(description: "")
 
         let foo = Foo()
-        foo.observeCC(.promise, keyPath: "bar").done { newValue in
+        foo.cancellableObserve(.promise, keyPath: "bar").done { newValue in
             XCTAssertEqual(newValue as? String, "moo")
             XCTFail()
             // ex.fulfill()
@@ -98,7 +98,7 @@ extension NSObjectTests {
         let ex = expectation(description: "")
 
         let foo = Foo()
-        let p = foo.observeCC(.promise, keyPath: "bar").done { newValue in
+        let p = foo.cancellableObserve(.promise, keyPath: "bar").done { newValue in
             XCTAssertEqual(newValue as? String, "moo")
             XCTFail()
             // ex.fulfill()
@@ -119,7 +119,7 @@ extension NSObjectTests {
             var p: CancellableFinalizer!
             func innerScope() {
                 killme = NSObject()
-                p = afterCC(life: killme).done { _ in
+                p = cancellableAfter(life: killme).done { _ in
                     XCTFail()
                 }.catch(policy: .allErrors) {
                     $0.isCancelled ? ex.fulfill() : XCTFail()
@@ -146,12 +146,12 @@ extension NSObjectTests {
             var p1, p2: CancellableFinalizer!
             func innerScope() {
                 killme = NSObject()
-                p1 = afterCC(life: killme).done { _ in
+                p1 = cancellableAfter(life: killme).done { _ in
                     XCTFail()
                 }.catch(policy: .allErrors) {
                     $0.isCancelled ? ex1.fulfill() : XCTFail()
                 }
-                p2 = afterCC(life: killme).done { _ in
+                p2 = cancellableAfter(life: killme).done { _ in
                     XCTFail()
                 }.catch(policy: .allErrors) {
                     $0.isCancelled ? ex2.fulfill() : XCTFail()

Tests/TestNSTask.swift

@@ -58,7 +58,7 @@ extension NSTaskTests {
         task.launchPath = "/usr/bin/man"
         task.arguments = ["ls"]
 
-        let context = task.launchCC(.promise).done { stdout, _ in
+        let context = task.cancellableLaunch(.promise).done { stdout, _ in
             let stdout = String(data: stdout.fileHandleForReading.readDataToEndOfFile(), encoding: .utf8)
             XCTAssertEqual(stdout, "bar\n")
         }.catch(policy: .allErrors) { error in
@@ -76,7 +76,7 @@ extension NSTaskTests {
         task.launchPath = "/bin/ls"
         task.arguments = ["-l", dir]
 
-        let context = task.launchCC(.promise).done { _ in
+        let context = task.cancellableLaunch(.promise).done { _ in
             XCTFail("failed to cancel process")
         }.catch(policy: .allErrors) { error in
             error.isCancelled ? ex.fulfill() : XCTFail("unexpected error \(error)")

Tests/TestNSURLSession.swift

@@ -88,7 +88,7 @@ extension NSURLSessionTests {
         let ex = expectation(description: "")
         let rq = URLRequest(url: URL(string: "http://example.com")!)
         let context = firstly {
-            URLSession.shared.dataTaskCC(.promise, with: rq)
+            URLSession.shared.cancellableDataTask(.promise, with: rq)
         }.compactMap {
             try JSONSerialization.jsonObject(with: $0.data) as? NSDictionary
         }.done { rsp in
@@ -115,8 +115,8 @@ extension NSURLSessionTests {
         let ex = expectation(description: "")
         let rq = URLRequest(url: URL(string: "http://example.com")!)
 
-        let context = afterCC(.milliseconds(100)).then {
-            URLSession.shared.dataTaskCC(.promise, with: rq)
+        let context = cancellable(after(.milliseconds(100))).then {
+            URLSession.shared.cancellableDataTask(.promise, with: rq)
         }.done { x in
             XCTAssertEqual(x.data, dummy)
             ex.fulfill()
@@ -140,8 +140,8 @@ extension NSURLSessionTests {
         let ex = expectation(description: "")
         let rq = URLRequest(url: URL(string: "http://example.com")!)
 
-        let context = afterCC(.milliseconds(100)).then {
-            URLSession.shared.dataTaskCC(.promise, with: rq)
+        let context = cancellable(after(.milliseconds(100))).then {
+            URLSession.shared.cancellableDataTask(.promise, with: rq)
         }.map(String.init).done {
             XCTAssertEqual($0, dummy)
             ex.fulfill()