Deprecate Store.publisherScope (#758)

Author: mluisbrown

Sources/ComposableArchitecture/Internal/Deprecations.swift

@@ -5,6 +5,70 @@ import SwiftUI
 
 // NB: Deprecated after 0.27.1:
 
+extension Store {
+  /// Scopes the store to a producer of stores of more local state and local actions.
+  ///
+  /// - Parameters:
+  ///   - toLocalState: A function that transforms a producer of `State` into a producer of
+  ///     `LocalState`.
+  ///   - fromLocalAction: A function that transforms `LocalAction` into `Action`.
+  /// - Returns: A producer of stores with its domain (state and action) transformed.
+  @available(
+    *, deprecated,
+    message:
+      "If you use this method, please open a discussion on GitHub and let us know how: https://github.com/pointfreeco/swift-composable-architecture/discussions/new"
+  )
+  public func producerScope<LocalState, LocalAction>(
+    state toLocalState: @escaping (Effect<State, Never>) -> Effect<LocalState, Never>,
+    action fromLocalAction: @escaping (LocalAction) -> Action
+  ) -> Effect<Store<LocalState, LocalAction>, Never> {
+
+    func extractLocalState(_ state: State) -> LocalState? {
+      var localState: LocalState?
+      _ = toLocalState(Effect(value: state))
+        .startWithValues { localState = $0 }
+      return localState
+    }
+
+    return toLocalState(self.producer)
+      .map { localState in
+        let localStore = Store<LocalState, LocalAction>(
+          initialState: localState,
+          reducer: .init { localState, localAction, _ in
+            self.send(fromLocalAction(localAction))
+            localState = extractLocalState(self.state) ?? localState
+            return .none
+          },
+          environment: ()
+        )
+        localStore.parentDisposable = self.producer.startWithValues {
+          [weak localStore] state in
+          guard let localStore = localStore else { return }
+          localStore.state = extractLocalState(state) ?? localStore.state
+        }
+        return localStore
+      }
+  }
+
+  /// Scopes the store to a producer of stores of more local state and local actions.
+  ///
+  /// - Parameter toLocalState: A function that transforms a producer of `State` into a producer
+  ///   of `LocalState`.
+  /// - Returns: A producer of stores with its domain (state and action)
+  ///   transformed.
+  @available(
+    *, deprecated,
+    message:
+      "If you use this method, please open a discussion on GitHub and let us know how: https://github.com/pointfreeco/swift-composable-architecture/discussions/new"
+  )
+  public func producerScope<LocalState>(
+    state toLocalState: @escaping (Effect<State, Never>) -> Effect<LocalState, Never>
+  ) -> Effect<Store<LocalState, Action>, Never> {
+    self.producerScope(state: toLocalState, action: { $0 })
+  }
+
+}
+
 extension ViewStore {
   @available(
     *, deprecated,

Sources/ComposableArchitecture/Store.swift

@@ -124,9 +124,9 @@ public final class Store<State, Action> {
     Property<State>(initial: state, then: self.statePipe.output).producer
   }
   var effectDisposables: [UUID: Disposable] = [:]
+  var parentDisposable: Disposable?
 
   private var isSending = false
-  private var parentDisposable: Disposable?
   private let reducer: (inout State, Action) -> Effect<Action, Never>
   private var bufferedActions: [Action] = []
   #if DEBUG
@@ -325,57 +325,6 @@ public final class Store<State, Action> {
     self.scope(state: toLocalState, action: { $0 })
   }
 
-  /// Scopes the store to a producer of stores of more local state and local actions.
-  ///
-  /// - Parameters:
-  ///   - toLocalState: A function that transforms a producer of `State` into a producer of
-  ///     `LocalState`.
-  ///   - fromLocalAction: A function that transforms `LocalAction` into `Action`.
-  /// - Returns: A producer of stores with its domain (state and action) transformed.
-  public func producerScope<LocalState, LocalAction>(
-    state toLocalState: @escaping (Effect<State, Never>) -> Effect<LocalState, Never>,
-    action fromLocalAction: @escaping (LocalAction) -> Action
-  ) -> Effect<Store<LocalState, LocalAction>, Never> {
-
-    func extractLocalState(_ state: State) -> LocalState? {
-      var localState: LocalState?
-      _ = toLocalState(Effect(value: state))
-        .startWithValues { localState = $0 }
-      return localState
-    }
-
-    return toLocalState(self.producer)
-      .map { localState in
-        let localStore = Store<LocalState, LocalAction>(
-          initialState: localState,
-          reducer: .init { localState, localAction, _ in
-            self.send(fromLocalAction(localAction))
-            localState = extractLocalState(self.state) ?? localState
-            return .none
-          },
-          environment: ()
-        )
-        localStore.parentDisposable = self.producer.startWithValues {
-          [weak localStore] state in
-          guard let localStore = localStore else { return }
-          localStore.state = extractLocalState(state) ?? localStore.state
-        }
-        return localStore
-      }
-  }
-
-  /// Scopes the store to a producer of stores of more local state and local actions.
-  ///
-  /// - Parameter toLocalState: A function that transforms a producer of `State` into a producer
-  ///   of `LocalState`.
-  /// - Returns: A producer of stores with its domain (state and action)
-  ///   transformed.
-  public func producerScope<LocalState>(
-    state toLocalState: @escaping (Effect<State, Never>) -> Effect<LocalState, Never>
-  ) -> Effect<Store<LocalState, Action>, Never> {
-    self.producerScope(state: toLocalState, action: { $0 })
-  }
-
   func send(_ action: Action, isFromViewStore: Bool = true) {
     self.threadCheck(status: .send(action, isFromViewStore: isFromViewStore))
 

Tests/ComposableArchitectureTests/BindingTests.swift

@@ -32,6 +32,6 @@ final class BindingTests: XCTestCase {
 
     viewStore.binding(\.$nested.field).wrappedValue = "Hello"
 
-    XCTAssertNoDifference(viewStore.state, .init(nested: .init(field: "Hello!")))
+    XCTAssertEqual(viewStore.state, .init(nested: .init(field: "Hello!")))
   }
 }

Tests/ComposableArchitectureTests/StoreTests.swift

@@ -117,34 +117,6 @@ final class StoreTests: XCTestCase {
     XCTAssertEqual(values, [0, 1])
   }
 
-  func testScopeWithPublisherTransform() {
-    let counterReducer = Reducer<Int, Int, Void> { state, action, _ in
-      state = action
-      return .none
-    }
-    let parentStore = Store(initialState: 0, reducer: counterReducer, environment: ())
-
-    var outputs: [String] = []
-
-    parentStore
-      .producerScope(state: { $0.map { "\($0)" }.skipRepeats() })
-      .startWithValues { childStore in
-        childStore.producer
-          .startWithValues { outputs.append($0) }
-      }
-
-    parentStore.send(0)
-    XCTAssertEqual(outputs, ["0"])
-    parentStore.send(0)
-    XCTAssertEqual(outputs, ["0"])
-    parentStore.send(1)
-    XCTAssertEqual(outputs, ["0", "1"])
-    parentStore.send(1)
-    XCTAssertEqual(outputs, ["0", "1"])
-    parentStore.send(2)
-    XCTAssertEqual(outputs, ["0", "1", "2"])
-  }
-
   func testScopeCallCount() {
     let counterReducer = Reducer<Int, Void, Void> { state, _, _ in state += 1
       return .none
@@ -276,35 +248,6 @@ final class StoreTests: XCTestCase {
     XCTAssertEqual(ViewStore(store).state, 100_000)
   }
 
-  func testPublisherScope() {
-    let appReducer = Reducer<Int, Bool, Void> { state, action, _ in
-      state += action ? 1 : 0
-      return .none
-    }
-
-    let parentStore = Store(initialState: 0, reducer: appReducer, environment: ())
-
-    var outputs: [Int] = []
-
-    parentStore
-      .producerScope { $0.skipRepeats() }
-      .startWithValues { outputs.append($0.state) }
-
-    XCTAssertEqual(outputs, [0])
-
-    parentStore.send(true)
-    XCTAssertEqual(outputs, [0, 1])
-
-    parentStore.send(false)
-    XCTAssertEqual(outputs, [0, 1])
-    parentStore.send(false)
-    XCTAssertEqual(outputs, [0, 1])
-    parentStore.send(false)
-    XCTAssertEqual(outputs, [0, 1])
-    parentStore.send(false)
-    XCTAssertEqual(outputs, [0, 1])
-  }
-
   func testIfLetAfterScope() {
     struct AppState {
       var count: Int?