Add missing documentation (#8)

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.3
+// swift-tools-version:5.4
 
 import PackageDescription
 

README.md

@@ -10,7 +10,7 @@ A typed key-value storage solution to store `Codable` types in various persisten
 
 ## Features
 
-- [x] macOS Catalina+, iOS 13+, tvOS 13+, watchOS 6+.
+- [x] macOS Catalina+, iOS 13+, tvOS 13+, watchOS 6+, any Linux supporting Swift 5.4+.
 - [x] Store any `Codable` type.
 - [x] Single API with implementations using User Default, file system, Core Data, Keychain, and fakes for testing.
 - [x] Thread-safe implementations.

Sources/Blueprints/AnyMultiObjectStore.swift

@@ -1,4 +1,4 @@
-/// A type erased `MultiObjectStore`
+/// A type erased `MultiObjectStore`.
 public final class AnyMultiObjectStore<
   Object: Codable & Identifiable
 >: MultiObjectStore {

Sources/Blueprints/AnySingleObjectStore.swift

@@ -1,4 +1,4 @@
-/// A type erased `SingleObjectStore`
+/// A type erased `SingleObjectStore`.
 public final class AnySingleObjectStore<Object: Codable>: SingleObjectStore {
   /// Create any store from a given store.
   /// - Parameter store: store to erase its type.

Sources/Blueprints/MultiObjectStore.swift

@@ -97,7 +97,7 @@ public extension MultiObjectStore {
 public extension MultiObjectStore where Object: Hashable {
   /// Saves a set of objects to store.
   /// - Parameter objects: array of objects to be saved.
-  /// - Throws error: any encoding errors.
+  /// - Throws error: any error that might occur during the save operation.
   func save(_ objects: Set<Object>) throws {
     try save(Array(objects))
   }

Sources/CoreData/MultiCoreDataStore.swift

@@ -41,7 +41,7 @@ public final class MultiCoreDataStore<
 
   /// Saves an object to store.
   /// - Parameter object: object to be saved.
-  /// - Throws error: any encoding errors.
+  /// - Throws error: any error that might occur during the save operation.
   public func save(_ object: Object) throws {
     try sync {
       let data = try encoder.encode(object)
@@ -62,7 +62,7 @@ public final class MultiCoreDataStore<
 
   /// Saves an array of objects to store.
   /// - Parameter objects: array of objects to be saved.
-  /// - Throws error: any encoding errors.
+  /// - Throws error: any error that might occur during the save operation.
   public func save(_ objects: [Object]) throws {
     try sync {
       let pairs = try objects.map { object -> (key: String, data: Data) in

Sources/FileSystem/MultiFileSystemStore.swift

@@ -46,7 +46,7 @@ public final class MultiFileSystemStore<
 
   /// Saves an object to store.
   /// - Parameter object: object to be saved.
-  /// - Throws error: any encoding errors.
+  /// - Throws error: any error that might occur during the save operation.
   public func save(_ object: Object) throws {
     try sync {
       _ = try storeURL().path
@@ -58,7 +58,7 @@ public final class MultiFileSystemStore<
 
   /// Saves an array of objects to store.
   /// - Parameter objects: array of objects to be saved.
-  /// - Throws error: any encoding errors.
+  /// - Throws error: any error that might occur during the save operation.
   public func save(_ objects: [Object]) throws {
     try sync {
       let pairs = try objects.map { object -> (url: URL, data: Data) in

Sources/FileSystem/SingleFileSystemStore.swift

@@ -44,7 +44,7 @@ public final class SingleFileSystemStore<Object: Codable>: SingleObjectStore {
 
   /// Saves an object to store.
   /// - Parameter object: object to be saved.
-  /// - Throws error: any encoding errors.
+  /// - Throws error: any error that might occur during the save operation.
   public func save(_ object: Object) throws {
     try sync {
       let data = try encoder.encode(object)

Sources/Keychain/MultiKeychainStore.swift

@@ -48,7 +48,7 @@ public final class MultiKeychainStore<
 
   /// Saves an object to store.
   /// - Parameter object: object to be saved.
-  /// - Throws error: any encoding errors.
+  /// - Throws error: any error that might occur during the save operation.
   public func save(_ object: Object) throws {
     try sync {
       let data = try encoder.encode(object)
@@ -58,7 +58,7 @@ public final class MultiKeychainStore<
 
   /// Saves an array of objects to store.
   /// - Parameter objects: array of objects to be saved.
-  /// - Throws error: any encoding errors.
+  /// - Throws error: any error that might occur during the save operation.
   public func save(_ objects: [Object]) throws {
     try sync {
       let pairs = try objects.map { (try encoder.encode($0), $0.id) }
@@ -67,6 +67,9 @@ public final class MultiKeychainStore<
   }
 
   /// The number of all objects stored in store.
+  ///
+  /// > Note: Errors thrown while performing the security query will be ignored and logged out to console
+  /// in DEBUG.
   public var objectsCount: Int {
     let query = generateQuery {
       $0[kSecMatchLimit] = kSecMatchLimitAll
@@ -90,6 +93,10 @@ public final class MultiKeychainStore<
   }
 
   /// Wether the store contains a saved object with the given id.
+  ///
+  /// > Note: Errors thrown while performing the security query will be ignored and logged out to console
+  /// in DEBUG.
+  ///
   /// - Parameter id: object id.
   /// - Returns: true if store contains an object with the given id.
   public func containsObject(withId id: Object.ID) -> Bool {
@@ -109,6 +116,10 @@ public final class MultiKeychainStore<
   }
 
   /// Returns an object for the given id, or `nil` if no object is found.
+  ///
+  /// > Note: Errors thrown while performing the security query will be ignored and logged out to console
+  /// in DEBUG.
+  ///
   /// - Parameter id: object id.
   /// - Returns: object with the given id, or`nil` if no object with the given id is found.
   public func object(withId id: Object.ID) -> Object? {
@@ -131,6 +142,10 @@ public final class MultiKeychainStore<
   }
 
   /// Returns all objects in the store.
+  ///
+  /// > Note: Errors thrown while performing the security query will be ignored and logged out to console
+  /// in DEBUG.
+  ///
   /// - Returns: collection containing all objects stored in store.
   public func allObjects() -> [Object] {
     let query = generateQuery {

Sources/Keychain/SingleKeychainStore.swift

@@ -47,15 +47,19 @@ public final class SingleKeychainStore<Object: Codable>: SingleObjectStore {
 
   /// Saves an object to store.
   /// - Parameter object: object to be saved.
-  /// - Throws error: any encoding errors.
+  /// - Throws error: any error that might occur during the save operation.
   public func save(_ object: Object) throws {
     try sync {
       let data = try encoder.encode(object)
       try addOrUpdate(data)
     }
   }
 
-  /// Returns the object saved in the store
+  /// Returns the object saved in the store.
+  ///
+  /// > Note: Errors thrown while performing the security query will be ignored and logged out to console
+  /// in DEBUG.
+  ///
   /// - Returns: object saved in the store. `nil` if no object is saved in store.
   public func object() -> Object? {
     let query = generateQuery {

Sources/UserDefaults/MultiUserDefaultsStore.swift

@@ -47,7 +47,7 @@ public final class MultiUserDefaultsStore<
 
   /// Saves an object to store.
   /// - Parameter object: object to be saved.
-  /// - Throws error: any encoding errors.
+  /// - Throws error: any error that might occur during the save operation.
   public func save(_ object: Object) throws {
     try sync {
       let data = try encoder.encode(object)
@@ -61,7 +61,7 @@ public final class MultiUserDefaultsStore<
 
   /// Saves an array of objects to store.
   /// - Parameter objects: array of objects to be saved.
-  /// - Throws error: any encoding errors.
+  /// - Throws error: any error that might occur during the save operation.
   public func save(_ objects: [Object]) throws {
     try sync {
       let pairs = try objects.map { object -> (key: String, data: Data) in

Sources/UserDefaults/SingleUserDefaultsStore.swift

@@ -46,7 +46,7 @@ public final class SingleUserDefaultsStore<Object: Codable>: SingleObjectStore {
 
   /// Saves an object to store.
   /// - Parameter object: object to be saved.
-  /// - Throws error: any encoding errors.
+  /// - Throws error: any error that might occur during the save operation.
   public func save(_ object: Object) throws {
     try sync {
       let data = try encoder.encode(object)

Tests/Utils/MultiObjectStoreFake.swift

@@ -25,7 +25,7 @@ public final class MultiObjectStoreFake<
 
   /// Saves an object to store.
   /// - Parameter object: object to be saved.
-  /// - Throws error: any encoding errors.
+  /// - Throws error: any error that might occur during the save operation.
   public func save(_ object: Object) throws {
     if let error = error {
       throw error
@@ -58,12 +58,20 @@ public final class MultiObjectStoreFake<
 
   /// Removes object with the given id —if found—.
   /// - Parameter id: id for the object to be deleted.
-  public func remove(withId id: Object.ID) {
+  /// - Throws error: any error that might occur during the removal operation.
+  public func remove(withId id: Object.ID) throws {
+    if let error = error {
+      throw error
+    }
     dictionary[id] = nil
   }
 
   /// Removes all objects in store.
-  public func removeAll() {
+  /// - Throws error: any error that might occur during the removal operation.
+  public func removeAll() throws {
+    if let error = error {
+      throw error
+    }
     dictionary = [:]
   }
 }

Tests/Utils/SingleObjectStoreFake.swift

@@ -26,8 +26,11 @@ public final class SingleObjectStoreFake<Object: Codable>: SingleObjectStore {
 
   /// Saves an object to store.
   /// - Parameter object: object to be saved.
-  /// - Throws error: any encoding errors.
+  /// - Throws error: any error that might occur during the save operation.
   public func save(_ object: Object) throws {
+    if let error = error {
+      throw error
+    }
     underlyingObject = object
   }
 
@@ -38,7 +41,11 @@ public final class SingleObjectStoreFake<Object: Codable>: SingleObjectStore {
   }
 
   /// Removes any saved object in the store.
-  public func remove() {
+  /// - Throws error: any error that might occur during the removal operation.
+  public func remove() throws {
+    if let error = error {
+      throw error
+    }
     underlyingObject = nil
   }
 }