Merge pull request #19 from maximkrouk/storeproducer-api

mluisbrown · web-flow · commit 7ac26c37ebf7 · 2020-08-12T21:08:17.000+01:00
StoreProducer API
diff --git a/Examples/CaseStudies/UIKitCaseStudies/CounterViewController.swift b/Examples/CaseStudies/UIKitCaseStudies/CounterViewController.swift
@@ -66,7 +66,7 @@ final class CounterViewController: UIViewController {
       rootStackView.centerYAnchor.constraint(equalTo: self.view.safeAreaLayoutGuide.centerYAnchor),
     ])
 
-    self.viewStore.producer.count
+    self.viewStore.produced.count
       .map(String.init)
       .assign(to: \.text, on: countLabel)
   }
diff --git a/Examples/CaseStudies/UIKitCaseStudies/ListsOfState.swift b/Examples/CaseStudies/UIKitCaseStudies/ListsOfState.swift
@@ -47,7 +47,7 @@ final class CountersTableViewController: UITableViewController {
 
     self.tableView.register(UITableViewCell.self, forCellReuseIdentifier: cellIdentifier)
 
-    self.viewStore.producer.counters
+    self.viewStore.produced.counters
       .startWithValues({ [weak self] in self?.dataSource = $0 })
   }
 
diff --git a/Examples/CaseStudies/UIKitCaseStudies/LoadThenNavigate.swift b/Examples/CaseStudies/UIKitCaseStudies/LoadThenNavigate.swift
@@ -88,7 +88,7 @@ class LazyNavigationViewController: UIViewController {
       rootStackView.centerYAnchor.constraint(equalTo: self.view.safeAreaLayoutGuide.centerYAnchor),
     ])
 
-    self.viewStore.producer.isActivityIndicatorHidden
+    self.viewStore.produced.isActivityIndicatorHidden
       .assign(to: \.isHidden, on: activityIndicator)
 
     self.store
diff --git a/Examples/CaseStudies/UIKitCaseStudies/NavigateAndLoad.swift b/Examples/CaseStudies/UIKitCaseStudies/NavigateAndLoad.swift
@@ -80,7 +80,7 @@ class EagerNavigationViewController: UIViewController {
       button.centerYAnchor.constraint(equalTo: self.view.safeAreaLayoutGuide.centerYAnchor),
     ])
 
