Update

VergeGroup · Nov 24, 2023 · 449d0df · 449d0df
1 parent f853bff
commit 449d0df
Show file tree

Hide file tree

Showing 26 changed files with 150 additions and 443 deletions.
diff --git a/Demo/VergeStoreDemoSwiftUI/PostView.swift b/Demo/VergeStoreDemoSwiftUI/PostView.swift
@@ -9,7 +9,7 @@ struct PostView: View {
   let post: Entity.Post
 
   private var user: Entity.User? {
-    session.store.primitiveState.db.entities.user.find(by: post.userID)
+    session.store.state.primitive.db.entities.user.find(by: post.userID)
   }
 
   var body: some View {

diff --git a/Demo/VergeStoreDemoSwiftUI/UserDetailView.swift b/Demo/VergeStoreDemoSwiftUI/UserDetailView.swift
@@ -23,8 +23,8 @@ struct UserDetailView: View, Equatable {
 
   private var posts: [Entity.Post] {
 
-    session.store.primitiveState.db.entities.post.find(in:
-      session.store.primitiveState.db.indexes.postIDsAuthorGrouped.orderedID(in: user.entityID)
+    session.store.state.primitive.db.entities.post.find(in:
+      session.store.state.primitive.db.indexes.postIDsAuthorGrouped.orderedID(in: user.entityID)
     )
   }
 

diff --git a/Demo/VergeStoreDemoUIKit/Sources.swift b/Demo/VergeStoreDemoUIKit/Sources.swift
@@ -37,7 +37,7 @@ final class RootStore: Store<RootState, RootActivity> {
     DispatchQueue.main.async {
 
       self.increment()
-      if self.primitiveState.count > 10 {
+      if self.state.primitive.count > 10 {
         self.send(.bomb)
       }
 

diff --git a/Sources/Verge/Derived/Derived+Assign.swift b/Sources/Verge/Derived/Derived+Assign.swift
@@ -19,7 +19,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-extension DispatcherType {
+extension StoreDriverType {
 
   /**
    Assigns a Store's state to a property of a store.
@@ -28,7 +28,7 @@ extension DispatcherType {
    */
   public func assign(
     queue: some TargetQueueType = .passthrough,
-    to binder: @escaping (Changes<State>) -> Void
+    to binder: @escaping (Changes<TargetStore.State>) -> Void
   ) -> StoreSubscription {
     store.asStore().sinkState(queue: queue, receive: binder)
   }
@@ -40,7 +40,7 @@ extension DispatcherType {
    */
   public func assign(
     queue: MainActorTargetQueue,
-    to binder: @escaping (Changes<State>) -> Void
+    to binder: @escaping (Changes<TargetStore.State>) -> Void
   ) -> StoreSubscription {
     store.asStore().sinkState(queue: queue, receive: binder)
   }

diff --git a/Sources/Verge/Store/DetachedDispatcher.swift b/Sources/Verge/Store/DetachedDispatcher.swift
@@ -19,7 +19,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-public final class DetachedDispatcher<State: Equatable, Activity, Scope: Equatable>: DispatcherType
+public final class DetachedDispatcher<State: Equatable, Activity, Scope: Equatable>: StoreDriverType
 {
 
   public let store: Store<State, Activity>

diff --git a/Sources/Verge/Store/Store.swift b/Sources/Verge/Store/Store.swift
@@ -36,7 +36,6 @@ public protocol StoreType<State>: AnyObject, Sendable, ObservableObject where Ob
 
   func asStore() -> Store<State, Activity>
 
-  var primitiveState: State { get }
   var state: Changes<State> { get }
 }
 
@@ -80,7 +79,7 @@ actor Writer {
 /// ```
 /// You may use also `StoreWrapperType` to define State and Activity as inner types.
 ///
-open class Store<State: Equatable, Activity>: EventEmitter<_StoreEvent<State, Activity>>, CustomReflectable, StoreType, DispatcherType, DerivedMaking, @unchecked Sendable {
+open class Store<State: Equatable, Activity>: EventEmitter<_StoreEvent<State, Activity>>, CustomReflectable, StoreType, StoreDriverType, DerivedMaking, @unchecked Sendable {
 
   public var scope: WritableKeyPath<State, State> = \State.self
 
@@ -268,15 +267,6 @@ extension Store {
   public var objectDidChange: AnyPublisher<Changes<State>, Never> {
     valuePublisher.dropFirst().eraseToAnyPublisher()
   }
-
-
-  /// A current state.
-  ///
-  /// It causes locking and unlocking with a bit cost.
-  /// It may cause blocking if any other is doing mutation or reading.
-  public var primitiveState: State {
-    state.primitive
-  }
 
   /// Returns a current state with thread-safety.
   ///

diff --git a/Sources/Verge/Store/DispatcherType.swift → Sources/Verge/Store/StoreDriverType.swift b/Sources/Verge/Store/DispatcherType.swift → Sources/Verge/Store/StoreDriverType.swift
@@ -21,38 +21,65 @@
 
 import Foundation
 
-// It would be renamed as StoreContextType
-public protocol DispatcherType<Scope>: AnyObject where State == WrappedStore.State, Activity == WrappedStore.Activity {
+@available(*, deprecated, renamed: "StoreDriverType")
+public typealias DispatcherType<Scope> = StoreDriverType<Scope>
+
+/**
+ A protocol that uses external Store inside and provides the functions.
+ ```
+ final class MyViewModel: StoreDriverType {
+
+   struct State {
+     ...
+   }
+
+   // If you don't need Activity, you can remove it.
+   enum Activity {
+     ...
+   }
+
+   let store: Store<State, Activity>
+
+   init() {
+     self.store = .init(initialState: .init(), logger: nil)
+   }
+
+ }
+ ``` 
+ */
+public protocol StoreDriverType<Scope>: ObservableObject {
+
+  associatedtype TargetStore: StoreType
+
+  associatedtype Scope: Equatable = TargetStore.State
+
+  var store: TargetStore { get }
+  var scope: WritableKeyPath<TargetStore.State, Scope> { get }
 
-  associatedtype WrappedStore: StoreType
-  associatedtype Scope: Equatable = WrappedStore.State
-
-  associatedtype State = WrappedStore.State
-  associatedtype Activity = WrappedStore.Activity
-
-  var store: WrappedStore { get }
-  var scope: WritableKeyPath<WrappedStore.State, Scope> { get }
   var state: Changes<Scope> { get }
 }
 
-extension DispatcherType {
+extension StoreDriverType {
+
+  public var objectWillChange: TargetStore.ObjectWillChangePublisher {
+    store.objectWillChange
+  }
+
   /// A state that cut out from root-state with the scope key path.
   public nonisolated var state: Changes<Scope> {
     store.state.map { $0[keyPath: scope] }
   }
 
-  public nonisolated var rootState: Changes<State> {
+  public nonisolated var rootState: Changes<TargetStore.State> {
     return store.state
   }
 }
 
-extension DispatcherType where Scope == State {
-  public var scope: WritableKeyPath<WrappedStore.State, WrappedStore.State> {
-    \WrappedStore.State.self
-  }
-}
+extension StoreDriverType where Scope == TargetStore.State {
 
-extension DispatcherType where Scope == State {
+  public var scope: WritableKeyPath<TargetStore.State, TargetStore.State> {
+    \TargetStore.State.self
+  }
 
   // MARK: - Subscribings
 
@@ -67,7 +94,7 @@ extension DispatcherType where Scope == State {
   public func sinkState(
     dropsFirst: Bool = false,
     queue: some TargetQueueType,
-    receive: @escaping (Changes<State>) -> Void
+    receive: @escaping (Changes<TargetStore.State>) -> Void
   ) -> StoreSubscription {
     store.asStore()._primitive_sinkState(dropsFirst: dropsFirst, queue: queue, receive: receive)
   }
@@ -83,7 +110,7 @@ extension DispatcherType where Scope == State {
   public func sinkState(
     dropsFirst: Bool = false,
     queue: MainActorTargetQueue = .mainIsolated(),
-    receive: @escaping @MainActor (Changes<State>) -> Void
+    receive: @escaping @MainActor (Changes<TargetStore.State>) -> Void
   ) -> StoreSubscription {
     store.asStore()._mainActor_sinkState(dropsFirst: dropsFirst, queue: queue, receive: receive)
   }
@@ -99,10 +126,10 @@ extension DispatcherType where Scope == State {
   /// - Returns: A subscriber that performs the provided closure upon receiving values.
   @_disfavoredOverload
   public func sinkState<Accumulate>(
-    scan: Scan<Changes<State>, Accumulate>,
+    scan: Scan<Changes<TargetStore.State>, Accumulate>,
     dropsFirst: Bool = false,
     queue: some TargetQueueType,
-    receive: @escaping (Changes<State>, Accumulate) -> Void
+    receive: @escaping (Changes<TargetStore.State>, Accumulate) -> Void
   ) -> StoreSubscription {
     store.asStore()._primitive_scan_sinkState(scan: scan, dropsFirst: dropsFirst, queue: queue, receive: receive)
   }
@@ -118,10 +145,10 @@ extension DispatcherType where Scope == State {
   /// - Returns: A subscriber that performs the provided closure upon receiving values.
   @discardableResult
   public func sinkState<Accumulate>(
-    scan: Scan<Changes<State>, Accumulate>,
+    scan: Scan<Changes<TargetStore.State>, Accumulate>,
     dropsFirst: Bool = false,
     queue: MainActorTargetQueue = .mainIsolated(),
-    receive: @escaping @MainActor (Changes<State>, Accumulate) -> Void
+    receive: @escaping @MainActor (Changes<TargetStore.State>, Accumulate) -> Void
   ) -> StoreSubscription {
     store.asStore()._mainActor_scan_sinkState(scan: scan, dropsFirst: dropsFirst, queue: queue, receive: receive)
   }
@@ -132,7 +159,7 @@ extension DispatcherType where Scope == State {
   @_disfavoredOverload
   public func sinkActivity(
     queue: some TargetQueueType,
-    receive: @escaping (Activity) -> Void
+    receive: @escaping (TargetStore.Activity) -> Void
   ) -> StoreSubscription {
 
     store.asStore()._primitive_sinkActivity(queue: queue, receive: receive)
@@ -144,7 +171,7 @@ extension DispatcherType where Scope == State {
   /// - Returns: A subscriber that performs the provided closure upon receiving values.
   public func sinkActivity(
     queue: MainActorTargetQueue = .mainIsolated(),
-    receive: @escaping @MainActor (Activity) -> Void
+    receive: @escaping @MainActor (TargetStore.Activity) -> Void
   ) -> StoreSubscription {
 
     store.asStore()._mainActor_sinkActivity(queue: queue) { activity in
@@ -157,7 +184,7 @@ extension DispatcherType where Scope == State {
 
 }
 
-extension DispatcherType {
+extension StoreDriverType {
 
   /**
     Subscribe the state that scoped
@@ -254,7 +281,7 @@ extension DispatcherType {
   /// - Parameter activity:
   public func send(
     _ name: String = "",
-    _ activity: WrappedStore.Activity,
+    _ activity: TargetStore.Activity,
     _ file: StaticString = #file,
     _ function: StaticString = #function,
     _ line: UInt = #line
@@ -272,7 +299,7 @@ extension DispatcherType {
   /// Send activity
   /// - Parameter activity:
   public func send(
-    _ activity: WrappedStore.Activity,
+    _ activity: TargetStore.Activity,
     _ file: StaticString = #file,
     _ function: StaticString = #function,
     _ line: UInt = #line
@@ -316,7 +343,7 @@ extension DispatcherType {
     _ function: StaticString = #function,
     _ line: UInt = #line,
     mutation: (inout InoutRef<Scope>) throws -> Result
-  ) rethrows -> Result where Scope == WrappedStore.State {
+  ) rethrows -> Result where Scope == TargetStore.State {
     let trace = MutationTrace(
       name: name,
       file: file,
@@ -333,7 +360,7 @@ extension DispatcherType {
   func _commit<Result>(
     trace: MutationTrace,
     mutation: (inout InoutRef<Scope>) throws -> Result
-  ) rethrows -> Result where Scope == WrappedStore.State {
+  ) rethrows -> Result where Scope == TargetStore.State {
     return try store.asStore()._receive(
       mutation: { ref, transaction -> Result in
         ref.append(trace: trace)
@@ -342,13 +369,13 @@ extension DispatcherType {
     )
   }
 
-  public func detached<NewScope: Equatable>(from newScope: WritableKeyPath<WrappedStore.State, NewScope>)
-  -> DetachedDispatcher<WrappedStore.State, WrappedStore.Activity, NewScope> {
+  public func detached<NewScope: Equatable>(from newScope: WritableKeyPath<TargetStore.State, NewScope>)
+  -> DetachedDispatcher<TargetStore.State, TargetStore.Activity, NewScope> {
     .init(store: store.asStore(), scope: newScope)
   }
 
   public func detached<NewScope: Equatable>(by appendingScope: WritableKeyPath<Scope, NewScope>)
-  -> DetachedDispatcher<WrappedStore.State, WrappedStore.Activity, NewScope> {
+  -> DetachedDispatcher<TargetStore.State, TargetStore.Activity, NewScope> {
     .init(store: store.asStore(), scope: scope.appending(path: appendingScope))
   }
 }
diff --git a/Sources/Verge/Store/StoreType+Assignee.swift b/Sources/Verge/Store/StoreType+Assignee.swift
@@ -21,7 +21,7 @@
 
 import Foundation
 
-extension DispatcherType {
+extension StoreDriverType {
 
   public typealias Assignee<Value> = (Value) -> Void
 
@@ -38,7 +38,7 @@ extension DispatcherType {
    ```
    */
   public func assignee<Value>(
-    _ keyPath: WritableKeyPath<State, Value>,
+    _ keyPath: WritableKeyPath<TargetStore.State, Value>,
     dropsOutput: @escaping (Changes<Value>) -> Bool = { _ in false }
   ) -> Assignee<Changes<Value>> {
     return { [weak self] value in
@@ -62,7 +62,7 @@ extension DispatcherType {
    ```
    */
   public func assignee<Value>(
-    _ keyPath: WritableKeyPath<State, Value?>,
+    _ keyPath: WritableKeyPath<TargetStore.State, Value?>,
     dropsOutput: @escaping (Changes<Value?>) -> Bool = { _ in false }
   ) -> Assignee<Changes<Value?>> {
     return { [weak self] value in
@@ -86,7 +86,7 @@ extension DispatcherType {
    ```
    */
   public func assignee<Value>(
-    _ keyPath: WritableKeyPath<State, Value?>,
+    _ keyPath: WritableKeyPath<TargetStore.State, Value?>,
     dropsOutput: @escaping (Changes<Value?>) -> Bool = { _ in false }
   ) -> Assignee<Changes<Value>> {
     return { [weak self] value in
@@ -102,7 +102,7 @@ extension DispatcherType {
    Assignee to asign Changes object directly.
    */
   public func assignee<Value>(
-    _ keyPath: WritableKeyPath<State, Value>
+    _ keyPath: WritableKeyPath<TargetStore.State, Value>
   ) -> Assignee<Value> {
     return { [weak self] value in
       self?.store.asStore().commit {
@@ -115,7 +115,7 @@ extension DispatcherType {
    Assignee to asign Changes object directly.
    */
   public func assignee<Value>(
-    _ keyPath: WritableKeyPath<State, Value?>
+    _ keyPath: WritableKeyPath<TargetStore.State, Value?>
   ) -> Assignee<Value?> {
     return { [weak self] value in
       self?.store.asStore().commit {
@@ -128,7 +128,7 @@ extension DispatcherType {
    Assignee to asign Changes object directly.
    */
   public func assignee<Value>(
-    _ keyPath: WritableKeyPath<State, Value?>
+    _ keyPath: WritableKeyPath<TargetStore.State, Value?>
   ) -> Assignee<Value> {
     return { [weak self] value in
       self?.store.asStore().commit {
@@ -150,7 +150,7 @@ extension DispatcherType {
    ```
    */
   public func assignee<Value: Equatable>(
-    _ keyPath: WritableKeyPath<State, Value>
+    _ keyPath: WritableKeyPath<TargetStore.State, Value>
   ) -> Assignee<Changes<Value>> {
     assignee(keyPath, dropsOutput: { !$0.hasChanges })
   }
@@ -168,7 +168,7 @@ extension DispatcherType {
    ```
    */
   public func assignee<Value: Equatable>(
-    _ keyPath: WritableKeyPath<State, Value?>
+    _ keyPath: WritableKeyPath<TargetStore.State, Value?>
   ) -> Assignee<Changes<Value?>> {
     assignee(keyPath, dropsOutput: { !$0.hasChanges })
   }
@@ -186,7 +186,7 @@ extension DispatcherType {
    ```
    */
   public func assignee<Value: Equatable>(
-    _ keyPath: WritableKeyPath<State, Value?>
+    _ keyPath: WritableKeyPath<TargetStore.State, Value?>
   ) -> Assignee<Changes<Value>> {
     assignee(keyPath, dropsOutput: { !$0.hasChanges })
   }