Merge pull request #20 from trading-point/michael/sync-upstream

Sync changes with the Point-Free TCA repo

Author: mluisbrown

Examples/CaseStudies/SwiftUICaseStudies/01-GettingStarted-AlertsAndActionSheets.swift

@@ -15,7 +15,7 @@ private let readMe = """
   closures.
 
   The benefit of doing this is that you can get full test coverage on how a user interacts with \
-  with alerts and action sheets in your application
+  alerts and action sheets in your application
   """
 
 struct AlertAndSheetState: Equatable {
@@ -27,8 +27,10 @@ struct AlertAndSheetState: Equatable {
 enum AlertAndSheetAction: Equatable {
   case actionSheetButtonTapped
   case actionSheetCancelTapped
+  case actionSheetDismissed
   case alertButtonTapped
   case alertCancelTapped
+  case alertDismissed
   case decrementButtonTapped
   case incrementButtonTapped
 }
@@ -53,6 +55,9 @@ let alertAndSheetReducer = Reducer<
     return .none
 
   case .actionSheetCancelTapped:
+    return .none
+
+  case .actionSheetDismissed:
     state.actionSheet = nil
     return .none
 
@@ -66,21 +71,24 @@ let alertAndSheetReducer = Reducer<
     return .none
 
   case .alertCancelTapped:
+    return .none
+
+  case .alertDismissed:
     state.alert = nil
     return .none
 
   case .decrementButtonTapped:
-    state.actionSheet = nil
+    state.alert = .init(title: "Decremented!")
     state.count -= 1
     return .none
 
   case .incrementButtonTapped:
-    state.actionSheet = nil
-    state.alert = nil
+    state.alert = .init(title: "Incremented!")
     state.count += 1
     return .none
   }
 }
+.debug()
 
 struct AlertAndSheetView: View {
   let store: Store<AlertAndSheetState, AlertAndSheetAction>
@@ -94,13 +102,13 @@ struct AlertAndSheetView: View {
           Button("Alert") { viewStore.send(.alertButtonTapped) }
             .alert(
               self.store.scope(state: { $0.alert }),
-              dismiss: .alertCancelTapped
+              dismiss: .alertDismissed
             )
 
           Button("Action sheet") { viewStore.send(.actionSheetButtonTapped) }
             .actionSheet(
               self.store.scope(state: { $0.actionSheet }),
-              dismiss: .actionSheetCancelTapped
+              dismiss: .actionSheetDismissed
             )
         }
       }

Examples/CaseStudies/SwiftUICaseStudies/01-GettingStarted-SharedState.swift