-    self.viewStore.producer.isNavigationActive.startWithValues { [weak self] isNavigationActive in
+    self.viewStore.produced.isNavigationActive.startWithValues { [weak self] isNavigationActive in
       guard let self = self else { return }
       if isNavigationActive {
         self.navigationController?.pushViewController(
diff --git a/Examples/TicTacToe/Sources/Views-UIKit/GameViewController.swift b/Examples/TicTacToe/Sources/Views-UIKit/GameViewController.swift
@@ -116,13 +116,13 @@ public final class GameViewController: UIViewController {
         ])
       }
 
-    self.viewStore.producer.title
+    self.viewStore.produced.title
       .assign(to: \.text, on: titleLabel)
 
-    self.viewStore.producer.isPlayAgainButtonHidden
+    self.viewStore.produced.isPlayAgainButtonHidden
       .assign(to: \.isHidden, on: playAgainButton)
 
-    self.viewStore.producer.producer.map { ($0.board, $0.isGameEnabled) }
+    self.viewStore.produced.producer.map { ($0.board, $0.isGameEnabled) }
       .skipRepeats(==)
       .startWithValues { board, isGameEnabled in
         board.enumerated().forEach { rowIdx, row in
diff --git a/Examples/TicTacToe/Sources/Views-UIKit/LoginViewController.swift b/Examples/TicTacToe/Sources/Views-UIKit/LoginViewController.swift
@@ -105,25 +105,25 @@ class LoginViewController: UIViewController {
       divider.heightAnchor.constraint(equalToConstant: 1),
     ])
 
-    self.viewStore.producer.isLoginButtonEnabled
+    self.viewStore.produced.isLoginButtonEnabled
       .assign(to: \.isEnabled, on: loginButton)
 
-    self.viewStore.producer.email
+    self.viewStore.produced.email
       .assign(to: \.text, on: emailTextField)
 
-    self.viewStore.producer.isEmailTextFieldEnabled
+    self.viewStore.produced.isEmailTextFieldEnabled
       .assign(to: \.isEnabled, on: emailTextField)
 
-    self.viewStore.producer.password
+    self.viewStore.produced.password
       .assign(to: \.text, on: passwordTextField)
 
-    self.viewStore.producer.isPasswordTextFieldEnabled
+    self.viewStore.produced.isPasswordTextFieldEnabled
       .assign(to: \.isEnabled, on: passwordTextField)
 
-    self.viewStore.producer.isActivityIndicatorHidden
+    self.viewStore.produced.isActivityIndicatorHidden
       .assign(to: \.isHidden, on: activityIndicator)
 
-    self.viewStore.producer.alert
+    self.viewStore.produced.alert
       .startWithValues { [weak self] alert in
         guard let self = self else { return }
         guard let alert = alert else { return }
diff --git a/Examples/TicTacToe/Sources/Views-UIKit/NewGameViewController.swift b/Examples/TicTacToe/Sources/Views-UIKit/NewGameViewController.swift
@@ -101,13 +101,13 @@ class NewGameViewController: UIViewController {
       rootStackView.centerYAnchor.constraint(equalTo: self.view.centerYAnchor),
     ])
 
-    self.viewStore.producer.isLetsPlayButtonEnabled
+    self.viewStore.produced.isLetsPlayButtonEnabled
       .assign(to: \.isEnabled, on: letsPlayButton)
 
-    self.viewStore.producer.oPlayerName
+    self.viewStore.produced.oPlayerName
       .assign(to: \.text, on: playerOTextField)
 
-    self.viewStore.producer.xPlayerName
+    self.viewStore.produced.xPlayerName
       .assign(to: \.text, on: playerXTextField)
 
     self.store
diff --git a/Examples/TicTacToe/Sources/Views-UIKit/TwoFactorViewController.swift b/Examples/TicTacToe/Sources/Views-UIKit/TwoFactorViewController.swift
@@ -73,16 +73,16 @@ public final class TwoFactorViewController: UIViewController {
       rootStackView.centerYAnchor.constraint(equalTo: self.view.centerYAnchor),
     ])
 
-    self.viewStore.producer.isActivityIndicatorHidden
+    self.viewStore.produced.isActivityIndicatorHidden
       .assign(to: \.isHidden, on: activityIndicator)
 
-    self.viewStore.producer.code
+    self.viewStore.produced.code
       .assign(to: \.text, on: codeTextField)
 
-    self.viewStore.producer.isLoginButtonEnabled
+    self.viewStore.produced.isLoginButtonEnabled
       .assign(to: \.isEnabled, on: loginButton)
 
-    self.viewStore.producer.alert
+    self.viewStore.produced.alert
       .startWithValues { [weak self] alert in
         guard let self = self else { return }
         guard let alert = alert else { return }
diff --git a/README.md b/README.md
@@ -226,11 +226,11 @@ It is also straightforward to have a UIKit controller driven off of this store.
 
       // Omitted: Add subviews and set up constraints...
 
-      self.viewStore.producer
+      self.viewStore.produced
         .map(String.init)
         .assign(to: \.text, on: countLabel)
 
-      self.viewStore.producer.numberFactAlert
+      self.viewStore.produced.numberFactAlert
         .startWithValues { [weak self] numberFactAlert in
           let alertController = UIAlertController(
             title: numberFactAlert, message: nil, preferredStyle: .alert
diff --git a/Sources/ComposableArchitecture/Debugging/ReducerInstrumentation.swift b/Sources/ComposableArchitecture/Debugging/ReducerInstrumentation.swift
@@ -1,4 +1,3 @@
-import ReactiveSwift
 import os.signpost
 
 extension Reducer {
diff --git a/Sources/ComposableArchitecture/Store.swift b/Sources/ComposableArchitecture/Store.swift
@@ -195,18 +195,22 @@ public final class Store<State, Action> {
 
 /// A producer of store state.
 @dynamicMemberLookup
-public struct StoreProducer<State>: SignalProducerConvertible {
-  public let producer: Effect<State, Never>
+public struct Produced<Value>: SignalProducerConvertible {
+  public let producer: Effect<Value, Never>
 
-  init(_ upstream: Effect<State, Never>) {
+  init(by upstream: Effect<Value, Never>) {
     self.producer = upstream
   }
 
   /// Returns the resulting producer of a given key path.
-  public subscript<LocalState>(
-    dynamicMember keyPath: KeyPath<State, LocalState>
-  ) -> Effect<LocalState, Never>
-  where LocalState: Equatable {
+  public subscript<LocalValue>(
+    dynamicMember keyPath: KeyPath<Value, LocalValue>
+  ) -> Effect<LocalValue, Never> where LocalValue: Equatable {
     self.producer.map(keyPath).skipRepeats()
   }
 }
+
+@available(*, deprecated, message:"""
+Consider using `Produced<State>` instead, this typealias is added for backward compatibility and will be removed in the next major release.
+""")
+public typealias StoreProducer<State> = Produced<State>
diff --git a/Sources/ComposableArchitecture/ViewStore.swift b/Sources/ComposableArchitecture/ViewStore.swift
@@ -33,7 +33,7 @@ import SwiftUI
 ///     func viewDidLoad() {
 ///       super.viewDidLoad()
 ///
-///       self.viewStore.producer.count
+///       self.viewStore.produced.count
 ///         .startWithValues { [weak self] in self?.countLabel.text = $0 }
 ///     }
 ///
@@ -44,7 +44,12 @@ import SwiftUI
 @dynamicMemberLookup
 public final class ViewStore<State, Action>: ObservableObject {
   /// A producer of state.
-  public let producer: StoreProducer<State>
+  public let produced: Produced<State>
+    
+  @available(*, deprecated, message: """
+  Consider using `.produced` instead, this variable is added for backward compatibility and will be removed in the next major release.
+  """)
+  public var producer: StoreProducer<State> { produced }
 
   /// Initializes a view store from a store.
   ///
@@ -57,7 +62,7 @@ public final class ViewStore<State, Action>: ObservableObject {
     removeDuplicates isDuplicate: @escaping (State, State) -> Bool
   ) {
     let producer = store.$state.producer.skipRepeats(isDuplicate)
-    self.producer = StoreProducer(producer)
+    self.produced = Produced(by: producer)
     self.state = store.state
     self._send = store.send
     producer.startWithValues { [weak self] in
diff --git a/Tests/ComposableArchitectureTests/MemoryManagementTests.swift b/Tests/ComposableArchitectureTests/MemoryManagementTests.swift
@@ -14,7 +14,7 @@ final class MemoryManagementTests: XCTestCase {
     let viewStore = ViewStore(store)
 
     var count = 0
-    viewStore.producer.producer.startWithValues { count = $0 }
+    viewStore.produced.producer.startWithValues { count = $0 }
 
     XCTAssertEqual(count, 0)
     viewStore.send(())
@@ -29,7 +29,7 @@ final class MemoryManagementTests: XCTestCase {
     let viewStore = ViewStore(Store(initialState: 0, reducer: counterReducer, environment: ()))
 
     var count = 0
-    viewStore.producer.producer.startWithValues { count = $0 }
+    viewStore.produced.producer.startWithValues { count = $0 }
 
     XCTAssertEqual(count, 0)
     viewStore.send(())
diff --git a/Tests/ComposableArchitectureTests/StoreTests.swift b/Tests/ComposableArchitectureTests/StoreTests.swift
@@ -284,7 +284,7 @@ final class StoreTests: XCTestCase {
       let vs = ViewStore(childStore)
 
       vs
-        .producer.producer
+        .produced.producer
         .startWithValues { _ in }
 
       vs.send(false)

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ final class CounterViewController: UIViewController {`
`66`	`66`	`rootStackView.centerYAnchor.constraint(equalTo: self.view.safeAreaLayoutGuide.centerYAnchor),`
`67`	`67`	`])`
`68`	`68`
`69`		`- self.viewStore.producer.count`
	`69`	`+ self.viewStore.produced.count`
`70`	`70`	`.map(String.init)`
`71`	`71`	`.assign(to: \.text, on: countLabel)`
`72`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ final class CountersTableViewController: UITableViewController {`
`47`	`47`
`48`	`48`	`self.tableView.register(UITableViewCell.self, forCellReuseIdentifier: cellIdentifier)`
`49`	`49`
`50`		`- self.viewStore.producer.counters`
	`50`	`+ self.viewStore.produced.counters`
`51`	`51`	`.startWithValues({ [weak self] in self?.dataSource = $0 })`
`52`	`52`	`}`
`53`	`53`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-import ReactiveSwift`
`2`	`1`	`import os.signpost`
`3`	`2`
`4`	`3`	`extension Reducer {`