[Proposal] - Define Mocks and stubs next to the implementation (#172)

* Mocks and stubs to the source * Update Cookbook/Proposals/MocksAndStubsNextToImplementation.md Co-Authored-By: João Pereira <[email protected]> * Update Cookbook/Proposals/MocksAndStubsNextToImplementation.md Co-Authored-By: João Pereira <[email protected]> Co-authored-by: João Pereira <[email protected]>
babylonhealth · Sep 28, 2020 · f1fed5b · f1fed5b
1 parent e171a44
commit f1fed5b
Showing 1 changed file with 53 additions and 0 deletions.
diff --git a/Cookbook/Proposals/MocksAndStubsNextToImplementation.md b/Cookbook/Proposals/MocksAndStubsNextToImplementation.md
@@ -0,0 +1,53 @@
+# Put Mocks, Stubs Next to Implementation
+
+* Author(s): Sergey Shulga
+* Review Manager: TBD
+
+## Introduction
+
+Put implementation of mocks next to the implementation of the protocol
+
+## Motivation
+
+
+- Improves Discoverability of mocks
+- Prevents mocks duplication (Because we usually define mocks in the `FrameworkTests` target which means they can only be used there)
+- Easy to change mock implementation once public API changes
+
+
+## Proposed solution
+
+
+```swift
+public protocol BiometricAuthControllerProtocol {
+    var isRegistered: Bool { get }
+    var supportedBiometry: BiometryType { get }
+    var biometricDataHasChanged: Bool { get }
+
+    func register() -> SignalProducer<Never, BiometricAuthError>
+    func unregister() -> SignalProducer<Never, BiometricAuthError>
+    func signedNonce() -> SignalProducer<Data, BiometricAuthError>
+}
+
+public final class BiometricAuthController: BiometricAuthControllerProtocol {
+// Implementation
+}
+
+#if DEBUG
+
+public final class MockBiometricAuthController: BiometricAuthControllerProtocol {
+// Implementation
+}
+
+#endif
+
+```
+
+## Impact on existing codebase
+
+This proposal does not break anything, allows gradual migration.
+
+## Alternatives considered
+
+Leave as it is
+