@@ -221,8 +221,8 @@ struct SharedStateProfileView: View {
             This tab shows state from the previous tab, and it is capable of reseting all of the \
             state back to 0.
 
-            This shows that it is possible to for each screen to model its state in the way that \
-            makes the most sense for it, while still allowing the state and mutations to be shared \
+            This shows that it is possible for each screen to model its state in the way that makes \
+            the most sense for it, while still allowing the state and mutations to be shared \
             across independent screens.
             """,
           .caption

Examples/CaseStudies/SwiftUICaseStudiesTests/01-GettingStarted-AlertsAndActionSheetsTests.swift

@@ -23,8 +23,11 @@ class AlertsAndActionSheetsTests: XCTestCase {
         )
       },
       .send(.incrementButtonTapped) {
-        $0.alert = nil
+        $0.alert = .init(title: "Incremented!")
         $0.count = 1
+      },
+      .send(.alertDismissed) {
+        $0.alert = nil
       }
     )
   }
@@ -49,8 +52,11 @@ class AlertsAndActionSheetsTests: XCTestCase {
         )
       },
       .send(.incrementButtonTapped) {
-        $0.actionSheet = nil
+        $0.alert = .init(title: "Incremented!")
         $0.count = 1
+      },
+      .send(.actionSheetDismissed) {
+        $0.actionSheet = nil
       }
     )
   }

README.md

@@ -18,7 +18,7 @@ Using ReactiveSwift, which doesn't use Combine's type model, `Effect<Output, Fai
 
 # The Composable Architecture
 
-The Composable Architecture is a library for building applications in a consistent and understandable way, with composition, testing, and ergonomics in mind. It can be used in SwiftUI, UIKit, and more, and on any Apple platform (iOS, macOS, tvOS, and watchOS).
+The Composable Architecture (TCA, for short) is a library for building applications in a consistent and understandable way, with composition, testing, and ergonomics in mind. It can be used in SwiftUI, UIKit, and more, and on any Apple platform (iOS, macOS, tvOS, and watchOS).
 
 * [What is the Composable Architecture?](#what-is-the-composable-architecture)
 * [Learn more](#learn-more)
@@ -28,6 +28,7 @@ The Composable Architecture is a library for building applications in a consiste
 * [FAQ](#faq)
 * [Requirements](#requirements)
 * [Installation](#installation)
+* [Documentation](#documentation)
 * [Help](#help)
 * [Credits and thanks](#credits-and-thanks)
 * [Other libraries](#other-libraries)
@@ -154,7 +155,7 @@ let appReducer = Reducer<AppState, AppAction, AppEnvironment> { state, action, e
     state.numberFactAlert = fact
     return .none
 
-  case let .numberFactResponse(.failure):
+  case .numberFactResponse(.failure):
     state.numberFactAlert = "Could not load a number fact :("
     return .none
   }
@@ -377,7 +378,7 @@ If you are interested in contributing a wrapper library for a framework that we
 * How does the Composable Architecture compare to Elm, Redux, and others?
   <details>
     <summary>Expand to see answer</summary>
-    The Composable Architecture (TCA) is built on a foundation of ideas popularized by Elm and Redux, but made to feel at home in the Swift language and on Apple's platforms.
+    The Composable Architecture (TCA) is built on a foundation of ideas popularized by the Elm Architecture (TEA) and Redux, but made to feel at home in the Swift language and on Apple's platforms.
 
     In some ways TCA is a little more opinionated than the other libraries. For example, Redux is not prescriptive with how one executes side effects, but TCA requires all side effects to be modeled in the `Effect` type and returned from the reducer.
 
@@ -430,6 +431,10 @@ You can add ComposableArchitecture to an Xcode project by adding it as a package
       - If you have a single application target that needs access to the library, then add **ComposableArchitecture** directly to your application.
       - If you want to use this library from multiple targets you must create a shared framework that depends on **ComposableArchitecture** and then depend on that framework in all of your targets. For an example of this, check out the [Tic-Tac-Toe](./Examples/TicTacToe) demo application, which splits lots of features into modules and consumes the static library in this fashion using the **TicTacToeCommon** framework.
 
+## Documentation
+
+The latest documentation for the Composable Architecture APIs is available [here](https://trading-point.github.io/reactiveswift-composable-architecture/).
+
 ## Help
 
 If you want to discuss the Composable Architecture or have a question about how to use it to solve a particular problem, ask around on [its Swift forum](https://forums.swift.org/c/related-projects/swift-composable-architecture).

Sources/ComposableArchitecture/SwiftUI/ActionSheet.swift

@@ -105,6 +105,7 @@ import SwiftUI
 @available(tvOS 13, *)
 @available(watchOS 6, *)
 public struct ActionSheetState<Action> {
+  public let id = UUID()
   public var buttons: [Button]
   public var message: String?
   public var title: String
@@ -127,24 +128,50 @@ public struct ActionSheetState<Action> {
 @available(macOS 10.15, *)
 @available(tvOS 13, *)
 @available(watchOS 6, *)
-extension ActionSheetState: Equatable where Action: Equatable {}
+extension ActionSheetState: CustomDebugOutputConvertible {
+  public var debugOutput: String {
+    let fields = (
+      title: self.title,
+      message: self.message,
+      buttons: self.buttons
+    )
+    return "\(Self.self)\(ComposableArchitecture.debugOutput(fields))"
+  }
+}
 
 @available(iOS 13, *)
 @available(macCatalyst 13, *)
 @available(macOS 10.15, *)
 @available(tvOS 13, *)
 @available(watchOS 6, *)
-extension ActionSheetState: Hashable where Action: Hashable {}
+extension ActionSheetState: Equatable where Action: Equatable {
+  public static func == (lhs: Self, rhs: Self) -> Bool {
+    lhs.title == rhs.title
+      && lhs.message == rhs.message
+      && lhs.buttons == rhs.buttons
+  }
+}
 
 @available(iOS 13, *)
 @available(macCatalyst 13, *)
 @available(macOS 10.15, *)
 @available(tvOS 13, *)
 @available(watchOS 6, *)
-extension ActionSheetState: Identifiable where Action: Hashable {
-  public var id: Self { self }
+extension ActionSheetState: Hashable where Action: Hashable {
+  public func hash(into hasher: inout Hasher) {
+    hasher.combine(self.title)
+    hasher.combine(self.message)
+    hasher.combine(self.buttons)
+  }
 }
 
+@available(iOS 13, *)
+@available(macCatalyst 13, *)
+@available(macOS 10.15, *)
+@available(tvOS 13, *)
+@available(watchOS 6, *)
+extension ActionSheetState: Identifiable {}
+
 @available(iOS 13, *)
 @available(macCatalyst 13, *)
 @available(macOS 10.15, *)
@@ -157,7 +184,8 @@ extension View {
   /// - Parameters:
   ///   - store: A store that describes if the action sheet is shown or dismissed.
   ///   - dismissal: An action to send when the action sheet is dismissed through non-user actions,
-  ///     such as when an action sheet is automatically dismissed by the system.
+  ///     such as when an action sheet is automatically dismissed by the system. Use this action to
+  ///     `nil` out the associated action sheet state.
   @available(iOS 13, *)
   @available(macCatalyst 13, *)
   @available(macOS, unavailable)
@@ -168,16 +196,11 @@ extension View {
     dismiss: Action
   ) -> some View {
 
-    let viewStore = ViewStore(store, removeDuplicates: { ($0 == nil) != ($1 == nil) })
-    return self.actionSheet(
-      isPresented: Binding(
-        get: { viewStore.state != nil },
-        set: {
-          guard !$0 else { return }
-          viewStore.send(dismiss)
-        }),
-      content: { viewStore.state?.toSwiftUI(send: viewStore.send) ?? ActionSheet(title: Text("")) }
-    )
+    WithViewStore(store, removeDuplicates: { $0?.id == $1?.id }) { viewStore in
+      self.actionSheet(item: viewStore.binding(send: dismiss)) { state in
+        state.toSwiftUI(send: viewStore.send)
+      }
+    }
   }
 }
 

Sources/ComposableArchitecture/SwiftUI/Alert.swift

@@ -91,6 +91,7 @@ import SwiftUI
 ///     )
 ///
 public struct AlertState<Action> {
+  public let id = UUID()
   public var message: String?
   public var primaryButton: Button?
   public var secondaryButton: Button?
@@ -169,34 +170,54 @@ extension View {
   /// - Parameters:
   ///   - store: A store that describes if the alert is shown or dismissed.
   ///   - dismissal: An action to send when the alert is dismissed through non-user actions, such
-  ///     as when an alert is automatically dismissed by the system.
+  ///     as when an alert is automatically dismissed by the system. Use this action to `nil` out
+  ///     the associated alert state.
   public func alert<Action>(
     _ store: Store<AlertState<Action>?, Action>,
     dismiss: Action
   ) -> some View {
 
-    let viewStore = ViewStore(store, removeDuplicates: { ($0 == nil) != ($1 == nil) })
-    return self.alert(
-      isPresented: Binding(
-        get: { viewStore.state != nil },
-        set: {
-          guard !$0 else { return }
-          viewStore.send(dismiss)
-        }),
-      content: { viewStore.state?.toSwiftUI(send: viewStore.send) ?? Alert(title: Text("")) }
+    WithViewStore(store, removeDuplicates: { $0?.id == $1?.id }) { viewStore in
+      self.alert(item: viewStore.binding(send: dismiss)) { state in
+        state.toSwiftUI(send: viewStore.send)
+      }
+    }
+  }
+}
+
+extension AlertState: CustomDebugOutputConvertible {
+  public var debugOutput: String {
+    let fields = (
+      title: self.title,
+      message: self.message,
+      primaryButton: self.primaryButton,
+      secondaryButton: self.secondaryButton
     )
+    return "\(Self.self)\(ComposableArchitecture.debugOutput(fields))"
   }
 }
 
-extension AlertState: Equatable where Action: Equatable {}
-extension AlertState: Hashable where Action: Hashable {}
+extension AlertState: Equatable where Action: Equatable {
+  public static func == (lhs: Self, rhs: Self) -> Bool {
+    lhs.title == rhs.title
+      && lhs.message == rhs.message
+      && lhs.primaryButton == rhs.primaryButton
+      && lhs.secondaryButton == rhs.secondaryButton
+  }
+}
+extension AlertState: Hashable where Action: Hashable {
+  public func hash(into hasher: inout Hasher) {
+    hasher.combine(self.title)
+    hasher.combine(self.message)
+    hasher.combine(self.primaryButton)
+    hasher.combine(self.secondaryButton)
+  }
+}
+extension AlertState: Identifiable {}
+
 extension AlertState.Button: Equatable where Action: Equatable {}
 extension AlertState.Button: Hashable where Action: Hashable {}
 
-extension AlertState: Identifiable where Action: Hashable {
-  public var id: Self { self }
-}
-
 extension AlertState.Button {
   @available(iOS 13, *)
   @available(macCatalyst 13, *)