Added file and line to optional assert (#218)

mluisbrown · stephencelis · mluisbrown · commit 432895107076 · 2020-08-04T12:00:58.000+01:00
* Added file and line to optional assert

* Apply suggestions from code review

Co-authored-by: Stephen Celis &lt;stephen.celis@gmail.com&gt;

* Deprecate old optional property and migrated TicTacToe example

* Migrated other examples to optional() and added file/line to forEach

* Update Deprecations.swift

Co-authored-by: Stephen Celis &lt;stephen.celis@gmail.com&gt;
diff --git a/Examples/CaseStudies/SwiftUICaseStudies/01-GettingStarted-OptionalState.swift b/Examples/CaseStudies/SwiftUICaseStudies/01-GettingStarted-OptionalState.swift
@@ -23,8 +23,9 @@ enum OptionalBasicsAction: Equatable {
 
 struct OptionalBasicsEnvironment {}
 
-let optionalBasicsReducer = counterReducer
-  .optional
+let optionalBasicsReducer =
+  counterReducer
+  .optional()
   .pullback(
     state: \.optionalCounter,
     action: /OptionalBasicsAction.optionalCounter,
diff --git a/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Lists-LoadThenNavigate.swift b/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Lists-LoadThenNavigate.swift
@@ -42,7 +42,7 @@ let loadThenNavigateListReducer =
     action: .self,
     environment: { $0 }
   )
-  .optional
+  .optional()
   .pullback(
     state: \LoadThenNavigateListState.selection,
     action: /LoadThenNavigateListAction.counter,
diff --git a/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Lists-NavigateAndLoad.swift b/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Lists-NavigateAndLoad.swift
@@ -33,10 +33,11 @@ struct NavigateAndLoadListEnvironment {
   var mainQueue: DateScheduler
 }
 
-let navigateAndLoadListReducer = counterReducer
-  .optional
+let navigateAndLoadListReducer =
+  counterReducer
+  .optional()
   .pullback(state: \Identified.value, action: .self, environment: { $0 })
-  .optional
+  .optional()
   .pullback(
     state: \NavigateAndLoadListState.selection,
     action: /NavigateAndLoadListAction.counter,
diff --git a/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-LoadThenNavigate.swift b/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-LoadThenNavigate.swift
@@ -27,8 +27,9 @@ struct LoadThenNavigateEnvironment {
   var mainQueue: DateScheduler
 }
 
-let loadThenNavigateReducer = counterReducer
-  .optional
+let loadThenNavigateReducer =
+  counterReducer
+  .optional()
   .pullback(
     state: \.optionalCounter,
     action: /LoadThenNavigateAction.optionalCounter,
diff --git a/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-NavigateAndLoad.swift b/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-NavigateAndLoad.swift
@@ -26,8 +26,9 @@ struct NavigateAndLoadEnvironment {
   var mainQueue: DateScheduler
 }
 
-let navigateAndLoadReducer = counterReducer
-  .optional
+let navigateAndLoadReducer =
+  counterReducer
+  .optional()
   .pullback(
     state: \.optionalCounter,
     action: /NavigateAndLoadAction.optionalCounter,
diff --git a/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Sheet-LoadThenPresent.swift b/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Sheet-LoadThenPresent.swift
@@ -27,8 +27,9 @@ struct LoadThenPresentEnvironment {
   var mainQueue: DateScheduler
 }
 
-let loadThenPresentReducer = counterReducer
-  .optional
+let loadThenPresentReducer =
+  counterReducer
+  .optional()
   .pullback(
     state: \.optionalCounter,
     action: /LoadThenPresentAction.optionalCounter,
diff --git a/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Sheet-PresentAndLoad.swift b/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Sheet-PresentAndLoad.swift
@@ -24,8 +24,9 @@ struct PresentAndLoadEnvironment {
   var mainQueue: DateScheduler
 }
 
-let presentAndLoadReducer = counterReducer
-  .optional
+let presentAndLoadReducer =
+  counterReducer
+  .optional()
   .pullback(
     state: \.optionalCounter,
     action: /PresentAndLoadAction.optionalCounter,
diff --git a/Examples/CaseStudies/UIKitCaseStudies/LoadThenNavigate.swift b/Examples/CaseStudies/UIKitCaseStudies/LoadThenNavigate.swift
@@ -18,8 +18,9 @@ struct LazyNavigationEnvironment {
   var mainQueue: DateScheduler
 }
 
-let lazyNavigationReducer = counterReducer
-  .optional
+let lazyNavigationReducer =
+  counterReducer
+  .optional()
   .pullback(
     state: \.optionalCounter,
     action: /LazyNavigationAction.optionalCounter,
diff --git a/Examples/CaseStudies/UIKitCaseStudies/NavigateAndLoad.swift b/Examples/CaseStudies/UIKitCaseStudies/NavigateAndLoad.swift
@@ -18,8 +18,9 @@ struct EagerNavigationEnvironment {
   var mainQueue: DateScheduler
 }
 
-let eagerNavigationReducer = counterReducer
-  .optional
+let eagerNavigationReducer =
+  counterReducer
+  .optional()
   .pullback(
     state: \.optionalCounter,
     action: /EagerNavigationAction.optionalCounter,
diff --git a/Examples/TicTacToe/Sources/Core/AppCore.swift b/Examples/TicTacToe/Sources/Core/AppCore.swift
@@ -31,7 +31,7 @@ public struct AppEnvironment {
 }
 
 public let appReducer = Reducer<AppState, AppAction, AppEnvironment>.combine(
-  loginReducer.optional.pullback(
+  loginReducer.optional().pullback(
     state: \.login,
     action: /AppAction.login,
     environment: {
@@ -41,7 +41,7 @@ public let appReducer = Reducer<AppState, AppAction, AppEnvironment>.combine(
       )
     }
   ),
-  newGameReducer.optional.pullback(
+  newGameReducer.optional().pullback(
     state: \.newGame,
     action: /AppAction.newGame,
     environment: { _ in NewGameEnvironment() }
diff --git a/Examples/TicTacToe/Sources/Core/LoginCore.swift b/Examples/TicTacToe/Sources/Core/LoginCore.swift
@@ -39,8 +39,9 @@ public struct LoginEnvironment {
   }
 }
 
-public let loginReducer = twoFactorReducer
-  .optional
+public let loginReducer =
+  twoFactorReducer
+  .optional()
   .pullback(
     state: \.twoFactor,
     action: /LoginAction.twoFactor,
diff --git a/Examples/TicTacToe/Sources/Core/NewGameCore.swift b/Examples/TicTacToe/Sources/Core/NewGameCore.swift
@@ -23,8 +23,9 @@ public struct NewGameEnvironment {
   public init() {}
 }
 
-public let newGameReducer = gameReducer
-  .optional
+public let newGameReducer =
+  gameReducer
+  .optional()
   .pullback(
     state: \.game,
     action: /NewGameAction.game,
diff --git a/Sources/ComposableArchitecture/Internal/Deprecations.swift b/Sources/ComposableArchitecture/Internal/Deprecations.swift
@@ -0,0 +1,9 @@
+// NB: Deprecated after 0.6.0:
+
+extension Reducer {
+  @available(*, deprecated, renamed: "optional()")
+  public var optional: Reducer<State?, Action, Environment> {
+    self.optional()
+  }
+}
+
diff --git a/Sources/ComposableArchitecture/Reducer.swift b/Sources/ComposableArchitecture/Reducer.swift
@@ -152,7 +152,7 @@ public struct Reducer<State, Action, Environment> {
   ///
   ///     // Pullback the local modal reducer so that it works on all of the app domain:
   ///     let appReducer: Reducer<AppState, AppAction, AppEnvironment> =
-  ///       modalReducer.optional.pullback(
+  ///       modalReducer.optional().pullback(
   ///         state: \.modal,
   ///         action: /AppAction.modal,
   ///         environment: { ModalEnvironment(mainQueue: $0.mainQueue) }
@@ -162,7 +162,9 @@ public struct Reducer<State, Action, Environment> {
   ///   store on non-optional state.
   /// - See also: `Store.ifLet`, a UIKit helper for doing imperative work with a store on optional
   ///   state.
-  public var optional: Reducer<State?, Action, Environment> {
+  public func optional(_ file: StaticString = #file, _ line: UInt = #line) -> Reducer<
+    State?, Action, Environment
+  > {
     .init { state, action, environment in
       guard state != nil else {
         assertionFailure(
@@ -181,7 +183,9 @@ public struct Reducer<State, Action, Environment> {
           * This action was sent to the store while state was "nil". Make sure that actions for \
           this reducer can only be sent to a view store when state is non-"nil". In SwiftUI \
           applications, use "IfLetStore".
-          """
+          """,
+          file: file,
+          line: line
         )
         return .none
       }
@@ -217,7 +221,9 @@ public struct Reducer<State, Action, Environment> {
   public func forEach<GlobalState, GlobalAction, GlobalEnvironment>(
     state toLocalState: WritableKeyPath<GlobalState, [State]>,
     action toLocalAction: CasePath<GlobalAction, (Int, Action)>,
-    environment toLocalEnvironment: @escaping (GlobalEnvironment) -> Environment
+    environment toLocalEnvironment: @escaping (GlobalEnvironment) -> Environment,
+    _ file: StaticString = #file,
+    _ line: UInt = #line
   ) -> Reducer<GlobalState, GlobalAction, GlobalEnvironment> {
     .init { globalState, globalAction, globalEnvironment in
       guard let (index, localAction) = toLocalAction.extract(from: globalAction) else {
@@ -245,7 +251,9 @@ public struct Reducer<State, Action, Environment> {
         * This action was sent to the store while its state contained no element at this index. \
         To fix this make sure that actions for this reducer can only be sent to a view store when \
         its state contains an element at this index. In SwiftUI applications, use `ForEachStore`.
-        """
+        """,
+        file: file,
+        line: line
       )
       return self.reducer(
         &globalState[keyPath: toLocalState][index],
@@ -286,7 +294,9 @@ public struct Reducer<State, Action, Environment> {
   public func forEach<GlobalState, GlobalAction, GlobalEnvironment, ID>(
     state toLocalState: WritableKeyPath<GlobalState, IdentifiedArray<ID, State>>,
     action toLocalAction: CasePath<GlobalAction, (ID, Action)>,
-    environment toLocalEnvironment: @escaping (GlobalEnvironment) -> Environment
+    environment toLocalEnvironment: @escaping (GlobalEnvironment) -> Environment,
+    _ file: StaticString = #file,
+    _ line: UInt = #line
   ) -> Reducer<GlobalState, GlobalAction, GlobalEnvironment> {
     .init { globalState, globalAction, globalEnvironment in
       guard let (id, localAction) = toLocalAction.extract(from: globalAction) else { return .none }
@@ -313,7 +323,9 @@ public struct Reducer<State, Action, Environment> {
         * This action was sent to the store while its state contained no element at this id. \
         To fix this make sure that actions for this reducer can only be sent to a view store when \
         its state contains an element at this id. In SwiftUI applications, use `ForEachStore`.
-        """
+        """,
+        file: file,
+        line: line
       )
 
       return
@@ -339,7 +351,9 @@ public struct Reducer<State, Action, Environment> {
   public func forEach<GlobalState, GlobalAction, GlobalEnvironment, Key>(
     state toLocalState: WritableKeyPath<GlobalState, [Key: State]>,
     action toLocalAction: CasePath<GlobalAction, (Key, Action)>,
-    environment toLocalEnvironment: @escaping (GlobalEnvironment) -> Environment
+    environment toLocalEnvironment: @escaping (GlobalEnvironment) -> Environment,
+    _ file: StaticString = #file,
+    _ line: UInt = #line
   ) -> Reducer<GlobalState, GlobalAction, GlobalEnvironment> {
     .init { globalState, globalAction, globalEnvironment in
       guard let (key, localAction) = toLocalAction.extract(from: globalAction) else { return .none }
@@ -364,7 +378,9 @@ public struct Reducer<State, Action, Environment> {
         * This action was sent to the store while its state contained no element at this key. \
         To fix this make sure that actions for this reducer can only be sent to a view store
         when its state contains an element at this key.
-        """
+        """,
+        file: file,
+        line: line
       )
       return self.reducer(
         &globalState[keyPath: toLocalState][key]!,

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ let loadThenNavigateListReducer =`
`42`	`42`	`action: .self,`
`43`	`43`	`environment: { $0 }`
`44`	`44`	`)`
`45`		`- .optional`
	`45`	`+ .optional()`
`46`	`46`	`.pullback(`
`47`	`47`	`state: \LoadThenNavigateListState.selection,`
`48`	`48`	`action: /LoadThenNavigateListAction.counter,`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public struct AppEnvironment {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`public let appReducer = Reducer<AppState, AppAction, AppEnvironment>.combine(`
`34`		`- loginReducer.optional.pullback(`
	`34`	`+ loginReducer.optional().pullback(`
`35`	`35`	`state: \.login,`
`36`	`36`	`action: /AppAction.login,`
`37`	`37`	`environment: {`
`@@ -41,7 +41,7 @@ public let appReducer = Reducer<AppState, AppAction, AppEnvironment>.combine(`
`41`	`41`	`)`
`42`	`42`	`}`
`43`	`43`	`),`
`44`		`- newGameReducer.optional.pullback(`
	`44`	`+ newGameReducer.optional().pullback(`
`45`	`45`	`state: \.newGame,`
`46`	`46`	`action: /AppAction.newGame,`
`47`	`47`	`environment: { _ in NewGameEnvironment() }`