Leif/improvements (#29)

* Add more logging and values to logs * Add log to StoredState set * Seperate guard conditions * Add function for storedState nil initial value
0xLeif · Nov 26, 2023 · b492ae1 · b492ae1
1 parent bcc7856
commit b492ae1
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 11 deletions.
diff --git a/Sources/AppState/Application/Application+public.swift b/Sources/AppState/Application/Application+public.swift
@@ -85,7 +85,7 @@ public extension Application {
         let dependency = shared.value(keyPath: keyPath)
 
         log(
-            debug: "🟢 Starting Dependency Override \(String(describing: keyPath))",
+            debug: "🟢 Starting Dependency Override \(String(describing: keyPath)) with \(value)",
             fileID: fileID,
             function: function,
             line: line,
@@ -99,7 +99,7 @@ public extension Application {
 
         return DependencyOverride {
             log(
-                debug: "🟢 Cancelling Dependency Override \(String(describing: keyPath))",
+                debug: "🟢 Cancelling Dependency Override \(String(describing: keyPath)) ",
                 fileID: fileID,
                 function: function,
                 line: line,
@@ -146,15 +146,17 @@ public extension Application {
         _ line: Int = #line,
         _ column: Int = #column
     ) -> State<Value> {
+        let appState = shared.value(keyPath: keyPath)
+
         log(
-            debug: "🔵 Getting State \(String(describing: keyPath))",
+            debug: "🔵 Getting State \(String(describing: keyPath)) -> \(appState.value)",
             fileID: fileID,
             function: function,
             line: line,
             column: column
         )
 
-        return shared.value(keyPath: keyPath)
+        return appState
     }
 
     /**
@@ -170,15 +172,17 @@ public extension Application {
         _ line: Int = #line,
         _ column: Int = #column
     ) -> StoredState<Value> {
+        let storedState = shared.value(keyPath: keyPath)
+
         log(
-            debug: "🟣 Getting StoredState \(String(describing: keyPath))",
+            debug: "🟣 Getting StoredState \(String(describing: keyPath)) -> \(storedState.value)",
             fileID: fileID,
             function: function,
             line: line,
             column: column
         )
 
-        return shared.value(keyPath: keyPath)
+        return storedState
     }
 
     // MARK: - Instance Methods
@@ -298,4 +302,23 @@ public extension Application {
             scope: Scope(name: feature, id: id)
         )
     }
+
+    /**
+     Retrieves a `UserDefaults` backed state for the provided `id` with a default value of `nil`.
+
+     - Parameters:
+         - feature: The name of the feature to which the state belongs, default is "App".
+         - id: The specific identifier for this state.
+     - Returns: The state of type `Value`.
+     */
+    func storedState<Value>(
+        feature: String = "App",
+        id: String
+    ) -> StoredState<Value?> {
+        storedState(
+            initial: nil,
+            feature: feature,
+            id: id
+        )
+    }
 }
diff --git a/Sources/AppState/Application/Application.swift b/Sources/AppState/Application/Application.swift
@@ -34,15 +34,14 @@ public class Application: ObservableObject {
         line: Int,
         column: Int
     ) {
+        guard isLoggingEnabled else { return }
+
         let excludedFileIDs: [String] = [
             "AppState/Application+StoredState.swift"
         ]
         let isFileIDValue: Bool = excludedFileIDs.contains(fileID.description) == false
 
-        guard 
-            isLoggingEnabled,
-            isFileIDValue
-        else { return }
+        guard isFileIDValue else { return }
 
         let codeID = codeID(fileID: fileID, function: function, line: line, column: column)
 

diff --git a/Sources/AppState/PropertyWrappers/AppState.swift b/Sources/AppState/PropertyWrappers/AppState.swift
@@ -26,6 +26,14 @@ import SwiftUI
             ).value
         }
         nonmutating set {
+            Application.log(
+                debug: "🔵 Setting State \(String(describing: keyPath)) = \(newValue)",
+                fileID: fileID,
+                function: function,
+                line: line,
+                column: column
+            )
+
             var state = app.value(keyPath: keyPath)
             state.value = newValue
         }

diff --git a/Sources/AppState/PropertyWrappers/StoredState.swift b/Sources/AppState/PropertyWrappers/StoredState.swift
@@ -27,6 +27,14 @@ import SwiftUI
             ).value
         }
         nonmutating set {
+            Application.log(
+                debug: "🟣 Setting StoredState \(String(describing: keyPath)) = \(newValue)",
+                fileID: fileID,
+                function: function,
+                line: line,
+                column: column
+            )
+
             var state = app.value(keyPath: keyPath)
             state.value = newValue
         }

diff --git a/Tests/AppStateTests/StoredStateTests.swift b/Tests/AppStateTests/StoredStateTests.swift
@@ -4,7 +4,7 @@ import XCTest
 
 fileprivate extension Application {
     var storedValue: StoredState<Int?> {
-        storedState(initial: nil, id: "storedValue")
+        storedState(id: "storedValue")
     }
 }