Moves Action to be non-optional in bindTo() functions.

Author: ashfurrow

Sources/Action/UIKitExtensions/UIBarButtonItem+Action.swift

@@ -38,12 +38,8 @@ public extension Reactive where Base: UIBarButtonItem {
         }
     }
 
-    public func bindTo<Input, Output>(action: Action<Input, Output>?, inputTransform: @escaping (Base) -> (Input)) {
-        self.base.resetActionDisposeBag()
-        
-        guard let action = action else {
-            return
-        }
+    public func bindTo<Input, Output>(action: Action<Input, Output>, inputTransform: @escaping (Base) -> (Input)) {
+        unbindAction()
 
         self.tap
             .map { inputTransform(self.base) }
@@ -56,9 +52,13 @@ public extension Reactive where Base: UIBarButtonItem {
             .addDisposableTo(self.base.actionDisposeBag)
     }
 
-    public func bindTo<Input, Output>(action: Action<Input, Output>?, input: Input) {
+    public func bindTo<Input, Output>(action: Action<Input, Output>, input: Input) {
         self.bindTo(action: action) { _ in input}
     }
-    
+
+    /// Unbinds any existing action, disposing of all subscriptions.
+    public func unbindAction() {
+        self.base.resetActionDisposeBag()
+    }
 }
 #endif

Sources/Action/UIKitExtensions/UIButton+Rx.swift

@@ -54,9 +54,10 @@ public extension Reactive where Base: UIButton {
 
     /// Binds enabled state of action to button, and subscribes to rx_tap to execute action with given input transform.
     /// These subscriptions are managed in a private, inaccessible dispose bag. To cancel
-    /// them, call bindToAction with another action or nil.
-    public func bindTo<Input, Output>(action:Action<Input, Output>?, inputTransform: @escaping (Base) -> (Input))   {
+    /// them, call bindToAction with another action or call unbindAction().
+    public func bindTo<Input, Output>(action:Action<Input, Output>, inputTransform: @escaping (Base) -> (Input))   {
         // This effectively disposes of any existing subscriptions.
+        unbindAction()
 
         // Technically, this file is only included on tv/iOS platforms,
         // so this optional will never be nil. But let's be safe 😉
@@ -76,8 +77,8 @@ public extension Reactive where Base: UIButton {
 
     /// Binds enabled state of action to button, and subscribes to rx_tap to execute action with given input value.
     /// These subscriptions are managed in a private, inaccessible dispose bag. To cancel
-    /// them, call bindToAction with another action or nil.
-    public func bindTo<Input, Output>(action: Action<Input, Output>?, input: Input) {
+    /// them, call bindToAction with another action or call unbindAction().
+    public func bindTo<Input, Output>(action: Action<Input, Output>, input: Input) {
         self.bindTo(action: action) { _ in input }
     }
 }

Sources/Action/UIKitExtensions/UIControl+Rx.swift

@@ -6,15 +6,10 @@ import RxCocoa
 public extension Reactive where Base: UIControl {
     /// Binds enabled state of action to control, and subscribes action's execution to provided controlEvents.
     /// These subscriptions are managed in a private, inaccessible dispose bag. To cancel
-    /// them, set the rx.action to nil or another action.
-    public func bindTo<Input, Output>(action: Action<Input, Output>?, controlEvent: ControlEvent<Void>, inputTransform: @escaping (Base) -> (Input))   {
+    /// them, set the rx.action to nil or another action, or call unbindAction().
+    public func bindTo<Input, Output>(action: Action<Input, Output>, controlEvent: ControlEvent<Void>, inputTransform: @escaping (Base) -> (Input))   {
         // This effectively disposes of any existing subscriptions.
-        self.base.resetActionDisposeBag()
-
-        // If no action is provided, there is nothing left to do. All previous subscriptions are disposed.
-        guard let action = action else {
-            return
-        }
+        unbindAction()
 
         // For each tap event, use the inputTransform closure to provide an Input value to the action
         controlEvent
@@ -28,6 +23,11 @@ public extension Reactive where Base: UIControl {
             .bindTo(self.isEnabled)
             .addDisposableTo(self.base.actionDisposeBag)
     }
+
+    /// Unbinds any existing action, disposing of all subscriptions.
+    public func unbindAction() {
+        self.base.resetActionDisposeBag()
+    }
 }
 
 #endif

Tests/ActionTests/BindToTests.swift

@@ -64,5 +64,38 @@ class BindToTests: QuickSpec {
 
             expect(called).toEventually( beTrue() )
         }
+
+        describe("unbinding") {
+            it("unbinds actions for UIButton") {
+                let button = UIButton()
+                let action = Action<String, String>(workFactory: { _ in
+                    assertionFailure()
+                    return .empty()
+                })
+                button.rx.bindTo(action: action, input: "Hi there!")
+                // Setting the action has an asynchronous effect of adding a target.
+                expect(button.allTargets).toEventuallyNot( beEmpty() )
+
+                button.rx.unbindAction()
+                button.test_executeTap()
+
+                expect(button.allTargets).toEventually( beEmpty() )
+            }
+
+            it("actives a UIBarButtonItem") {
+                var called = false
+                let item = UIBarButtonItem()
+                let action = Action<String, String>(workFactory: { _ in
+                    called = true
+                    return .empty()
+                })
+                item.rx.bindTo(action: action, input: "Hi there!")
+
+                item.rx.unbindAction()
+                _ = item.target?.perform(item.action!, with: item)
+
+                expect(called).to( beFalse() )
+            }
+        }
     }
 }