wip

Author: stephencelis

Examples/CaseStudies/SwiftUICaseStudies/04-HigherOrderReducers-Lifecycle.swift

@@ -66,7 +66,6 @@ struct LifecycleDemo: ReducerProtocol {
   private enum CancelID {}
 
   var body: some ReducerProtocol<State, Action> {
-    // TODO: timerReducer
     Reduce { state, action in
       switch action {
       case .timer:

Sources/ComposableArchitecture/Documentation.docc/Articles/Dependencies.md

@@ -205,6 +205,15 @@ that triggers an `XCTFail` anytime one of its endpoints is invoked. This makes i
 stub the bare minimum of the dependency's interface, allowing you to prove that your test flow
 doesn't interact with any other endpoints.
 
+> Tip: To use a different, default version when your feature is run in an Xcode preview, use the
+> optional `previewValue` requirement.
+>
+> ```swift
+> extension APIClientKey {
+>   static let previewValue = APIClient.mock(.loggedIn)
+> }
+> ```
+
 Next you extend the key to also conform to the [`DependencyKey`][dependency-key-docs] protocol,
 which will be the version of the dependency used when your feature is run in an Xcode preview, in
 the simulator, or on a device:
@@ -215,8 +224,6 @@ extension APIClientKey: DependencyKey {
 }
 ```
 
-<!-- TODO: Document `previewValue` -->
-
 This is the version of the dependency that can actually interact with outside systems. In this
 case it means the API client can actually make network requests to an external server.
 

Sources/ComposableArchitecture/Documentation.docc/Extensions/Deprecations/EffectDeprecations.md

@@ -47,4 +47,4 @@ Avoid using deprecated APIs in your app. Select a method to see the replacement
 - ``Effect/timer(id:every:tolerance:on:options:)-4exe6``
 - ``Effect/timer(id:every:tolerance:on:options:)-7po0d``
 - ``Effect/Subscriber``
-<!--TODO: Can't currently document `Publisher` extensions. -->
+<!--DocC: Can't currently document `Publisher` extensions. -->

Sources/ComposableArchitecture/Documentation.docc/Extensions/Deprecations/SwiftUIDeprecations.md

@@ -8,7 +8,12 @@ Avoid using deprecated APIs in your app. Select a method to see the replacement
 
 ## Topics
 
-### `WithViewStore`
+### ForEachStore
+
+- ``ForEachStore/init(_:content:)-34mtj``
+- ``ForEachStore/init(_:id:content:)``
+
+### WithViewStore
 
 - ``WithViewStore/init(_:content:file:line:)-1gjbi``
 - ``WithViewStore/init(_:content:file:line:)-2uj44``
@@ -28,9 +33,9 @@ Avoid using deprecated APIs in your app. Select a method to see the replacement
 - ``WithViewStore/Action``
 - ``WithViewStore/State``
 
-### View State
+### View state
 
 - ``ActionSheetState``
 
-<!--TODO: Can't currently document `View` extensions-->
+<!--DocC: Can't currently document `View` extensions-->
 <!--### View Modifiers-->

Sources/ComposableArchitecture/Documentation.docc/Extensions/Store.md

@@ -10,8 +10,6 @@
 ### Scoping stores
 
 - ``scope(state:action:)``
-- ``stateless``
-- ``actionless``
 
 ### Combine integration
 

Sources/ComposableArchitecture/Documentation.docc/Extensions/StoreScope.md

@@ -5,3 +5,5 @@
 ### Overloads
 
 - ``scope(state:)``
+- ``stateless``
+- ``actionless``

Sources/ComposableArchitecture/Documentation.docc/Extensions/SwiftUI.md

@@ -31,7 +31,7 @@ The Composable Architecture can be used to power applications built in many fram
 - ``ConfirmationDialogState``
 - ``TextState``
 
-<!--TODO: Can't currently document `View` extensions-->
+<!--DocC: Can't currently document `View` extensions-->
 <!--### View Modifiers-->
 
 ### Deprecations

Sources/ComposableArchitecture/Documentation.docc/Extensions/WithViewStore.md

@@ -0,0 +1,13 @@
+# ``ComposableArchitecture/WithViewStore``
+
+## Overview
+
+## Topics
+
+### Creating a view
+
+- ``init(_:observe:content:file:line:)``
+
+### Debugging view updates
+
+- ``debug(_:)``

Sources/ComposableArchitecture/Documentation.docc/Extensions/WithViewStoreInit.md

@@ -0,0 +1,9 @@
+# ``ComposableArchitecture/WithViewStore/init(_:observe:content:file:line:)``
+
+## Topics
+
+### Overloads
+
+- ``WithViewStore/init(_:observe:removeDuplicates:content:file:line:)``
+- ``WithViewStore/init(_:observe:send:content:file:line:)``
+- ``WithViewStore/init(_:observe:send:removeDuplicates:content:file:line:)``

Sources/ComposableArchitecture/Effects/ConcurrencySupport.swift

@@ -294,8 +294,12 @@ extension Task where Success == Never, Failure == Never {
 /// ```
 @dynamicMemberLookup
 public final actor ActorIsolated<Value: Sendable> {
+  /// The actor-isolated value.
   public var value: Value
 
+  /// Initializes actor-isolated state around a value.
+  ///
+  /// - Parameter value: A value to isolate in an actor.
   public init(_ value: Value) {
     self.value = value
   }
@@ -306,6 +310,17 @@ public final actor ActorIsolated<Value: Sendable> {
 
   /// Perform an operation with isolated access to the underlying value.
   ///
+  /// Useful for inspecting an actor-isolated value for a test assertion:
+  ///
+  /// ```swift
+  /// let didOpenSettings = ActorIsolated(false)
+  /// store.dependencies.openSettings = { await didOpenSettings.setValue(true) }
+  ///
+  /// await store.send(.settingsButtonTapped)
+  ///
+  /// await didOpenSettings.withValue { XCTAssertTrue($0) }
+  /// ```
+  ///
   /// - Parameters: operation: An operation to be performed on the actor with the underlying value.
   /// - Returns: The result of the operation.
   public func withValue<T: Sendable>(
@@ -318,6 +333,17 @@ public final actor ActorIsolated<Value: Sendable> {
 
   /// Overwrite the isolated value with a new value.
   ///
+  /// Useful for setting an actor-isolated value when a tested dependency runs.
+  ///
+  /// ```swift
+  /// let didOpenSettings = ActorIsolated(false)
+  /// store.dependencies.openSettings = { await didOpenSettings.setValue(true) }
+  ///
+  /// await store.send(.settingsButtonTapped)
+  ///
+  /// await didOpenSettings.withValue { XCTAssertTrue($0) }
+  /// ```
+  ///
   /// - Parameter newValue: The value to replace the current isolated value with.
   public func setValue(_ newValue: Value) {
     self.value = newValue
@@ -338,6 +364,7 @@ public final actor ActorIsolated<Value: Sendable> {
 @dynamicMemberLookup
 @propertyWrapper
 public struct UncheckedSendable<Value>: @unchecked Sendable {
+  /// The unchecked value.
   public var value: Value
 
   public init(_ value: Value) {

Sources/ComposableArchitecture/Store.swift

@@ -432,7 +432,6 @@ public final class Store<State, Action> {
     self.scope(state: { _ in () })
   }
 
-  // TODO: move docs for this into overloads of scope
   /// Returns an "actionless" store by erasing action to `Never`.
   public var actionless: Store<State, Never> {
     func absurd<A>(_ never: Never) -> A {}

Sources/ComposableArchitecture/SwiftUI/WithViewStore.swift

@@ -611,8 +611,6 @@ extension WithViewStore where ViewState: Equatable, Content: View {
 }
 
 extension WithViewStore where ViewState == Void, Content: View {
-  // TODO: move docs for this init under overloads for WithViewStore
-
   /// Initializes a structure that transforms a store into an observable view store in order to
   /// compute views from void store state.
   ///

Tests/ComposableArchitectureTests/DebugTests.swift

@@ -206,16 +206,13 @@ final class DebugTests: XCTestCase {
     struct DebuggedReducer: ReducerProtocol {
       typealias State = Int
       typealias Action = Bool
-      var body: some ReducerProtocol<State, Action> {
-        Reduce { state, action in
-          state += action ? 1 : -1
-          return .none
-        }
-        .debug()
+      func reduce(into state: inout Int, action: Bool) -> Effect<Bool, Never> {
+        state += action ? 1 : -1
+        return .none
       }
     }
 
-    let store = TestStore(initialState: 0, reducer: DebuggedReducer())
+    let store = TestStore(initialState: 0, reducer: DebuggedReducer().debug())
     await store.send(true) { $0 = 1 }
   }
 }