Merge pull request #15 from ra1028/refactor/atom-state

refactor: Internal system

Author: ra1028

README.md

@@ -1079,7 +1079,7 @@ Context that can simulate any scenarios in which atoms are used from a view or a
 |API|Use|
 |:--|:--|
 |[unwatch(_:)](https://ra1028.github.io/swiftui-atom-properties/documentation/atoms/atomtestcontext/unwatch(_:))|Simulates a scenario in which the atom is no longer watched.|
-|[override(_:with:)](https://ra1028.github.io/swiftui-atom-properties/documentation/atoms/atomtestcontext/override(_:with:)-67ivk)|Overwrites the output of a specific atom or all atoms of the given type with the fixed value.|
+|[override(_:with:)](https://ra1028.github.io/swiftui-atom-properties/documentation/atoms/atomtestcontext/override(_:with:)-1ce4h)|Overwrites the output of a specific atom or all atoms of the given type with the fixed value.|
 |[observe(_:)](https://ra1028.github.io/swiftui-atom-properties/documentation/atoms/atomtestcontext/observe(_:))|Observes changes in any atom values and its lifecycles.|
 |[onUpdate](https://ra1028.github.io/swiftui-atom-properties/documentation/atoms/atomtestcontext/onupdate)|Sets a closure that notifies there has been an update to one of the atoms.|
 

Sources/Atoms/Atom/AsyncSequenceAtom.swift

@@ -44,7 +44,7 @@
 /// }
 /// ```
 ///
-public protocol AsyncSequenceAtom: Atom where Hook == AsyncSequenceHook<Sequence> {
+public protocol AsyncSequenceAtom: Atom where State == AsyncSequenceAtomState<Sequence> {
     /// The type of asynchronous sequence that this atom manages.
     associatedtype Sequence: AsyncSequence
 
@@ -64,7 +64,7 @@ public protocol AsyncSequenceAtom: Atom where Hook == AsyncSequenceHook<Sequence
 
 public extension AsyncSequenceAtom {
     @MainActor
-    var hook: Hook {
-        Hook(sequence: sequence)
+    func makeState() -> State {
+        State(makeSequence: sequence)
     }
 }

Sources/Atoms/Atom/Atom.swift

@@ -1,7 +1,5 @@
 /// Declares that a type can produce a value that can be accessed from everywhere.
 ///
-/// In summary, this protocol declares a hook that determines the behavioral details
-/// of this atom and a key determines the value uniqueness.
 /// The value produced by an atom is created only when the atom is watched from somewhere,
 /// and is immediately released when no longer watched to.
 ///
@@ -11,8 +9,8 @@ public protocol Atom {
     /// A type representing the stable identity of this atom.
     associatedtype Key: Hashable
 
-    /// A type of the hook that determines behavioral details.
-    associatedtype Hook: AtomHook
+    /// A type of state that is an actual implementation of this atom.
+    associatedtype State: AtomState
 
     /// A type of the context structure that to read, watch, and otherwise interacting
     /// with other atoms.
@@ -34,9 +32,11 @@ public protocol Atom {
     /// If this atom conforms to `Hashable`, it will adopt itself as the `key` by default.
     var key: Key { get }
 
-    /// Internal use, the hook for managing the state of this atom.
+    /// Creates a new state that is an actual implementation of this atom.
+    ///
+    /// - Returns: A state object that handles internal process and a value.
     @MainActor
-    var hook: Hook { get }
+    func makeState() -> State
 
     /// Returns a boolean value that determines whether it should notify the value update to
     /// watchers with comparing the given old value and the new value.
@@ -48,12 +48,12 @@ public protocol Atom {
     /// - Returns: A boolean value that determines whether it should notify the value update
     ///            to watchers.
     @MainActor
-    func shouldNotifyUpdate(newValue: Hook.Value, oldValue: Hook.Value) -> Bool
+    func shouldNotifyUpdate(newValue: State.Value, oldValue: State.Value) -> Bool
 }
 
 public extension Atom {
     @MainActor
-    func shouldNotifyUpdate(newValue: Hook.Value, oldValue: Hook.Value) -> Bool {
+    func shouldNotifyUpdate(newValue: State.Value, oldValue: State.Value) -> Bool {
         true
     }
 }

Sources/Atoms/Atom/ModifiedAtom.swift

@@ -1,7 +1,7 @@
 /// An atom type that applies a modifier to an atom.
 ///
 /// Use ``Atom/modifier(_:)`` instead of using this atom directly.
-public struct ModifiedAtom<Node: Atom, Modifier: AtomModifier>: Atom where Node.Hook.Value == Modifier.Value {
+public struct ModifiedAtom<Node: Atom, Modifier: AtomModifier>: Atom where Node.State.Value == Modifier.Value {
     /// A type representing the stable identity of this atom.
     public struct Key: Hashable {
         private let atomKey: Node.Key
@@ -29,9 +29,11 @@ public struct ModifiedAtom<Node: Atom, Modifier: AtomModifier>: Atom where Node.
         Key(atomKey: atom.key, modifierKey: modifier.key)
     }
 
-    /// Internal use, the hook for managing the state of this atom.
-    public var hook: ModifiedHook<Node, Modifier> {
-        ModifiedHook(atom: atom, modifier: modifier)
+    /// Creates a new state that is an actual implementation of this atom.
+    ///
+    /// - Returns: A state object that handles internal process and a value.
+    public func makeState() -> ModifiedAtomState<Node, Modifier> {
+        State(atom: atom, modifier: modifier)
     }
 
     /// Returns a boolean value that determines whether it should notify the value update to

Sources/Atoms/Atom/ObservableObjectAtom.swift

@@ -48,7 +48,7 @@ import Combine
 /// }
 /// ```
 ///
-public protocol ObservableObjectAtom: Atom where Hook == ObservableObjectHook<ObjectType> {
+public protocol ObservableObjectAtom: Atom where State == ObservableObjectAtomState<ObjectType> {
     /// The type of observable object that this atom produces.
     associatedtype ObjectType: ObservableObject
 
@@ -67,7 +67,7 @@ public protocol ObservableObjectAtom: Atom where Hook == ObservableObjectHook<Ob
 
 public extension ObservableObjectAtom {
     @MainActor
-    var hook: Hook {
-        Hook(object: object)
+    func makeState() -> State {
+        State(makeObject: object)
     }
 }

Sources/Atoms/Atom/PublisherAtom.swift

@@ -37,7 +37,7 @@ import Combine
 /// }
 /// ```
 ///
-public protocol PublisherAtom: Atom where Hook == PublisherHook<Publisher> {
+public protocol PublisherAtom: Atom where State == PublisherAtomState<Publisher> {
     /// The type of publisher that this atom manages.
     associatedtype Publisher: Combine.Publisher
 
@@ -57,7 +57,7 @@ public protocol PublisherAtom: Atom where Hook == PublisherHook<Publisher> {
 
 public extension PublisherAtom {
     @MainActor
-    var hook: Hook {
-        Hook(publisher: publisher)
+    func makeState() -> State {
+        State(makePublisher: publisher)
     }
 }

Sources/Atoms/Atom/StateAtom.swift

@@ -36,7 +36,7 @@
 /// }
 /// ```
 ///
-public protocol StateAtom: Atom where Hook == StateHook<Value> {
+public protocol StateAtom: Atom where State == StateAtomState<Value> {
     /// The type of state value that this atom produces.
     associatedtype Value
 
@@ -77,12 +77,8 @@ public protocol StateAtom: Atom where Hook == StateHook<Value> {
 
 public extension StateAtom {
     @MainActor
-    var hook: Hook {
-        Hook(
-            defaultValue: defaultValue,
-            willSet: willSet,
-            didSet: didSet
-        )
+    func makeState() -> State {
+        State(getDefaultValue: defaultValue)
     }
 
     @MainActor

Sources/Atoms/Atom/TaskAtom.swift

@@ -34,7 +34,7 @@
 /// }
 /// ```
 ///
-public protocol TaskAtom: Atom where Hook == TaskHook<Value> {
+public protocol TaskAtom: Atom where State == TaskAtomState<Value> {
     /// The type of value that this atom produces.
     associatedtype Value
 
@@ -53,7 +53,7 @@ public protocol TaskAtom: Atom where Hook == TaskHook<Value> {
 
 public extension TaskAtom {
     @MainActor
-    var hook: Hook {
-        Hook(value: value)
+    func makeState() -> State {
+        State(getValue: value)
     }
 }

Sources/Atoms/Atom/ThrowingTaskAtom.swift

@@ -36,7 +36,7 @@
 /// }
 /// ```
 ///
-public protocol ThrowingTaskAtom: Atom where Hook == ThrowingTaskHook<Value> {
+public protocol ThrowingTaskAtom: Atom where State == ThrowingTaskState<Value> {
     /// The type of value that this atom produces.
     associatedtype Value
 
@@ -57,7 +57,7 @@ public protocol ThrowingTaskAtom: Atom where Hook == ThrowingTaskHook<Value> {
 
 public extension ThrowingTaskAtom {
     @MainActor
-    var hook: Hook {
-        Hook(value: value)
+    func makeState() -> State {
+        State(getValue: value)
     }
 }

Sources/Atoms/Atom/ValueAtom.swift

@@ -29,7 +29,7 @@
 /// }
 /// ```
 ///
-public protocol ValueAtom: Atom where Hook == ValueHook<Value> {
+public protocol ValueAtom: Atom where State == ValueAtomState<Value> {
     /// The type of value that this atom produces.
     associatedtype Value
 
@@ -48,7 +48,7 @@ public protocol ValueAtom: Atom where Hook == ValueHook<Value> {
 
 public extension ValueAtom {
     @MainActor
-    var hook: Hook {
-        Hook(value: value)
+    func makeState() -> State {
+        State(getValue: value)
     }
 }