Merge pull request onevcat#456 from DangerCove/default-file-extension

Add option to supply default path extension
rain2540 · Sep 27, 2016 · 97e1f07 · 97e1f07
2 parents 1aff4bd + 440a5b5
commit 97e1f07
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 1 deletion.
diff --git a/Sources/ImageCache.swift b/Sources/ImageCache.swift
@@ -87,6 +87,9 @@ open class ImageCache {
 
     ///The disk cache location.
     open let diskCachePath: String
+
+    /// The default file extension appended to cached files.
+    open var pathExtension: String?
 
     /// The longest time duration in second of the cache being stored in disk. 
     /// Default is 1 week (60 * 60 * 24 * 7 seconds).
@@ -621,7 +624,7 @@ extension ImageCache {
 
 // MARK: - Internal Helper
 extension ImageCache {
-    
+
     func diskImage(forComputedKey key: String, serializer: CacheSerializer, options: KingfisherOptionsInfo) -> Image? {
         if let data = diskImageData(forComputedKey: key) {
             return serializer.image(with: data, options: options)
@@ -636,6 +639,9 @@ extension ImageCache {
     }
 
     func cacheFileName(forComputedKey key: String) -> String {
+        if let ext = self.pathExtension {
+          return (key.kf.md5 as NSString).appendingPathExtension(ext)!
+        }
         return key.kf.md5
     }
 }

diff --git a/Tests/KingfisherTests/ImageCacheTests.swift b/Tests/KingfisherTests/ImageCacheTests.swift
@@ -200,6 +200,51 @@ class ImageCacheTests: XCTestCase {
         XCTAssertFalse(exists)
     }
 
+    func testCachedFileWithCustomPathExtensionExists() {
+        cache.pathExtension = "jpg"
+        let expectation = self.expectation(description: "cache with custom path extension does contain image")
+
+        let URLString = testKeys[0]
+        let url = URL(string: URLString)!
+
+        let exists = cache.isImageCached(forKey: url.cacheKey).cached
+        XCTAssertFalse(exists)
+
+        cache.retrieveImage(forKey: URLString, options: nil, completionHandler: { (image, type) -> () in
+            XCTAssertNil(image, "Should not be cached yet")
+
+            XCTAssertEqual(type, .none)
+
+            self.cache.store(testImage, forKey: URLString, toDisk: true) { () -> () in
+                self.cache.retrieveImage(forKey: URLString, options: nil, completionHandler: { (image, type) -> () in
+                    XCTAssertNotNil(image, "Should be cached (memory or disk)")
+                    XCTAssertEqual(type, .memory)
+
+                    let exists = self.cache.isImageCached(forKey: url.cacheKey).cached
+                    XCTAssertTrue(exists, "Image should exist in the cache (memory or disk)")
+
+                    self.cache.clearMemoryCache()
+                    self.cache.retrieveImage(forKey: URLString, options: nil, completionHandler: { (image, type) -> () in
+                        XCTAssertNotNil(image, "Should be cached (disk)")
+                        XCTAssertEqual(type, CacheType.disk)
+
+                        let exists = self.cache.isImageCached(forKey: url.cacheKey).cached
+                        XCTAssertTrue(exists, "Image should exist in the cache (disk)")
+
+                        let cachePath = self.cache.cachePath(forKey: url.cacheKey)
+                        let hasExtension = cachePath.hasSuffix(".jpg")
+                        XCTAssert(hasExtension, "Should have .jpg file extension")
+
+                        expectation.fulfill()
+                    })
+                })
+            }
+        })
+
+        waitForExpectations(timeout: 5, handler: nil)
+    }
+
+
     func testCachedImageIsFetchedSyncronouslyFromTheMemoryCache() {
         cache.store(testImage, forKey: testKeys[0], toDisk: false) { () -> () in
             // do nothing