feature(SabyApplePreference): add item version feature

ab180 · May 24, 2024 · 4caff72 · 4caff72
1 parent 5e033af
commit 4caff72
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 22 deletions.
diff --git a/Source/ApplePreference/Implement/FileValuePreference.swift b/Source/ApplePreference/Implement/FileValuePreference.swift
@@ -10,6 +10,8 @@ import SabySafe
 import SabyConcurrency
 import SabyJSON
 
+private let STORAGE_VERSION = "Version1"
+
 public final class FileValuePreference<Value: Codable>: ValuePreference {
     typealias Context = FileValuePreferenceContext
 
@@ -20,11 +22,11 @@ public final class FileValuePreference<Value: Codable>: ValuePreference {
 
     let encoder = JSONEncoder.acceptingNonConfirmingFloat()
 
-    public init(directoryURL: URL, fileName: String, migration: @escaping () throws -> Void) {
+    public init(directoryURL: URL, storageName: String, migration: @escaping () throws -> Void) {
         self.contextLoad = {
             try Context.load(
                 directoryURL: directoryURL,
-                fileName: fileName,
+                storageName: storageName,
                 migration: migration
             )
         }
@@ -80,16 +82,16 @@ extension FileValuePreference {
 
 struct FileValuePreferenceContext<Value: Codable> {
     let url: URL
-    let value: Atomic<Value?>
+    let value: Atomic<FileValuePreferenceItemVersion1<Value>?>
 
-    private init(url: URL, value: Atomic<Value?>) {
+    private init(url: URL, value: Atomic<FileValuePreferenceItemVersion1<Value>?>) {
         self.url = url
         self.value = value
     }
 
     static func load(
         directoryURL: URL,
-        fileName: String,
+        storageName: String,
         migration: () throws -> Void
     ) throws -> FileValuePreferenceContext {
         try migration()
@@ -108,7 +110,7 @@ struct FileValuePreferenceContext<Value: Codable> {
             )
         }
 
-        let url = directoryURL.appendingPathComponent(fileName)
+        let url = directoryURL.appendingPathComponent(storageName).appendingPathExtension(STORAGE_VERSION)
         if !fileManager.fileExists(atPath: url.path) {
             return FileValuePreferenceContext(
                 url: url,
@@ -119,7 +121,7 @@ struct FileValuePreferenceContext<Value: Codable> {
         guard
             let data = try? Data(contentsOf: url),
             let value = try? decoder.decode(
-                Value?.self,
+                FileValuePreferenceItemVersion1<Value>?.self,
                 from: data
             )
         else {
@@ -135,3 +137,6 @@ struct FileValuePreferenceContext<Value: Codable> {
         )
     }
 }
+
+// Must not be modified. Write new ItemVersion and write migration logic instead.
+typealias FileValuePreferenceItemVersion1<Value: Codable> = Value
diff --git a/Source/ApplePreference/Preference.swift b/Source/ApplePreference/Preference.swift
@@ -8,17 +8,17 @@
 import Foundation
 
 public protocol Preference {
-    /// ``init(directoryURL:fileName:migration:)``
+    /// ``init(directoryURL:storageName:migration:)``
     /// execute migration and then create or load preference from
-    /// `{Directory url}/{File name}` path.
-    init(directoryURL: URL, fileName: String, migration: @escaping () throws -> Void)
+    /// `{Directory url}/{Storage name}/{Version name}` path.
+    init(directoryURL: URL, storageName: String, migration: @escaping () throws -> Void)
 }
 
 extension Preference {
-    /// ``init(directoryName:fileName:)`` create or load storage from
-    /// `{Directory url}/{File name}` path.
-    public init(directoryURL: URL, fileName: String) {
-        self.init(directoryURL: directoryURL, fileName: fileName, migration: {})
+    /// ``init(directoryName:storageName:)`` create or load storage from
+    /// `{Directory url}/{Storage name}/{Version name}` path.
+    public init(directoryURL: URL, storageName: String) {
+        self.init(directoryURL: directoryURL, storageName: storageName, migration: {})
     }
 }
 

diff --git a/Source/AppleStorage/Implement/CoreDataArrayStorage.swift b/Source/AppleStorage/Implement/CoreDataArrayStorage.swift
@@ -382,7 +382,7 @@ public enum CoreDataArrayStorageError: Error {
     case requestResultNotFound
 }
 
-// Must not be modified. Write ItemVersion2 and write migration logic instead.
+// Must not be modified. Write new ItemVersion and write migration logic instead.
 @objc(SabyCoreDataArrayStorageItemVersion1)
 final class SabyCoreDataArrayStorageItemVersion1: NSManagedObject {
     @NSManaged var key: UUID

diff --git a/Source/AppleStorage/Implement/FileArrayStorage.swift b/Source/AppleStorage/Implement/FileArrayStorage.swift
@@ -256,7 +256,7 @@ public enum FileArrayStorageError: Error {
     case libraryDirectoryNotFound
 }
 
-// Must not be modified. Write ItemVersion2 and write migration logic instead.
+// Must not be modified. Write new ItemVersion and write migration logic instead.
 struct FileArrayStorageItemVersion1<Value: Codable>: Codable {
     let key: UUID
     let value: Value

diff --git a/Source/AppleStorage/Implement/FileDictionaryStorage.swift b/Source/AppleStorage/Implement/FileDictionaryStorage.swift
@@ -165,5 +165,5 @@ struct FileDictionaryStorageContext<Key: Hashable & Codable, Value: Codable> {
     }
 }
 
-// Must not be modified. Write ItemVersion2 and write migration logic instead.
+// Must not be modified. Write new ItemVersion and write migration logic instead.
 typealias FileDictionaryStorageItemVersion1<Key: Hashable & Codable, Value: Codable> = [Key: Value]
diff --git a/Source/AppleStorage/Implement/FileValueStorage.swift b/Source/AppleStorage/Implement/FileValueStorage.swift
@@ -149,5 +149,5 @@ struct FileValueStorageContext<Value: Codable> {
     }
 }
 
-// Must not be modified. Write ItemVersion2 and write migration logic instead.
+// Must not be modified. Write new ItemVersion and write migration logic instead.
 typealias FileValueStorageItemVersion1<Value: Codable> = Value
diff --git a/Test/ApplePreference/FileValuePreferenceTest.swift b/Test/ApplePreference/FileValuePreferenceTest.swift
@@ -17,7 +17,7 @@ final class FileValuePreferenceTest: XCTestCase {
     fileprivate let testCount = 500
     fileprivate var preference: FileValuePreference<DummyItem>!
     fileprivate let directoryURL = FileManager.default.temporaryDirectory
-    fileprivate var fileName: String!
+    fileprivate var storageName: String!
 
     fileprivate var testObjects: [DummyItem] {
         var result: [DummyItem] = []
@@ -29,15 +29,15 @@ final class FileValuePreferenceTest: XCTestCase {
     }
 
     override func setUpWithError() throws {
-        fileName = UUID().uuidString
+        storageName = UUID().uuidString
         preference = FileValuePreference<DummyItem>(
             directoryURL: directoryURL,
-            fileName: fileName
+            storageName: storageName
         )
     }
 
     override func tearDownWithError() throws {
-        let fileURL = directoryURL.appendingPathComponent(fileName)
+        let fileURL = directoryURL.appendingPathComponent(storageName)
 
         if FileManager.default.fileExists(atPath: fileURL.absoluteString) {
             try FileManager.default.removeItem(at: fileURL)