Extend storage aware protocol

Added check function for expired object by key

Author: Lug4rd

Source/Shared/Storage/StorageAware.swift

@@ -45,6 +45,12 @@ public protocol StorageAware {
    Clears all expired objects.
    */
   func removeExpiredObjects() throws
+  
+  /**
+   Check if an expired object by the given key.
+   - Parameter key: Unique key to identify the object.
+  */
+  func isExpiredObject<T: Codable>(ofType type: T.Type, forKey key: String) throws -> Bool
 }
 
 public extension StorageAware {
@@ -60,4 +66,13 @@ public extension StorageAware {
       return false
     }
   }
+  
+  func isExpiredObject<T: Codable>(ofType type: T.Type, forKey key: String) throws -> Bool {
+    do {
+      let entry = try self.entry(ofType: type, forKey: key)
+      return entry.expiry.isExpired
+    } catch {
+      return true
+    }
+  }
 }

Tests/iOS/Tests/Storage/DiskStorageTests.swift

@@ -129,6 +129,14 @@ final class DiskStorageTests: XCTestCase {
     let cachedObject: User? = try storage.object(ofType: User.self, forKey: key)
     XCTAssertNotNil(cachedObject)
   }
+  
+  /// Test expired object
+  func testExpiredObject() throws {
+    try storage.setObject(testObject, forKey: key, expiry: .seconds(0.9))
+    XCTAssertFalse(try! storage.isExpiredObject(ofType: User.self, forKey: key))
+    sleep(1)
+    XCTAssertTrue(try! storage.isExpiredObject(ofType: User.self, forKey: key))
+  }
 
   /// Test that it clears cache directory
   func testClear() throws {

Tests/iOS/Tests/Storage/MemoryStorageTests.swift

@@ -81,6 +81,14 @@ final class MemoryStorageTests: XCTestCase {
 
     XCTAssertNotNil(cachedObject)
   }
+  
+  /// Test expired object
+  func testExpiredObject() throws {
+    storage.setObject(testObject, forKey: key, expiry: .seconds(0.9))
+    XCTAssertFalse(try! storage.isExpiredObject(ofType: User.self, forKey: key))
+    sleep(1)
+    XCTAssertTrue(try! storage.isExpiredObject(ofType: User.self, forKey: key))
+  }
 
   /// Test that it clears cache directory
   func testRemoveAll() {