Merge pull request #4 from Lickability/fix/persister-expiration-policy

Expiration Policy update

Sources/Persister/Cache.swift

@@ -24,6 +24,13 @@ public protocol Cache {
     ///   - key: The key that can be used to recall the written item later.
     func write<Item: Codable>(item: Item, forKey key: String) throws
 
+    /// Writes an item to cache, providing an expiration policy.
+    /// - Parameters:
+    ///   - item: The item to write to the cache.
+    ///   - key: The key that can be used to recall the written item later.
+    ///   - expirationPolicy: Determines when newly written items are considered expired.
+    func write<Item: Codable>(item: Item, forKey key: String, expirationPolicy: CacheExpirationPolicy) throws
+
     /// Removes an item associated with the given `key`.
     /// - Parameter key: The key associated with the item when it was written.
     func remove(forKey key: String) throws

Sources/Persister/DiskCache.swift

@@ -43,6 +43,10 @@ extension DiskCache: Cache {
     // MARK: - Cache
 
     public func write<Item: Codable>(item: Item, forKey key: String) throws {
+        try write(item: item, forKey: key, expirationPolicy: expirationPolicy)
+    }
+
+    public func write<Item: Codable>(item: Item, forKey key: String, expirationPolicy: CacheExpirationPolicy) throws {
         try diskManager.createDirectoryIfNecessary(directoryURL: rootDirectoryURL)
 
         let filePath = persistencePath(forKey: key)

Sources/Persister/MemoryCache.swift

@@ -38,6 +38,10 @@ extension MemoryCache: Cache {
     }
 
     public func write<Item: Codable>(item: Item, forKey key: String) throws {
+        try write(item: item, forKey: key, expirationPolicy: expirationPolicy)
+    }
+
+    public func write<Item>(item: Item, forKey key: String, expirationPolicy: CacheExpirationPolicy) throws where Item : Decodable, Item : Encodable {
         let expirationDate = expirationPolicy.expirationDate(from: Date())
         let container = ItemContainer(item: item, expirationDate: expirationDate)
 

Sources/Persister/Persister.swift

@@ -48,6 +48,11 @@ extension Persister: Cache {
         try diskCache.write(item: item, forKey: key)
     }
 
+    public func write<Item: Codable>(item: Item, forKey key: String, expirationPolicy: CacheExpirationPolicy) throws {
+        try memoryCache.write(item: item, forKey: key, expirationPolicy: expirationPolicy)
+        try diskCache.write(item: item, forKey: key, expirationPolicy: expirationPolicy)
+    }
+
     public func remove(forKey key: String) throws {
         try memoryCache.remove(forKey: key)
         try diskCache.remove(forKey: key)

Tests/DiskCacheTests.swift

@@ -91,4 +91,23 @@ final class DiskCacheTests: XCTestCase {
             }
         }
     }
+
+    func testUsesCorrectExpirationPolicy() throws {
+        let expectation = XCTestExpectation(description: "Only one item should have been removed.")
+
+        let cache = DiskCache(rootDirectoryURL: diskURL, expirationPolicy: .afterInterval(1))
+        try cache.write(item: TestCodable(), forKey: itemKey, expirationPolicy: .afterInterval(500))
+
+        DispatchQueue.main.asyncAfter(deadline: .now() + 2) {
+
+            try? cache.removeExpired()
+
+            let item1: ItemContainer<TestCodable>? = try? cache.read(forKey: self.itemKey)
+
+            XCTAssertNotNil(item1)
+
+            expectation.fulfill()
+        }
+        wait(for: [expectation], timeout: 5)
+    }
 }

Tests/MemoryCacheTests.swift

@@ -90,4 +90,23 @@ final class MemoryCacheTests: XCTestCase {
         XCTAssertNotNil(item3)
         XCTAssertNotNil(item4)
     }
+
+    func testUsesCorrectExpirationPolicy() throws {
+        let expectation = XCTestExpectation(description: "Only one item should have been removed.")
+
+        let cache = MemoryCache(capacity: .unlimited, expirationPolicy: .afterInterval(1))
+        try cache.write(item: TestCodable(), forKey: itemKey, expirationPolicy: .afterInterval(500))
+
+        DispatchQueue.main.asyncAfter(deadline: .now() + 2) {
+
+            try? cache.removeExpired()
+
+            let item1: ItemContainer<TestCodable>? = try? cache.read(forKey: self.itemKey)
+
+            XCTAssertNotNil(item1)
+
+            expectation.fulfill()
+        }
+        wait(for: [expectation], timeout: 5)
+    }
 }