Refactored Connectable API

Author: StevenLambion

Sources/SwiftDux/UI/ActionBinding.swift

@@ -19,7 +19,7 @@ public struct ActionBinding<Value> {
 
  @inlinable internal init(value: Value, isEqual: @escaping (Value) -> Bool, set: @escaping (Value) -> Void) {
  self.isEqual = isEqual
- projectedValue = Binding(get: { value }, set: set)
+ self.projectedValue = Binding(get: { value }, set: set)
  }
 
  @inlinable static internal func constant<T>(value: T) -> ActionBinding<T> {
@@ -32,14 +32,14 @@ public struct ActionBinding<Value> {
 
  /// Returns a regular binding.
  /// - Returns: The binding.
- public func toBinding() -> Binding<Value> {
+ @inlinable public func toBinding() -> Binding<Value> {
  projectedValue
  }
 }
 
 extension ActionBinding: Equatable {
 
- public static func == (lhs: ActionBinding<Value>, rhs: ActionBinding<Value>) -> Bool {
+ @inlinable public static func == (lhs: ActionBinding<Value>, rhs: ActionBinding<Value>) -> Bool {
  lhs.isEqual(rhs.wrappedValue) && rhs.isEqual(lhs.wrappedValue)
  }
 }

Sources/SwiftDux/UI/Connectable.swift

@@ -6,7 +6,7 @@ import SwiftUI
 /// to a possible bug in Swift that throws an invalid assocated type if Props isn't explicitly typealiased.
 public protocol Connectable {
 
- associatedtype Superstate
+ associatedtype State
  associatedtype Props: Equatable
 
  /// Map a superstate to the state needed by the view using the provided parameter.
@@ -15,7 +15,7 @@ public protocol Connectable {
  /// will not be rendered.
  /// - Parameter state: The superstate provided to the view from a superview.
  /// - Returns: The state if possible.
- func map(state: Superstate) -> Props?
+ func map(state: State) -> Props?
 
  /// Map a superstate to the state needed by the view using the provided parameter.
  ///
@@ -25,18 +25,18 @@ public protocol Connectable {
  /// - state: The superstate provided to the view from a superview.
  /// - binder: Helper that creates Binding types beteen the state and a dispatcable action
  /// - Returns: The state if possible.
- func map(state: Superstate, binder: ActionBinder) -> Props?
+ func map(state: State, binder: ActionBinder) -> Props?
 }
 
 extension Connectable {
 
  /// Default implementation. Returns nil.
- @inlinable public func map(state: Superstate) -> Props? {
+ @inlinable public func map(state: State) -> Props? {
  nil
  }
 
  /// Default implementation. Calls the other map function.
- @inlinable public func map(state: Superstate, binder: ActionBinder) -> Props? {
+ @inlinable public func map(state: State, binder: ActionBinder) -> Props? {
  map(state: state)
  }
 }

Sources/SwiftDux/UI/ConnectableView.swift

@@ -3,7 +3,7 @@ import SwiftUI
 /// A view that connects to the application state.
 public protocol ConnectableView: View, Connectable {
  associatedtype Content: View
- associatedtype Body = Connector<Content, Superstate, Props>
+ associatedtype Body = Connector<Content, State, Props>
 
  /// Return the body of the view using the provided props object.
  /// - Parameter props: A mapping of the application to the props used by the view.
@@ -13,13 +13,7 @@ public protocol ConnectableView: View, Connectable {
 
 extension ConnectableView {
 
- /// Concrete return type is nessarry to avoid segment fault in release builds of apps.
- public var body: Connector<Content, Superstate, Props> {
- Connector<Content, Superstate, Props>(
- content: { props in
- self.body(props: props)
- },
- mapProps: map
- )
+ public var body: Connector<Content, State, Props> {
+ Connector(mapState: map, content: body)
  }
 }

Sources/SwiftDux/UI/ConnectableViewModifier.swift

@@ -0,0 +1,23 @@
+import SwiftUI
+
+/// A view modifier that connects to the application state.
+public protocol ConnectableViewModifier: ViewModifier, Connectable {
+ associatedtype InnerBody: View
+ associatedtype Body = Connector<InnerBody, State, Props>
+
+ /// Return the body of the view modifier using the provided props object.
+ /// - Parameters:
+ /// - props: A mapping of the application to the props used by the view.
+ /// - content: The content of the view modifier.
+ /// - Returns: The connected view.
+ func body(props: Props, content: Content) -> InnerBody
+}
+
+extension ConnectableViewModifier {
+
+ public func body(content: Content) -> Connector<InnerBody, State, Props> {
+ Connector(mapState: map) { props in
+ body(props: props, content: content)
+ }
+ }
+}

Sources/SwiftDux/UI/Connector.swift

@@ -1,61 +1,40 @@
 import Combine
 import SwiftUI
 
-public struct Connector<Content, Superstate, Props>: View where Props: Equatable, Content: View {
+public struct Connector<Content, State, Props>: View where Props: Equatable, Content: View {
  @Environment(\.store) private var anyStore
- @Environment(\.actionDispatcher) private var actionDispatcher
+ @Environment(\.actionDispatcher) private var dispatch
 
+ private var mapState: (State, ActionBinder) -> Props?
  private var content: (Props) -> Content
- private var mapProps: (Superstate, ActionBinder) -> Props?
+ @SwiftUI.State private var props: Props?
 
- private var store: StoreProxy<Superstate>? {
+ private var store: StoreProxy<State>? {
  if anyStore is NoopAnyStore {
  return nil
- } else if let store = anyStore.unwrap(as: Superstate.self) {
+ } else if let store = anyStore.unwrap(as: State.self) {
  return store
  }
- fatalError("Tried mapping the state to a view, but the Store<_> doesn't conform to '\(Superstate.self)'")
+ fatalError("Tried mapping the state to a view, but the Store<_> doesn't conform to '\(State.self)'")
  }
 
  public init(
- content: @escaping (Props) -> Content,
- mapProps: @escaping (Superstate, ActionBinder) -> Props?
+ mapState: @escaping (State, ActionBinder) -> Props?,
+ @ViewBuilder content: @escaping (Props) -> Content
  ) {
  self.content = content
- self.mapProps = mapProps
+ self.mapState = mapState
  }
 
  public var body: some View {
  store.map { store in
- ConnectorInner(
- content: content,
- initialProps: getProps(),
- propsPublisher: store.didChange
- .compactMap { _ in getProps() }
- .removeDuplicates()
- )
+ Group {
+ props.map { content($0) }
+ }.onReceive(store.publish(mapState)) { self.props = $0 }
  }
  }
 
- private func getProps() -> Props? {
- guard let store = store else { return nil }
- return mapProps(store.state, ActionBinder(actionDispatcher: self.actionDispatcher))
- }
-}
-
-internal struct ConnectorInner<Props, PropsPublisher, Content>: View
-where Props: Equatable, PropsPublisher: Publisher, PropsPublisher.Output == Props, PropsPublisher.Failure == Never, Content: View {
- private var content: (Props) -> Content
- private var propsPublisher: PropsPublisher
- @State private var props: Props?
-
- internal init(content: @escaping (Props) -> Content, initialProps: Props?, propsPublisher: PropsPublisher) {
- self.content = content
- self.propsPublisher = propsPublisher
- self._props = State(initialValue: initialProps)
- }
-
- var body: some View {
- return props.map { content($0).onReceive(propsPublisher) { self.props = $0 } }
+ private func mapState(state: State) -> Props? {
+ mapState(state, ActionBinder(actionDispatcher: dispatch))
  }
 }

Sources/SwiftDux/UI/Extensions/Environment+ActionDispatcher.swift

@@ -18,7 +18,7 @@ extension EnvironmentValues {
 
  /// Environment value to supply an actionDispatcher. This is used by the MappedDispatch to retrieve
  /// an action dispatcher from the environment.
- internal var actionDispatcher: ActionDispatcher {
+ public var actionDispatcher: ActionDispatcher {
  get {
  self[ActionDispatcherKey.self]
  }

Sources/SwiftDux/UI/ViewModifiers/OnAppearDispatchViewModifier.swift

@@ -1,42 +1,41 @@
 import Combine
+import Dispatch
 import SwiftUI
 
 public struct OnAppearDispatchActionViewModifier: ViewModifier {
- @MappedDispatch() private var dispatch
-
- var action: Action
-
+ @Environment(\.actionDispatcher) private var dispatch
  @State private var cancellable: Cancellable? = nil
+ private var action: Action
 
  @usableFromInline internal init(action: Action) {
  self.action = action
  }
 
  public func body(content: Content) -> some View {
- content.onAppear { [action, dispatch] in dispatch(action) }
+ content.onAppear { dispatch(action) }
  }
 }
 
-public struct OnAppearDispatchActionPlanViewModifier<T>: ViewModifier {
- @MappedDispatch() private var dispatch
+public struct OnAppearDispatchActionPlanViewModifier: ViewModifier {
+ @Environment(\.actionDispatcher) private var dispatch
 
- var actionPlan: ActionPlan<T>
- var cancelOnDisappear: Bool
+ private var action: RunnableAction
+ private var cancelOnDisappear: Bool
 
  @State private var cancellable: Cancellable? = nil
 
- @usableFromInline internal init(actionPlan: ActionPlan<T>, cancelOnDisappear: Bool) {
- self.actionPlan = actionPlan
+ @usableFromInline internal init(action: RunnableAction, cancelOnDisappear: Bool) {
+ self.action = action
  self.cancelOnDisappear = cancelOnDisappear
  }
 
  public func body(content: Content) -> some View {
  content
- .onAppear { [actionPlan, dispatch] in
- guard self.cancellable == nil else { return }
- self.cancellable = actionPlan.sendAsCancellable(dispatch)
+ .onAppear {
+ guard cancellable == nil else { return }
+ self.cancellable = action.sendAsCancellable(dispatch)
  }
- .onDisappear { [cancelOnDisappear] in
+ .onDisappear {
  if cancelOnDisappear {
  self.cancellable?.cancel()
  self.cancellable = nil
@@ -52,7 +51,12 @@ extension View {
  /// - Parameter action: An action to dispatch every time the view appears.
  /// - Returns: The modified view.
  @inlinable public func onAppear(dispatch action: Action) -> some View {
- modifier(OnAppearDispatchActionViewModifier(action: action))
+ Group {
+ if let action = action as? RunnableAction {
+ modifier(OnAppearDispatchActionPlanViewModifier(action: action, cancelOnDisappear: true))
+ }
+ modifier(OnAppearDispatchActionViewModifier(action: action))
+ }
  }
 
  /// Sends the provided action plan when the view appears.
@@ -99,11 +103,11 @@ extension View {
  /// ```
  ///
  /// - Parameters:
- /// - actionPlan: An action to dispatch every time the view appears.
+ /// - action: An action to dispatch every time the view appears.
  /// - cancelOnDisappear: It will cancel any subscription from the action when the view disappears. If false, it keeps
  /// the subscription alive and reppearances of the view will not re-call the action.
  /// - Returns: The modified view.
- @inlinable public func onAppear<T>(dispatch actionPlan: ActionPlan<T>, cancelOnDisappear: Bool = true) -> some View {
- modifier(OnAppearDispatchActionPlanViewModifier(actionPlan: actionPlan, cancelOnDisappear: cancelOnDisappear))
+ @inlinable public func onAppear<T>(dispatch action: RunnableAction, cancelOnDisappear: Bool) -> some View {
+ modifier(OnAppearDispatchActionPlanViewModifier(action: action, cancelOnDisappear: cancelOnDisappear))
  }
 }

Sources/SwiftDux/UI/ViewModifiers/StoreProviderViewModifier.swift

@@ -3,12 +3,16 @@ import SwiftUI
 
 /// A view modifier that injects a store into the environment.
 internal struct StoreProviderViewModifier: ViewModifier {
- var anyStore: AnyStore
+ private var store: AnyStore
 
- func body(content: Content) -> some View {
+ init(store: AnyStore) {
+ self.store = store
+ }
+
+ public func body(content: Content) -> some View {
  content
- .environment(\.store, anyStore)
- .environment(\.actionDispatcher, anyStore)
+ .environment(\.store, store)
+ .environment(\.actionDispatcher, store)
  }
 }
 
@@ -34,10 +38,10 @@ extension View {
  /// - Parameter store: The store object to inject.
  /// - Returns: The modified view.
  public func provideStore<State>(_ store: Store<State>) -> some View where State: Equatable {
- return modifier(StoreProviderViewModifier(anyStore: AnyStoreWrapper(store: store)))
+ modifier(StoreProviderViewModifier(store: AnyStoreWrapper(store: store)))
  }
 
  public func provideStore(_ store: AnyStore) -> some View {
- return modifier(StoreProviderViewModifier(anyStore: store))
+ modifier(StoreProviderViewModifier(store: store))
  }
 }