Added subscripts

Author: Sam-Spencer

Source/Shared/Configuration/DiskConfig.swift

@@ -1,24 +1,46 @@
 import Foundation
 
 public struct DiskConfig {
-    /// The name of disk storage, this will be used as folder name within directory
+    
+    /// The name of disk storage, this will be used as folder name within directory.
+    ///
     public let name: String
 
-    /// Expiry date that will be applied by default for every added object
-    /// if it's not overridden in the add(key: object: expiry: completion:) method
+    /// Expiry date that will be applied by default for every added object if it's not
+    /// overridden in the add(key: object: expiry: completion:) method.
+    ///
     public let expiry: Expiry
 
-    /// Maximum size of the disk cache storage (in bytes)
+    /// Maximum size of the disk cache storage (in bytes).
+    ///
     public let maxSize: UInt
 
-    /// A folder to store the disk cache contents. Defaults to a prefixed directory in Caches if nil
-    
+    /// A folder to store the disk cache contents. Defaults to a prefixed directory in
+    /// Caches if nil.
+    ///
     public let directory: URL?
+    
     #if os(iOS) || os(tvOS)
-    /// Data protection is used to store files in an encrypted format on disk and to decrypt them on demand.
-    /// Support only on iOS and tvOS.
+    
+    /// Data protection is used to store files in an encrypted format on disk and to
+    /// decrypt them on demand. Support only on iOS and tvOS.
+    ///
     public let protectionType: FileProtectionType?
 
+    /// Create a on disk cache configuration.
+    ///
+    /// - parameter name: The name of disk storage, this will be used as folder name
+    ///     within directory.
+    /// - parameter expiry: Expiry date that will be applied by default for every added
+    ///     object if it's not overridden in the add(key: object: expiry: completion:)
+    ///     method.
+    /// - parameter maxSize: Maximum size of the disk cache storage (in bytes).
+    /// - parameter directory: A folder to store the disk cache contents. Defaults to a
+    ///     prefixed directory in Caches if nil.
+    /// - parameter protectionType: Data protection is used to store files in an
+    ///     encrypted format on disk and to decrypt them on demand. Support only on iOS and
+    ///     tvOS.
+    ///
     public init(name: String, expiry: Expiry = .never,
                 maxSize: UInt = 0, directory: URL? = nil,
                 protectionType: FileProtectionType? = nil) {
@@ -28,14 +50,17 @@ public struct DiskConfig {
         self.directory = directory
         self.protectionType = protectionType
     }
+    
     #else
+    
     public init(name: String, expiry: Expiry = .never,
                 maxSize: UInt = 0, directory: URL? = nil) {
         self.name = name
         self.expiry = expiry
         self.maxSize = maxSize
         self.directory = directory
     }
+    
     #endif
 
 }

Source/Shared/Configuration/MemoryConfig.swift

@@ -2,18 +2,32 @@ import Foundation
 
 public struct MemoryConfig {
 
-    /// Expiry date that will be applied by default for every added object
-    /// if it's not overridden in the add(key: object: expiry: completion:) method
+    /// Expiry date that will be applied by default for every added object if it's not
+    /// overridden in the add(key: object: expiry: completion:) method.
+    ///
     public let expiry: Expiry
 
-    /// The maximum number of objects in memory the cache should hold.
-    /// If 0, there is no count limit. The default value is 0.
+    /// The maximum number of objects in memory the cache should hold. If 0, there is no
+    /// count limit. The default value is 0.
+    ///
     public let countLimit: UInt
 
-    /// The maximum total cost that the cache can hold before it starts evicting objects.
-    /// If 0, there is no total cost limit. The default value is 0
+    /// The maximum total cost that the cache can hold before it starts evicting
+    /// objects. If 0, there is no total cost limit. The default value is 0.
+    ///
     public let totalCostLimit: UInt
 
+    /// Create an in-memory cache configuration.
+    ///
+    /// - parameter expiry: Expiry date that will be applied by default for every added
+    ///     object if it's not overridden in the add(key: object: expiry: completion:)
+    ///     method.
+    /// - parameter countLimit: The maximum number of objects in memory the cache should
+    ///     hold. If 0, there is no count limit. The default value is 0.
+    /// - parameter totalCostLimit: The maximum total cost that the cache can hold
+    ///     before it starts evicting objects. If 0, there is no total cost limit. The
+    ///     default value is 0.
+    ///
     public init(expiry: Expiry = .never, countLimit: UInt = 0, totalCostLimit: UInt = 0) {
         self.expiry = expiry
         self.countLimit = countLimit

Source/Shared/Storage/CacheStorage.swift

@@ -16,6 +16,7 @@ public final class CacheStorage<Key: Hashable, Value> {
     /// - parameters:
     ///   - diskConfig: Configuration for disk storage
     ///   - memoryConfig: Optional. Pass config if you want memory cache
+    ///   - transformer: A custom transformer for stored values
     /// - throws: Throw StorageError if any.
     ///
     public convenience init(diskConfig: DiskConfig, memoryConfig: MemoryConfig, transformer: Transformer<Value>) throws {
@@ -50,30 +51,53 @@ public final class CacheStorage<Key: Hashable, Value> {
 
 extension CacheStorage: StorageAware {
 
+    /// Returns all cached keys
+    ///
     public var allKeys: [Key] {
         self.syncStorage.allKeys
     }
 
+    /// Returns all cached objects
+    ///
     public var allObjects: [Value] {
         self.syncStorage.allObjects
     }
 
+    /// Returns the specified entry for the given key
+    ///
+    /// - parameter key: The key of the cached object.
+    /// - returns: An `Entry` object which has metadata, expiry, and an object.
+    ///
     public func entry(forKey key: Key) throws -> Entry<Value> {
         return try self.syncStorage.entry(forKey: key)
     }
 
+    /// Remove an object from the cache.
+    ///
+    /// - parameter key: The key of the cached object.
+    ///
     public func removeObject(forKey key: Key) throws {
         try self.syncStorage.removeObject(forKey: key)
     }
 
+    /// Add an object to the cache.
+    ///
+    /// - parameter value: The value of the cached object.
+    /// - parameter key: The key of the cached object.
+    /// - parameter expiry: A custom expiration for the object.
+    ///
     public func setObject(_ object: Value, forKey key: Key, expiry: Expiry? = nil) throws {
         try self.syncStorage.setObject(object, forKey: key, expiry: expiry)
     }
 
+    /// Removes all cached objects
+    ///
     public func removeAll() throws {
         try self.syncStorage.removeAll()
     }
 
+    /// Removes all expired cache objects
+    ///
     public func removeExpiredObjects() throws {
         try self.syncStorage.removeExpiredObjects()
     }
@@ -86,6 +110,20 @@ public extension CacheStorage {
         return CacheStorage<Key, U>(hybridStorage: hybridStorage.transform(transformer: transformer))
     }
 
+    subscript(key: Key) -> Value? {
+        get { return try? entry(forKey: key).object }
+        set {
+            guard let value = newValue else {
+                // If nil was assigned using our subscript,
+                // then we remove any value for that key:
+                try? removeObject(forKey: key)
+                return
+            }
+            
+            try? setObject(value, forKey: key)
+        }
+    }
+    
 }
 
 extension CacheStorage: StorageObservationRegistry {