Added date encoding support for clients that may need to use a different formatting than ISO. (#53)

* Added the ability to customize encoding and decoding dates when parking or retrieving Codable objects.

* Split out SwiftCodableTests into separate files to significantly reduce file size.

Author: mrlegowatch

Sources/GarageStorage/Garage+Codable.swift

@@ -47,7 +47,7 @@ extension Garage {
 
         let decoder = JSONDecoder()
         decoder.userInfo[.garage] = self
-        decoder.dateDecodingStrategy = .custom(decodeTransformableDate)
+        decoder.dateDecodingStrategy = self.dateDecodingStrategy
 
         return try decoder.decode(T.self, from: data)
     }
@@ -57,7 +57,7 @@ extension Garage {
     internal func encodeData<T: Encodable>(_ object: T) throws -> String {
         let encoder = JSONEncoder()
         encoder.userInfo[.garage] = self
-        encoder.dateEncodingStrategy = .formatted(Date.isoFormatter)
+        encoder.dateEncodingStrategy = self.dateEncodingStrategy
         let data = try encoder.encode(object)
 
         return try encrypt(data)

Sources/GarageStorage/Garage+Migratable.swift

@@ -28,8 +28,9 @@ internal func decodeTransformableDate(_ decoder: Decoder) throws -> Date {
 
     // Swift Codable encodes the date as a string directly
     // Objective-C MappableObject encodes a dictionary of transformable type
-    if let string = try? container.decode(String.self) {
-        date = Date.isoDate(for: string)!
+    if let string = try? container.decode(String.self),
+       let isoDate = Date.isoDate(for: string) {
+        date = isoDate
     } else if let transformableDate = try? container.decode(__TransformableDateObjC.self) {
         date = transformableDate.date
     } else {

Sources/GarageStorage/Garage.swift

@@ -33,10 +33,22 @@ public class Garage: NSObject {
 
     /// Autosave is set to true by default, for every operation that causes a change to the underlying Core Data Managed Object Context.
     ///
-    /// When set to true, the garage will be saved after any operation that causes a change to the underlying Core Data Managed Object Context, including `park()`, `setSyncStatus()`, and `delete()`. When set to false, `save()` must be called instead, in order to persist those changes. You might want to set this to false to perform batch changes to many objects before saving them all, to optimize performance.
+    /// When set to true, the garage will be saved after any operation that causes a change to the underlying Core Data Managed Object Context, including `park()`, `setSyncStatus()`, and `delete()`. When set to false, `save()` must be called instead, in order to persist those changes. You might want to use `withAutosaveDisabled(:)` to set this to false, in order to perform batch changes to many objects before saving them all, optimizing performance.
     @objc(autosaveEnabled)
     public var isAutosaveEnabled = true
 
+    /// The date decoding strategy used by JSONDecoder when decoding objects.
+    ///
+    /// By default, this is set to a custom strategy that uses an internal `decodeTransformableDate` function that uses `Date.isoFormatter `for Codable objects or a wrapper conversion check for backward compatibility with Objective-C `MappableObject`.
+    /// You can modify this to use a different date decoding strategy by wrapping a `retrieve()` call `withDateDecodingStrategy() { }`.
+    public private(set) var dateDecodingStrategy: JSONDecoder.DateDecodingStrategy = .custom(decodeTransformableDate)
+    
+    /// The date encoding strategy used by JSONEncoder when encoding objects.
+    ///
+    /// By default, this is set to use ISO 8601 formatted dates via `Date.isoFormatter`.
+    /// You can modify this to use a different date encoding strategy by wrapping a `park()` call using `withDateEncodingStrategy() { }`.
+    public private(set) var dateEncodingStrategy: JSONEncoder.DateEncodingStrategy = .formatted(Date.isoFormatter)
+    
     /// The domain for errors generated by GarageStorage.
     @objc
     public static let errorDomain = "GSErrorDomain"
@@ -157,6 +169,52 @@ public class Garage: NSObject {
         }
         return try closure()
     }
+    
+    /// Temporarily changes the date decoding strategy while executing the provided closure, then restores the previous strategy.
+    ///
+    /// This is useful when you need to retrieve objects that were encoded with a different date strategy, or when you need to temporarily use a different decoding strategy. The previous strategy is automatically restored even if the closure throws an error.
+    ///
+    /// - parameter strategy: The temporary date decoding strategy to use.
+    /// - parameter closure: A closure to execute with the temporary date decoding strategy. If the closure throws, the error is propagated after restoring the previous strategy.
+    /// - throws: Rethrows any error thrown by the closure.
+    ///
+    /// Example usage:
+    /// ```swift
+    /// let person = try garage.withDateDecodingStrategy(.iso8601) {
+    ///     try garage.retrieve(Person.self, identifier: "123")
+    /// }
+    /// ```
+    public func withDateDecodingStrategy<Result>(_ strategy: JSONDecoder.DateDecodingStrategy, _ closure: () throws -> Result) rethrows -> Result {
+        let previousStrategy = dateDecodingStrategy
+        dateDecodingStrategy = strategy
+        defer {
+            dateDecodingStrategy = previousStrategy
+        }
+        return try closure()
+    }
+    
+    /// Temporarily changes the date encoding strategy while executing the provided closure, then restores the previous strategy.
+    ///
+    /// This is useful when you need to park objects with a different date encoding strategy, or when you need to temporarily use a different encoding strategy. The previous strategy is automatically restored even if the closure throws an error.
+    ///
+    /// - parameter strategy: The temporary date encoding strategy to use.
+    /// - parameter closure: A closure to execute with the temporary date encoding strategy. If the closure throws, the error is propagated after restoring the previous strategy.
+    /// - throws: Rethrows any error thrown by the closure.
+    ///
+    /// Example usage:
+    /// ```swift
+    /// try garage.withDateEncodingStrategy(.iso8601) {
+    ///     try garage.park(person)
+    /// }
+    /// ```
+    public func withDateEncodingStrategy<Result>(_ strategy: JSONEncoder.DateEncodingStrategy, _ closure: () throws -> Result) rethrows -> Result {
+        let previousStrategy = dateEncodingStrategy
+        dateEncodingStrategy = strategy
+        defer {
+            dateEncodingStrategy = previousStrategy
+        }
+        return try closure()
+    }
 
     /// Encrypts the data using the dataEncryptionDelegate, if specified, otherwise converts the data to a plain string.
     internal func encrypt(_ data: Data) throws -> String {

Tests/GarageStorageTests/RawStorageTests.swift

@@ -31,7 +31,5 @@ struct RawStorageTests {
             // we want to catch the error, and verify it
             #expect(error.localizedDescription.contains("failed to retrieve gs_data"))
         }
-        
     }
-
 }

Tests/GarageStorageTests/SwiftCodableTests.swift

@@ -8,7 +8,7 @@
 
 import Testing
 import GarageStorage
-import CoreData
+import Foundation
 
 // This set of tests checks Codable (hence "Swift-y") types.
 @Suite("Swift Codable Tests")
@@ -38,7 +38,7 @@ struct SwiftCodableTests {
         #expect(retrievedSam.siblings.count == 2, "expected 2 siblings")
     }
 
-    @Test("Mappable non-string identifiers work correctly")
+    @Test("Mappable with Identifiable non-string identifiers work correctly")
     func mappableNonString() throws {
         let garage = makeTestGarage()
 
@@ -157,133 +157,6 @@ struct SwiftCodableTests {
         #expect(addresses[0].city == "Boston", "all addresses should be based in Boston")
     }
 
-    @Test("Deleting all objects from garage")
-    func deletingAllObjects() throws {
-        let garage = makeTestGarage()
-
-        // Park heterogeneous objects
-        let sam = swiftPerson()
-        let nick = swiftPerson2()
-        let emily = swiftPerson3()
-        
-        let oldAddress = swiftAddress()
-        let newAddress = swiftAddress2()
-        try garage.parkAll([nick, emily, sam])
-        try garage.parkAll([oldAddress, newAddress])
-        
-        // Delete everything
-        garage.deleteAllObjects()
-        
-        // Confirm that there are no persons
-        let persons = try garage.retrieveAll(SwiftPerson.self)
-        #expect(persons.count == 0, "Should not be any Persons")
-        
-        let addresses = try garage.retrieveAll(SwiftAddress.self)
-        #expect(addresses.count == 0, "Should not be any Addresses")
-        
-        // Delete everything again (hits the no-op case, for code coverage)
-        garage.deleteAll(SwiftPerson.self)
-        garage.deleteAllObjects()
-    }
-
-    @Test("Managing sync status of objects")
-    func syncStatus() throws {
-        let garage = makeTestGarage()
-        
-        let sam = swiftPerson()
-        let nick = swiftPerson2()
-        let emily = swiftPerson3()
-        
-        let oldAddress = swiftAddress()
-        let newAddress = swiftAddress2()
-        
-        let pet = swiftPet()
-        
-        // Park heterogeneous objects
-        try garage.parkAll([nick, emily, sam])
-        try garage.parkAll([oldAddress, newAddress])
-        try garage.parkAll([pet])
-        
-        // Validate sync status of Persons
-        // WARNING: This will succeed by accident, because there is only one object of type SwiftPerson syncing,
-        // but if there was another object of a different type syncing, then this would fail.
-        // Use retrieveAll(_ objectClass: T, withStatus: SyncStatus) instead to focus on the specific type.
-        let syncing: [SwiftPerson] = try garage.retrieveAll(withStatus: .syncing)
-        
-        #expect(syncing.count == 1, "1 item should be syncing")
-        
-        // TODO: heterogeneous Codable subtype arrays
-        //let undetermined: [?] = try garage.retrieveAll(withStatus: .undetermined)
-        //#expect(undetermined.count == 4, "4 items should be undetermined")
-        
-        // This will throw because there are different types of objects not synced.
-        // Don't use retrieveAll without an objectClass if you work with heterogeneous objects that may have the same sync status.
-        // let notSynced: [SwiftPerson] = try garage.retrieveAll(withStatus: .notSynced))
-        
-        // This is the correct way to fetch all of a specific type that are not synced
-        let notSynced: [SwiftPerson] = try garage.retrieveAll(SwiftPerson.self, withStatus: .notSynced)
-        #expect(notSynced.count == 0, "no items should be not synced")
-        
-        // Change Sam's sync status and validate that it changed
-        try garage.setSyncStatus(.notSynced, for: sam)
-        
-        // Add in an unrelated object type, to ensure that retrieveAll below works on just one type
-        try garage.setSyncStatus(.notSynced, for: pet)
-        
-        let syncingAfterChange: [SwiftPerson] = try garage.retrieveAll(SwiftPerson.self, withStatus: .syncing)
-        #expect(syncingAfterChange.count == 0, "no items should be syncing")
-        
-        let notSyncedAfterChange: [SwiftPerson] = try garage.retrieveAll(SwiftPerson.self, withStatus: .notSynced)
-        #expect(notSyncedAfterChange.count == 1, "1 item should be not synced")
-        
-        // Test setting sync status for a collection
-        try garage.setSyncStatus(.undetermined, for: [nick, sam])
-        let nickStatus = try garage.syncStatus(for: nick)
-        #expect(nickStatus == .undetermined, "Nick should have undetermined sync status")
-    }
-    
-    @Test("Setting sync status for unparked object throws error")
-    func invalidSyncStatus() throws {
-        let garage = makeTestGarage()
-        
-        // Create, but don't park, sam
-        let sam = swiftPerson()
-        
-        // Verify that setting sync status on an unparked object throws an error
-        #expect(throws: Error.self) {
-            try garage.setSyncStatus(.notSynced, for: sam)
-        }
-        
-        #expect(throws: Error.self) {
-            try garage.setSyncStatus(.notSynced, for: [sam])
-        }
-    }
-    
-    @Test("Date encoding and decoding")
-    func dates() throws {
-        let garage = makeTestGarage()
-
-        let sam = swiftPerson()
-        
-        // Set sam's birthdate to 1950/01/01 04:00:00
-        let timeZone = TestSetup.timeZone
-        var dateComponents = DateComponents()
-        dateComponents.day = 1
-        dateComponents.month = 1
-        dateComponents.year = 1950
-        dateComponents.timeZone = timeZone
-        
-        var calendar = Calendar.current
-        calendar.timeZone = timeZone
-        sam.birthdate = calendar.date(from: dateComponents)!
-        #expect(sam.birthdate.timeIntervalSinceReferenceDate == -1609459200.0, "Making assumption about the test")
-        
-        try garage.park(sam)
-        
-        let retrievedSam = try #require(try garage.retrieve(SwiftPerson.self, identifier: "Sam"))
-        #expect(retrievedSam.birthdate.timeIntervalSinceReferenceDate == -1609459200.0, "Reconstituted date failed")
-    }
-    
     @Test("Identifiable references are preserved")
     func identifiableReferences() throws {
         let garage = makeTestGarage()
@@ -334,10 +207,6 @@ struct SwiftCodableTests {
         let sam = swiftPerson()
         let data = try encoder.encode(sam)
 
-        // For debugging:
-        //let string = String(data: data, encoding: .utf8)!
-        //print(string)
-        
         let decoder = JSONDecoder()
         let decodedSam = try decoder.decode(SwiftPerson.self, from: data)
         #expect(decodedSam.name == "Sam", "name")
@@ -358,65 +227,13 @@ struct SwiftCodableTests {
 
         let data = try encoder.encode(child)
 
-        // For debugging:
-        //let string = String(data: data, encoding: .utf8)!
-        //print(string)
-        
         let decoder = JSONDecoder()
         let decodedChild = try decoder.decode(SwiftPersonWithParent.self, from: data)
         #expect(decodedChild.name == "Child", "child name")
         #expect(decodedChild.parent.name == "Nick", "parent name")
         #expect(decodedChild.parent.age == 26, "parent age")
     }
 
-    @Test("Autosave disabled requires manual save")
-    func autosaveDisabled() throws {
-        let garage = makeTestGarage()
-        
-        // Verify autosave is enabled by default
-        #expect(garage.isAutosaveEnabled == true, "Autosave should be enabled by default")
-        
-        // Create and park people using withAutosaveDisabled
-        try garage.withAutosaveDisabled {
-            let nick = swiftPerson2()
-            let emily = swiftPerson3()
-            try garage.park(nick)
-            try garage.park(emily)
-        }
-        
-        // Verify autosave is re-enabled after the closure
-        #expect(garage.isAutosaveEnabled == true, "Autosave should be re-enabled after closure")
-        
-        // Now manually save the garage
-        garage.save()
-        
-        // Retrieve the objects to verify they were saved
-        let retrievedNick = try? garage.retrieve(SwiftPerson.self, identifier: "Nick")
-        #expect(retrievedNick != nil, "Object should be retrievable after manual save")
-        #expect(retrievedNick?.name == "Nick", "Retrieved object should have correct name")
-        
-        let retrievedEmily = try? garage.retrieve(SwiftPerson.self, identifier: "Emily")
-        #expect(retrievedEmily != nil, "Emily should be retrievable after manual save")
-        #expect(retrievedEmily?.name == "Emily", "Retrieved Emily should have correct name")
-    }
-
-    @Test("Convenience initializer creates garage with named store")
-    func convenienceInitializer() throws {
-        // Use the convenience initializer that creates a garage with a named store
-        let garage = makeTestGarage()
-        
-        // Verify the garage is functional by parking and retrieving an object
-        let sam = swiftPerson()
-        try garage.park(sam)
-        
-        let retrievedSam = try #require(try garage.retrieve(SwiftPerson.self, identifier: "Sam"))
-        #expect(retrievedSam.name == "Sam", "Expected Sam to be Sam")
-        #expect(retrievedSam.importantDates.count == 3, "Expected 3 important dates")
-        
-        // Clean up
-        garage.deleteAllObjects()
-    }
-
     @Test("Hashable park and delete")
     func hashableParkAndDelete() throws {
         let garage = makeTestGarage()