Rename then/catch to onComplete/onSuccess/onFailure.

Author: inamiy

SwiftTask/SwiftTask.swift

@@ -199,7 +199,7 @@ public class Task<Progress, Value, Error>
         }
 
         // TODO: how to nest these inside StateMachine's initClosure? (using `self` is not permitted)
-        // NOTE: use order > 100 (default) to let `progressTupleClosure(self.progress, newValue)` be invoked first before updating old `self.progress`
+        // NOTE: use order > 100 (default) to let `progressClosure(self.progress, newValue)` be invoked first before updating old `self.progress`
         self.machine.addEventHandler(.Progress, order: 110) { [weak self] context in
             if let progress = context.userInfo as? Progress {
                 if let self_ = self {
@@ -278,49 +278,37 @@ public class Task<Progress, Value, Error>
         self._cancel(error: nil)
     }
 
-    /// progress + newValue only
-    public func progress(progressClosure: Progress -> Void) -> Task
-    {
-        self.machine.addEventHandler(.Progress) { [weak self] context in
-            if let progress = context.userInfo as? Progress {
-                progressClosure(progress)
-            }
-        }
-        
-        return self
-    }
-    
-    /// progress + (oldValue, newValue)
-    public func progress(progressTupleClosure: (oldValue: Progress?, newValue: Progress) -> Void) -> Task
+    /// task.onProgress
+    public func onProgress(progressClosure: (oldValue: Progress?, newValue: Progress) -> Void) -> Task
     {
         self.machine.addEventHandler(.Progress) { [weak self] context in
             if let progress = context.userInfo as? Progress {
                 if let self_ = self {
-                    progressTupleClosure(oldValue: self_.progress, newValue: progress)
+                    progressClosure(oldValue: self_.progress, newValue: progress)
                 }
             }
         }
 
         return self
     }
 
-    /// then (fulfilled & rejected) + returning value
-    public func then<Value2>(thenClosure: (Value?, ErrorInfo?) -> Value2) -> Task<Progress, Value2, Error>
+    /// onComplete (fulfilled & rejected) + closure returning value
+    public func onComplete<Value2>(completeClosure: (Value?, ErrorInfo?) -> Value2) -> Task<Progress, Value2, Error>
     {
-        return self.then { (value: Value?, errorInfo: ErrorInfo?) -> Task<Progress, Value2, Error> in
-            return Task<Progress, Value2, Error>(value: thenClosure(value, errorInfo))
+        return self.onComplete { (value: Value?, errorInfo: ErrorInfo?) -> Task<Progress, Value2, Error> in
+            return Task<Progress, Value2, Error>(value: completeClosure(value, errorInfo))
         }
     }
 
-    /// then (fulfilled & rejected) + returning task
-    public func then<Progress2, Value2>(thenClosure: (Value?, ErrorInfo?) -> Task<Progress2, Value2, Error>) -> Task<Progress2, Value2, Error>
+    /// onComplete (fulfilled & rejected) + closure returning task
+    public func onComplete<Progress2, Value2>(completeClosure: (Value?, ErrorInfo?) -> Task<Progress2, Value2, Error>) -> Task<Progress2, Value2, Error>
     {
         let newTask = Task<Progress2, Value2, Error> { [weak self] (progress, fulfill, _reject: _RejectHandler, configure) in
 
             let bind = { (value: Value?, errorInfo: ErrorInfo?) -> Void in
-                let innerTask = thenClosure(value, errorInfo)
+                let innerTask = completeClosure(value, errorInfo)
 
-                // NOTE: don't call then/catch for innerTask, or recursive bindings may occur
+                // NOTE: don't call `then` for innerTask, or recursive bindings may occur
                 // Bad example: https://github.com/inamiy/SwiftTask/blob/e6085465c147fb2211fb2255c48929fcc07acd6d/SwiftTask/SwiftTask.swift#L312-L316
                 switch innerTask.machine.state {
                     case .Fulfilled:
@@ -370,23 +358,23 @@ public class Task<Progress, Value, Error>
         return newTask
     }
 
-    /// then (fulfilled only) + returning value
-    public func then<Value2>(fulfilledClosure: Value -> Value2) -> Task<Progress, Value2, Error>
+    /// onSuccess + closure returning value
+    public func onSuccess<Value2>(fulfilledClosure: Value -> Value2) -> Task<Progress, Value2, Error>
     {
-        return self.then { (value: Value) -> Task<Progress, Value2, Error> in
+        return self.onSuccess { (value: Value) -> Task<Progress, Value2, Error> in
             return Task<Progress, Value2, Error>(value: fulfilledClosure(value))
         }
     }
 
-    /// then (fulfilled only) + returning task
-    public func then<Progress2, Value2>(fulfilledClosure: Value -> Task<Progress2, Value2, Error>) -> Task<Progress2, Value2, Error>
+    /// onSuccess + closure returning task
+    public func onSuccess<Progress2, Value2>(fulfilledClosure: Value -> Task<Progress2, Value2, Error>) -> Task<Progress2, Value2, Error>
     {
         let newTask = Task<Progress2, Value2, Error> { [weak self] (progress, fulfill, _reject: _RejectHandler, configure) in
 
             let bind = { (value: Value) -> Void in
                 let innerTask = fulfilledClosure(value)
 
-                innerTask.then { (value: Value2?, errorInfo: ErrorInfo?) -> Void in
+                innerTask.onComplete { (value: Value2?, errorInfo: ErrorInfo?) -> Void in
                     if let value = value {
                         fulfill(value)
                     }
@@ -425,23 +413,23 @@ public class Task<Progress, Value, Error>
         return newTask
     }
 
-    /// catch + returning value
-    public func catch(catchClosure: ErrorInfo -> Value) -> Task
+    /// onFailure + closure returning value
+    public func onFailure(failureClosure: ErrorInfo -> Value) -> Task
     {
-        return self.catch { (errorInfo: ErrorInfo) -> Task in
-            return Task(value: catchClosure(errorInfo))
+        return self.onFailure { (errorInfo: ErrorInfo) -> Task in
+            return Task(value: failureClosure(errorInfo))
         }
     }
 
-    /// catch + returning task
-    public func catch(catchClosure: ErrorInfo -> Task) -> Task
+    /// onFailure + closure returning task
+    public func onFailure(failureClosure: ErrorInfo -> Task) -> Task
     {
         let newTask = Task { [weak self] (progress, fulfill, _reject: _RejectHandler, configure) in
 
             let bind = { (errorInfo: ErrorInfo) -> Void in
-                let innerTask = catchClosure(errorInfo)
+                let innerTask = failureClosure(errorInfo)
 
-                innerTask.then { (value: Value?, errorInfo: ErrorInfo?) -> Void in
+                innerTask.onComplete { (value: Value?, errorInfo: ErrorInfo?) -> Void in
                     if let value = value {
                         fulfill(value)
                     }
@@ -512,7 +500,7 @@ extension Task
             let totalCount = tasks.count
 
             for task in tasks {
-                task.then { (value: Value) -> Void in
+                task.onSuccess { (value: Value) -> Void in
 
                     synchronized(self) {
                         completedCount++
@@ -531,7 +519,7 @@ extension Task
                         }
                     }
 
-                }.catch { (errorInfo: ErrorInfo) -> Void in
+                }.onFailure { (errorInfo: ErrorInfo) -> Void in
 
                     synchronized(self) {
                         _reject(errorInfo)
@@ -559,7 +547,7 @@ extension Task
             let totalCount = tasks.count
 
             for task in tasks {
-                task.then { (value: Value) -> Void in
+                task.onSuccess { (value: Value) -> Void in
 
                     synchronized(self) {
                         completedCount++
@@ -571,7 +559,7 @@ extension Task
                         }
                     }
 
-                }.catch { (errorInfo: ErrorInfo) -> Void in
+                }.onFailure { (errorInfo: ErrorInfo) -> Void in
 
                     synchronized(self) {
                         rejectedCount++
@@ -594,7 +582,7 @@ extension Task
     }
 
     /// Returns new task which performs all given tasks and stores only fulfilled values.
-    /// This new task will NEVER be internally rejected (thus uncatchable from outside).
+    /// This new task will NEVER be internally rejected.
     public class func some(tasks: [Task]) -> Task<BulkProgress, [Value], Error>
     {
         return Task<BulkProgress, [Value], Error> { (progress, fulfill, _reject: _RejectHandler, configure) in
@@ -603,7 +591,7 @@ extension Task
             let totalCount = tasks.count
 
             for task in tasks {
-                task.then { (value: Value?, errorInfo: ErrorInfo?) -> Void in
+                task.onComplete { (value: Value?, errorInfo: ErrorInfo?) -> Void in
 
                     synchronized(self) {
                         completedCount++

SwiftTaskTests/AlamofireTests.swift

@@ -39,7 +39,7 @@ class AlamofireTests: _TestCase
 
         }
 
-        task.then { (value: String) -> Void in
+        task.onComplete { (value: String) -> Void in
             XCTAssertEqual(value, "OK")
 
             expect.fulfill()
@@ -74,11 +74,11 @@ class AlamofireTests: _TestCase
 
         }
 
-        task.then { (value: String?) -> Void in
+        task.onComplete { (value: String?) -> Void in
 
             XCTFail("Should never reach here.")
 
-        }.catch { (error: NSError?, isCancelled: Bool) -> Void in
+        }.onFailure { (error: NSError?, isCancelled: Bool) -> Void in
 
 //            println(error)
 
@@ -123,14 +123,14 @@ class AlamofireTests: _TestCase
 
         }
 
-        // set progress & then
-        task.progress { progress in
+        // set onProgress & onComplete
+        task.onProgress { progress in
 
             println("bytesWritten = \(progress.bytesWritten)")
             println("totalBytesWritten = \(progress.totalBytesWritten)")
             println("totalBytesExpectedToWrite = \(progress.totalBytesExpectedToWrite)")
 
-        }.then { (value: String) -> Void in
+        }.onComplete { (value: String) -> Void in
 
             XCTAssertEqual(value, "OK")
 
@@ -173,7 +173,7 @@ class AlamofireTests: _TestCase
         }
 
         // set then
-        task.then { (value: String) -> Void in
+        task.onComplete { (value: String) -> Void in
 
             XCTAssertEqual(value, "OK")
             XCTAssertEqual(nsProgress.completedUnitCount, 50)
@@ -226,13 +226,13 @@ class AlamofireTests: _TestCase
                 }
             }
 
-        } // end of 1st task definition (NOTE: don't chain with `then` or `catch` for 1st task cancellation)
+        } // end of 1st task definition (NOTE: don't chain with `onComplete` or `onFailure` for 1st task cancellation)
 
-        task.then { (value: String?) -> Void in
+        task.onComplete { (value: String?) -> Void in
 
             XCTFail("Should never reach here because task is cancelled.")
 
-        }.catch { (error: NSError?, isCancelled: Bool) -> Void in
+        }.onFailure { (error: NSError?, isCancelled: Bool) -> Void in
 
 //            println(error)
 

SwiftTaskTests/BasicTests.swift

@@ -36,21 +36,21 @@ class BasicTests: _TestCase
 
         }
 
-        task.progress { (progress: Float) in
+        task.onProgress { oldValue, newValue in
 
-            println("progress = \(progress)")
+            println("progress = \(newValue)")
 
-        }.then { (value: String) -> String in  // then(onFulfilled)
+        }.onSuccess { (value: String) -> String in  // `task.onSuccess {...}` = JavaScript's `promise.then(onFulfilled)`
 
             XCTAssertEqual(value, "OK")
             return "Now OK"
 
-        }.catch { (error: ErrorString?, isCancelled: Bool) -> String in  // catch(onRejected)
+        }.onFailure { (error: ErrorString?, isCancelled: Bool) -> String in  // `task.onFailure {...}` = JavaScript's `promise.catch(onRejected)`
 
             XCTAssertEqual(error!, "ERROR")
             return "Now RECOVERED"
 
-        }.then { (value: String?, errorInfo: Task.ErrorInfo?) -> Task in // then(onFulfilled+onRejected)
+        }.onComplete { (value: String?, errorInfo: Task.ErrorInfo?) -> Task in // `task.onComplete {...}` = JavaScript's `promise.then(onFulfilled, onRejected)`
 
             println("value = \(value)") // either "Now OK" or "Now RECOVERED"
 
@@ -59,7 +59,7 @@ class BasicTests: _TestCase
 
             return Task(error: "ABORT")
 
-        }.then { (value: String?, errorInfo: Task.ErrorInfo?) -> Void in // then(onFulfilled+onRejected)
+        }.onComplete { (value: String?, errorInfo: Task.ErrorInfo?) -> Void in
 
             println("errorInfo = \(errorInfo)")
 

SwiftTaskTests/RetainCycleTests.swift

@@ -78,9 +78,7 @@ class RetainCycleTests: _TestCase
         XCTAssertNotNil(self.task, "self.task (weak) should NOT be nil because of retain cycle: task <- dispatch_queue.")
         XCTAssertNotNil(self.player, "self.player (weak) should NOT nil because player is not retained by dispatch_queue.")
 
-        println("then")
-            
-        self.task!.then { (value: String) -> Void in
+        self.task!.onSuccess { (value: String) -> Void in
 
             XCTAssertEqual(value, "OK")
             expect.fulfill()
@@ -126,9 +124,7 @@ class RetainCycleTests: _TestCase
         XCTAssertNotNil(self.task, "self.task (weak) should NOT be nil because of retain cycle: task <- dispatch_queue.")
         XCTAssertNotNil(self.player, "self.player (weak) should NOT be nil because of retain cycle: player <- configure <- task.")
 
-        println("then")
-        
-        self.task!.then { (value: String) -> Void in
+        self.task!.onSuccess { (value: String) -> Void in
 
             XCTAssertEqual(value, "OK")
             expect.fulfill()
@@ -170,9 +166,7 @@ class RetainCycleTests: _TestCase
         XCTAssertNotNil(self.task, "self.task (weak) should not be nil because of retain cycle: task <- player <- dispatch_queue.")
         XCTAssertNotNil(self.player, "self.player (weak) should not be nil because of retain cycle: player <- configure <- task.")
 
-        println("then")
-        
-        self.task!.then { (value: String) -> Void in
+        self.task!.onSuccess { (value: String) -> Void in
 
             XCTAssertEqual(value, "OK")
             expect.fulfill()
@@ -216,9 +210,7 @@ class RetainCycleTests: _TestCase
         XCTAssertNotNil(self.task, "self.task (weak) should not be nil because of retain cycle: task <- player <- dispatch_queue.")
         XCTAssertNotNil(self.player, "self.player (weak) should not be nil because of retain cycle: player <- configure <- task.")
 
-        println("then")
-        
-        self.task!.then { (value: String) -> Void in
+        self.task!.onSuccess { (value: String) -> Void in
 
             XCTAssertEqual(value, "OK")
             expect.fulfill()