Update Tests and README

Author: 0xLeif

Package.resolved

@@ -1,3 +1,60 @@
 # LocationCacheStore
 
-## 🚧
+*CoreLocation State Store*
+
+## What is [`CacheStore`](https://github.com/0xOpenBytes/CacheStore)?
+
+`CacheStore` is a SwiftUI state management framework that uses a dictionary as the state. Scoping creates a single source of truth for the parent state. `CacheStore` uses [`c`](https://github.com/0xOpenBytes/c), which a simple composition framework. [`c`](https://github.com/0xOpenBytes/c) has the ability to create transformations that are either unidirectional or bidirectional.
+
+## LocationStore
+```swift
+public typealias LocationStore = Store<LocationStoreKey, LocationStoreAction, LocationStoreDependency>
+```
+
+## Keys
+```swift
+/// `LocationStore` Keys
+///     - location: CLLocation
+public enum LocationStoreKey {
+    case location // CLLocation
+}
+```
+
+## Actions
+```swift
+/// `LocationStore` Actions
+public enum LocationStoreAction {
+    case updateLocation
+    case locationUpdated(CLLocation?)
+}
+```
+
+## Dependency
+```swift
+/// `LocationStore` Dependency
+public struct LocationStoreDependency {
+    public var shouldContinuouslyUpdate: Bool
+    public var updateLocation: () async -> CLLocation?
+    
+    public init(
+        shouldContinuouslyUpdate: Bool = true,
+        updateLocation: @escaping () async -> CLLocation?
+    ) {
+        self.shouldContinuouslyUpdate = shouldContinuouslyUpdate
+        self.updateLocation = updateLocation
+    }
+}
+```
+
+## StoreActionHandler
+```swift
+/// Higher-order StoreActionHandler
+public func locationStoreActionHandler(
+    withActionHandler actionHandler: StoreActionHandler<LocationStoreKey, LocationStoreAction, LocationStoreDependency>? = nil
+) -> StoreActionHandler<LocationStoreKey, LocationStoreAction, LocationStoreDependency>
+```
+
+## DefaultLocationStore
+```swift
+public class DefaultLocationStore: LocationStore
+```

README.md

@@ -15,11 +15,14 @@ public enum LocationStoreAction {
 
 /// `LocationStore` Dependency
 public struct LocationStoreDependency {
+    public var shouldContinuouslyUpdate: Bool
     public var updateLocation: () async -> CLLocation?
 
     public init(
+        shouldContinuouslyUpdate: Bool = true,
         updateLocation: @escaping () async -> CLLocation?
     ) {
+        self.shouldContinuouslyUpdate = shouldContinuouslyUpdate
         self.updateLocation = updateLocation
     }
 }
@@ -71,18 +74,24 @@ public func locationStoreActionHandler(
         else {
             struct RepeatUpdateLocationActionEffectID: Hashable { }
 
-            return ActionEffect(id: RepeatUpdateLocationActionEffectID()) {
-                sleep(1)
-                return .updateLocation
+            if dependency.shouldContinuouslyUpdate {
+                return ActionEffect(id: RepeatUpdateLocationActionEffectID()) {
+                    sleep(1)
+                    return .updateLocation
+                }
             }
+            
+            return .none
         }
 
         return nextAction
     }
 }
 
+public typealias LocationStore = Store<LocationStoreKey, LocationStoreAction, LocationStoreDependency>
+
 /// LocationStore that updates the user's location
-public class LocationStore: Store<LocationStoreKey, LocationStoreAction, LocationStoreDependency> {
+public class DefaultLocationStore: LocationStore {
     /// Create a LocationStore with an ActionHandler and Dependency
     public init(
         withActionHandler actionHandler: StoreActionHandler<LocationStoreKey, LocationStoreAction, LocationStoreDependency>? = nil,

Sources/LocationCacheStore/LocationStore.swift

@@ -8,58 +8,27 @@ final class LocationCacheStoreTests: XCTestCase {
     func testExample() throws {
         let initLocation = CLLocation()
 
-        let locationStore = LocationStore(
-            initialValues: [:],
-            actionHandler: locationStoreActionHandler(),
-            dependency: .mock(location: initLocation)
-        )
-        
-        enum ExampleKey {
-            case location
-        }
-        
-        struct ExampleStoreContent: StoreContent {
-            var store: Store<ExampleKey, Void, Void>
-            
-            var location: CLLocation {
-                store.resolve(.location)
-            }
-        }
-        
-        var exampleStore: TestStore<ExampleKey, Void, Void> {
-            TestStore(
-                store: locationStore.actionlessScope(
-                    keyTransformation: (
-                        from: { parent in
-                            switch parent {
-                            case .location: return .location
-                            default: return nil
-                            }
-                        },
-                        to: { child in
-                            switch child {
-                            case .location: return .location
-                            default: return nil
-                            }
-                        }
-                    ),
-                    dependencyTransformation: { _ in () }
+        let store = TestStore(
+            store: LocationStore(
+                initialValues: [:],
+                actionHandler: locationStoreActionHandler(),
+                dependency: LocationStoreDependency(
+                    shouldContinuouslyUpdate: false,
+                    updateLocation: { initLocation }
                 )
             )
-        }
+        )
+        
+        store.send(.updateLocation, expecting: { _ in })
 
-        // MARK: - Test
-        exampleStore.content { (content: ExampleStoreContent) in
-            try t.assert(content.location.coordinate.latitude, isEqualTo: initLocation.coordinate.latitude)
-            try t.assert(content.location.coordinate.latitude, isEqualTo: initLocation.coordinate.latitude)
+        store.receive(.locationUpdated(initLocation)) { cacheStore in
+            cacheStore.set(value: initLocation, forKey: .location)
         }
 
         let newLocation = CLLocation(latitude: 1, longitude: 1)
-        locationStore.handle(action: .locationUpdated(newLocation))
 
-        exampleStore.content { (content: ExampleStoreContent) in
-            try t.assert(content.location.coordinate.latitude, isEqualTo: newLocation.coordinate.latitude)
-            try t.assert(content.location.coordinate.latitude, isEqualTo: newLocation.coordinate.latitude)
+        store.send(.locationUpdated(newLocation)) { cacheStore in
+            cacheStore.set(value: newLocation, forKey: .location)
         }
     }
 }