Rename publisher-transforming scope (#314)

* Rename publisher-transforming scope

* feedback

Author: stephencelis

Sources/ComposableArchitecture/Internal/Deprecations.swift

@@ -1,5 +1,26 @@
 import Combine
 
+// NB: Deprecated after 0.9.0:
+
+extension Store {
+  @available(*, deprecated, renamed: "publisherScope(state:)")
+  public func scope<P: Publisher, LocalState>(
+    state toLocalState: @escaping (AnyPublisher<State, Never>) -> P
+  ) -> AnyPublisher<Store<LocalState, Action>, Never>
+  where P.Output == LocalState, P.Failure == Never {
+    self.publisherScope(state: toLocalState)
+  }
+
+  @available(*, deprecated, renamed: "publisherScope(state:action:)")
+  public func scope<P: Publisher, LocalState, LocalAction>(
+    state toLocalState: @escaping (AnyPublisher<State, Never>) -> P,
+    action fromLocalAction: @escaping (LocalAction) -> Action
+  ) -> AnyPublisher<Store<LocalState, LocalAction>, Never>
+  where P.Output == LocalState, P.Failure == Never {
+    self.publisherScope(state: toLocalState, action: fromLocalAction)
+  }
+}
+
 // NB: Deprecated after 0.6.0:
 
 extension Reducer {

Sources/ComposableArchitecture/Store.swift

@@ -90,7 +90,7 @@ public final class Store<State, Action> {
   ///     `LocalState`.
   ///   - fromLocalAction: A function that transforms `LocalAction` into `Action`.
   /// - Returns: A publisher of stores with its domain (state and action) transformed.
-  public func scope<P: Publisher, LocalState, LocalAction>(
+  public func publisherScope<P: Publisher, LocalState, LocalAction>(
     state toLocalState: @escaping (AnyPublisher<State, Never>) -> P,
     action fromLocalAction: @escaping (LocalAction) -> Action
   ) -> AnyPublisher<Store<LocalState, LocalAction>, Never>
@@ -123,17 +123,18 @@ public final class Store<State, Action> {
       .eraseToAnyPublisher()
   }
 
+
   /// Scopes the store to a publisher of stores of more local state and local actions.
   ///
   /// - Parameter toLocalState: A function that transforms a publisher of `State` into a publisher
   ///   of `LocalState`.
   /// - Returns: A publisher of stores with its domain (state and action)
   ///   transformed.
-  public func scope<P: Publisher, LocalState>(
+  public func publisherScope<P: Publisher, LocalState>(
     state toLocalState: @escaping (AnyPublisher<State, Never>) -> P
   ) -> AnyPublisher<Store<LocalState, Action>, Never>
   where P.Output == LocalState, P.Failure == Never {
-    self.scope(state: toLocalState, action: { $0 })
+    self.publisherScope(state: toLocalState, action: { $0 })
   }
 
   func send(_ action: Action) {

Sources/ComposableArchitecture/UIKit/IfLetUIKit.swift

@@ -45,7 +45,7 @@ extension Store {
   ) -> Cancellable where State == Wrapped? {
     let elseCancellable =
       self
-      .scope(
+      .publisherScope(
         state: { state in
           state
             .removeDuplicates(by: { ($0 != nil) == ($1 != nil) })
@@ -57,7 +57,7 @@ extension Store {
 
     let unwrapCancellable =
       self
-      .scope(
+      .publisherScope(
         state: { state in
           state
             .removeDuplicates(by: { ($0 != nil) == ($1 != nil) })

Tests/ComposableArchitectureTests/StoreTests.swift

@@ -100,7 +100,7 @@ final class StoreTests: XCTestCase {
     var outputs: [String] = []
 
     parentStore
-      .scope(state: { $0.map { "\($0)" }.removeDuplicates() })
+      .publisherScope(state: { $0.map { "\($0)" }.removeDuplicates() })
       .sink { childStore in
         childStore.state
           .sink { outputs.append($0) }
@@ -245,7 +245,7 @@ final class StoreTests: XCTestCase {
     var outputs: [Int] = []
 
     parentStore
-      .scope { $0.removeDuplicates() }
+      .publisherScope { $0.removeDuplicates() }
       .sink { outputs.append($0.state.value) }
       .store(in: &self.cancellables)