averello/swift-composable-architecture-mirror
1
0
Fork 0
mirror of https://github.com/pointfreeco/swift-composable-architecture.git synced 2025-12-24 12:14:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update docs/examples to leverage TestStore.send(\.path) (#2868)

Browse Source
This commit is contained in:
Stephen Celis
2024-02-28 17:57:35 -08:00
committed by GitHub
parent b070b765e1
commit 59f5eec0ff
53 changed files with 316 additions and 191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
Sources/ComposableArchitecture/TestStore.swift
View File

@@ -305,7 +305,8 @@ import XCTestDynamicOverlay
/// }
///
/// // 1️⃣ Emulate user tapping on submit button.
/// await store.send(.login(.submitButtonTapped)) {
/// // (You can use case key path syntax to send actions to deeply nested features.)
/// await store.send(\.login.submitButtonTapped) {
/// // 2️⃣ Assert how all state changes in the login feature
/// $0.login?.isLoading = true
/// …
@@ -353,7 +354,7 @@ import XCTestDynamicOverlay
/// }
/// store.exhaustivity = .off // ⬅️
///
/// await store.send(.login(.submitButtonTapped))
/// await store.send(\.login.submitButtonTapped)
/// await store.receive(\.login.delegate.didLogin) {
/// $0.selectedTab = .activity
/// }
@@ -375,7 +376,7 @@ import XCTestDynamicOverlay
/// }
/// store.exhaustivity = .off(showSkippedAssertions: true) // ⬅️
///
/// await store.send(.login(.submitButtonTapped))
/// await store.send(\.login.submitButtonTapped)
/// await store.receive(\.login.delegate.didLogin) {
/// $0.selectedTab = .profile
/// }
@@ -939,7 +940,7 @@ extension TestStore where State: Equatable {
///
/// ```swift
/// store.exhaustivity = .off
/// await store.send(.child(.closeButtonTapped))
/// await store.send(\.child.closeButtonTapped)
/// await store.finish()
/// await store.skipReceivedActions()
/// store.assert {
@@ -1937,23 +1938,22 @@ extension TestStore where State: Equatable {
extension TestStore where State: Equatable {
/// Sends an action to the store and asserts when state changes.
///
/// This method is similar to ``send(_:assert:file:line:)-2co21``, except it allows
/// you to specify a `CaseKeyPath` of an action with no associated value to be sent to the store.
///
/// It can be useful when sending nested action. For example::
/// This method is similar to ``send(_:assert:file:line:)-2co21``, except it allows you to specify
/// a case key path to an action, which can be useful when testing the integration of features and
/// sending deeply nested actions. For example:
///
/// ```swift
/// await store.send(.view(.tap))
/// await store.send(.destination(.presented(.child(.tap))))
/// ```
///
/// Can be simplified to:
///
/// ```swift
/// await store.send(\.view.tap)
/// await store.send(\.destination.child.tap)
/// ```
///
/// - Parameters:
/// - action: A `CaseKeyPath` to an action.
/// - action: A case key path to an action.
/// - updateStateToExpectedResult: A closure that asserts state changed by sending the action to
/// the store. The mutable state sent to this closure must be modified to match the state of
/// the store after processing the given action. Do not provide a closure if no change is
@@ -1980,18 +1980,18 @@ extension TestStore where State: Equatable {
/// It can be useful when sending nested action. For example::
///
/// ```swift
/// await store.send(.view(.delete([19, 23]))
/// await store.send(.destination(.presented(.child(.emailChanged("blob@pointfree.co")))))
/// ```
///
/// Can be simplified to:
///
/// ```swift
/// await store.send(\.view.delete, [19, 23])
/// await store.send(\.destination.child.emailChanged, "blob@pointfree.co")
/// ```
///
/// - Parameters:
/// - action: A `CaseKeyPath` to an action with an associated value.
/// - value: A value for the associated value specified in `action`.
/// - action: A case key path to an action.
/// - value: A value to embed in `action`.
/// - updateStateToExpectedResult: A closure that asserts state changed by sending the action to
/// the store. The mutable state sent to this closure must be modified to match the state of
/// the store after processing the given action. Do not provide a closure if no change is