configをわかりやすく

Author: pixel-ink

PIImageCache/PIImageCache/PIImageCache.swift

@@ -101,12 +101,12 @@ public class PIImageCache {
 
   private var config: Config = Config()
   public class Config {
-    public var maxCount : Int = 10 // 10 images
-    public var maxByteSize  : Int = 3 * 1024 * 1024 //3MB
-    public var usingDiskCache = true
-    public var diskCacheExpireMinutes = 24 * 60 // 1 day
-    public var cacheRootDirectory = NSTemporaryDirectory()
-    public var cacheFolderName = "PIImageCache"
+    public var maxMemorySum           : Int    = 10 // 10 images
+    public var limitByteSize          : Int    = 3 * 1024 * 1024 //3MB
+    public var usingDiskCache         : Bool   = true
+    public var diskCacheExpireMinutes : Int    = 24 * 60 // 1 day
+    public var cacheRootDirectory     : String = NSTemporaryDirectory()
+    public var cacheFolderName        : String = "PIImageCache"
   }
 
   public func setConfig(config :Config) {
@@ -132,9 +132,9 @@ public class PIImageCache {
 
   private func memoryCacheWrite(url:NSURL,image:UIImage) {
     switch memoryCache.count {
-    case 0 ... config.maxCount:
+    case 0 ... config.maxMemorySum:
       memoryCache.append(memoryCacheImage(image: image, timeStamp: now, url: url))
-    case config.maxCount + 1://+1 because 0 origin
+    case config.maxMemorySum + 1://+1 because 0 origin
       var old = (0,now)
       for i in 0 ..< memoryCache.count {
         if old.1 < memoryCache[i].timeStamp {
@@ -269,7 +269,7 @@ public class PIImageCache {
     //download
     let maybeImage = download(url)
     if let (image, byteSize) = maybeImage {
-      if byteSize < config.maxByteSize {
+      if byteSize < config.limitByteSize {
         //write memory
         dispatch_semaphore_wait(memorySemaphore, DISPATCH_TIME_FOREVER)
         memoryCacheWrite(url, image: image)

PIImageCache/PIImageCacheTests/PIImageCacheBasicTests.swift

@@ -25,8 +25,8 @@ class PIImageBasicCacheTests: XCTestCase {
     image = cache.get(url)!
     XCTAssert(image!.size.width == 200 && image!.size.height == 200 , "Pass")
     var config = PIImageCache.Config()
-    config.maxCount = 5
-    config.maxByteSize = 100 * 1024 // 100kB
+    config.maxMemorySum = 5
+    config.limitByteSize = 100 * 1024 // 100kB
     cache.setConfig(config)
     image = cache.get(url)!
     XCTAssert(image!.size.width == 200 && image!.size.height == 200 , "Pass")

PIImageCache/PIImageCacheTests/PIImageMemoryCacheTests.swift

@@ -87,8 +87,8 @@ class PIImageMemoryCacheTests: XCTestCase {
 
   func testCacheMaxCount() {
     let config = PIImageCache.Config()
-    config.maxCount = 5
-    config.maxByteSize = 3 * 1024 * 1024
+    config.maxMemorySum = 5
+    config.limitByteSize = 3 * 1024 * 1024
     let cache = PIImageCache(config: config)
     var image: UIImage?, result: PIImageCache.Result
     var urls :[NSURL] = []
@@ -114,8 +114,8 @@ class PIImageMemoryCacheTests: XCTestCase {
 
   func testCacheMaxSize() {
     let config = PIImageCache.Config()
-    config.maxCount = 10
-    config.maxByteSize = 100
+    config.maxMemorySum = 10
+    config.limitByteSize = 100
     let cache = PIImageCache(config: config)
     let url = NSURL(string: "http://place-hold.it/200x200")!
     var image: UIImage?, result: PIImageCache.Result
@@ -202,7 +202,7 @@ class PIImageMemoryCacheTests: XCTestCase {
 
     var config = PIImageCache.Config()
     config.usingDiskCache = false
-    config.maxCount = 5
+    config.maxMemorySum = 5
     var cache = PIImageCache(config: config)
 
     for i in 0 ..< 5 {
@@ -217,7 +217,7 @@ class PIImageMemoryCacheTests: XCTestCase {
       XCTAssert(image!.size.width == 200 && image!.size.height == 200 , "Pass")
     }
 
-    config.maxCount = 2
+    config.maxMemorySum = 2
     cache = PIImageCache(config: config)
 
     for i in 0 ..< 2 {
@@ -232,7 +232,7 @@ class PIImageMemoryCacheTests: XCTestCase {
       XCTAssert(image!.size.width == 200 && image!.size.height == 200 , "Pass")
     }
 
-    config.maxByteSize = 100
+    config.limitByteSize = 100
     cache = PIImageCache(config: config)
 
     for i in 3 ..< 5 {

README.md

@@ -76,10 +76,18 @@ image = cache.get(url)!
 ```Config.swift
 let cache = PIImageCache.shared
 var config = PIImageCache.Config()
-config.maxCount = 5
-config.maxByteSize = 100 * 1024 // 100kB
+config.maxMemorySum = 5
+config.limitByteSize = 100 * 1024 // 100kB
 cache.setConfig(config)
 
 let url = NSURL(string: "http://place-hold.it/200x200")!
 let image = cache.get(url)!
-```
+```
+
+- default values
+  - maxMemorySum           = 10 // 10 images
+  - limitByteSize          = 3 * 1024 * 1024 //3MB
+  - usingDiskCache         = true
+  - diskCacheExpireMinutes = 24 * 60 // 1 day
+  - cacheRootDirectory     = NSTemporaryDirectory()
+  - cacheFolderName        = "PIImageCache"