Merge pull request #152 from JensAyton/deprecated-convenience-connectables

Simplify and deprecate ConnectableConvenienceClasses

Author: JensAyton

Mobius.xcodeproj/project.pbxproj

@@ -320,7 +320,7 @@
 		2D3A6972235737430053C95E /* WorkBag.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WorkBag.swift; sourceTree = "<group>"; };
 		2D3A69752359EAA00053C95E /* WorkBagTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WorkBagTests.swift; sourceTree = "<group>"; };
 		2D3EEB9523FADA9E006E478A /* AsyncStartStopStateMachine.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AsyncStartStopStateMachine.swift; sourceTree = "<group>"; };
-		2D3F26EC237B02B8004C2B75 /* AsyncDispatchQueueConnectable.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; name = AsyncDispatchQueueConnectable.swift; path = ConnectableConvenienceClasses/AsyncDispatchQueueConnectable.swift; sourceTree = "<group>"; };
+		2D3F26EC237B02B8004C2B75 /* AsyncDispatchQueueConnectable.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AsyncDispatchQueueConnectable.swift; sourceTree = "<group>"; };
 		2D58735F238EC60F001F21ED /* EventRouterDisposalLogicalRaceRegressionTest.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EventRouterDisposalLogicalRaceRegressionTest.swift; sourceTree = "<group>"; };
 		2DA1E89A2449EF6E00D240B7 /* BeginnerLoop.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BeginnerLoop.swift; sourceTree = "<group>"; };
 		2DA1E89D2449F1ED00D240B7 /* WikiTutorialTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WikiTutorialTest.swift; sourceTree = "<group>"; };
@@ -574,15 +574,15 @@
 			);
 			sourceTree = "<group>";
 		};
-		5B1F1038210F5E7D0067193C /* ConnectableConvenienceClasses */ = {
+		5B1F1038210F5E7D0067193C /* Deprecated */ = {
 			isa = PBXGroup;
 			children = (
 				5B1F103B210F5EBC0067193C /* ActionConnectable.swift */,
 				5B1F1039210F5E9A0067193C /* BlockingFunctionConnectable.swift */,
 				5B1F1042210F5F590067193C /* ClosureConnectable.swift */,
 				5B1F103E210F5EE40067193C /* ConsumerConnectable.swift */,
 			);
-			path = ConnectableConvenienceClasses;
+			path = Deprecated;
 			sourceTree = "<group>";
 		};
 		5B1F1045211036FC0067193C /* ConnectableConvenienceClassesTests */ = {
@@ -697,7 +697,7 @@
 			isa = PBXGroup;
 			children = (
 				02D0DDBC2366EF8D00A1CE4C /* EffectHandlers */,
-				5B1F1038210F5E7D0067193C /* ConnectableConvenienceClasses */,
+				5B1F1038210F5E7D0067193C /* Deprecated */,
 				5BB287BC209995410043B530 /* Disposables */,
 				5B4A369821107D0E00279C7D /* EventSources */,
 				2D3EEB9523FADA9E006E478A /* AsyncStartStopStateMachine.swift */,

MobiusCore/Source/ConnectableConvenienceClasses/AsyncDispatchQueueConnectable.swift renamed to MobiusCore/Source/AsyncDispatchQueueConnectable.swift

@@ -22,6 +22,8 @@ import Foundation
 /// Base class for creating an action based `connectable`.
 ///
 /// Invoking the `connection` functions will block the current thread until done.
+// swiftlint:disable:next line_length
+@available(*, deprecated, message: "ActionConnectable will be removed before Mobius 1.0. If you’re using it with EffectRouter, you probably don’t need an explicit connectable, just route to your action function.")
 open class ActionConnectable<Input, Output>: Connectable {
     private var innerConnectable: ClosureConnectable<Input, Output>
 

MobiusCore/Source/ConnectableConvenienceClasses/ActionConnectable.swift renamed to MobiusCore/Source/Deprecated/ActionConnectable.swift

@@ -22,6 +22,8 @@ import Foundation
 /// Base class for creating a function based `connectable`.
 ///
 /// Invoking the `connection` functions will block the current thread until done.
+// swiftlint:disable:next line_length
+@available(*, deprecated, message: "BlockingFunctionConnectable will be removed before Mobius 1.0. If you’re using it with EffectRouter, you probably don’t need an explicit connectable, just route to your fire-and-forget function.")
 open class BlockingFunctionConnectable<Input, Output>: Connectable {
     private var innerConnectable: ClosureConnectable<Input, Output>
 

MobiusCore/Source/ConnectableConvenienceClasses/BlockingFunctionConnectable.swift renamed to MobiusCore/Source/Deprecated/BlockingFunctionConnectable.swift

@@ -20,36 +20,19 @@
 import Foundation
 
 final class ClosureConnectable<Input, Output>: Connectable {
-    private var queue: DispatchQueue?
     private var output: Consumer<Output>?
     private let closure: (Input) -> Output?
     private let lock = Lock()
 
-    // If the closure produces output, it will be passed to the consumer. If it doesnt, it wont (see `connect`).
-    init(_ closure: @escaping (Input) -> Output?, queue: DispatchQueue? = nil) {
-        self.closure = closure
-        self.queue = queue
-    }
-
-    init(_ outputClosure: @escaping (Input) -> Output, queue: DispatchQueue? = nil) {
+    init(_ outputClosure: @escaping (Input) -> Output) {
         closure = outputClosure
-        self.queue = queue
     }
 
-    init(_ noOutputClosure: @escaping (Input) -> Void, queue: DispatchQueue? = nil) {
+    init(_ noOutputClosure: @escaping (Input) -> Void) {
         closure = { input in
             noOutputClosure(input)
             return nil
         }
-        self.queue = queue
-    }
-
-    init(_ nothing: @escaping () -> Void, queue: DispatchQueue? = nil) {
-        closure = { _ in
-            nothing()
-            return nil
-        }
-        self.queue = queue
     }
 
     private func dispatchInput(_ input: Input, consumer: @escaping Consumer<Output>) {
@@ -66,13 +49,7 @@ final class ClosureConnectable<Input, Output>: Connectable {
             return Connection(
                 acceptClosure: { input in
                     if let consumer = self.output {
-                        if let queue = self.queue {
-                            queue.async {
-                                self.dispatchInput(input, consumer: consumer)
-                            }
-                        } else {
-                            self.dispatchInput(input, consumer: consumer)
-                        }
+                        self.dispatchInput(input, consumer: consumer)
                     }
                 },
                 disposeClosure: {

MobiusCore/Source/ConnectableConvenienceClasses/ClosureConnectable.swift renamed to MobiusCore/Source/Deprecated/ClosureConnectable.swift

@@ -22,6 +22,8 @@ import Foundation
 /// Base class for creating a consumer based `connectable`.
 ///
 /// Invoking the `connection` functions will block the current thread until done.
+// swiftlint:disable:next line_length
+@available(*, deprecated, message: "ConsumerConnectable will be removed before Mobius 1.0. If you’re using it with EffectRouter, you probably don’t need an explicit connectable, just route to your consumer function.")
 open class ConsumerConnectable<Input, Output>: Connectable {
     private var innerConnectable: ClosureConnectable<Input, Output>