Defaults update

richardpiazza · richardpiazza · commit b4f7b6707812 · 2016-05-02T16:02:18.000-05:00
diff --git a/CodeQuickKit-Swift/NSUserDefaults.swift b/CodeQuickKit-Swift/NSUserDefaults.swift
@@ -30,7 +30,7 @@ import Foundation
 /// ### UserDefault
 /// A defined structure for storing information in `NSUserDefaults` and `NSUbiquitousKeyValueStore`.
 /// The `timestamp` and optional `build` variables allow for comparisson during syncing.
-public struct UserDefault {
+public struct KeyValueItem {
     public var value: NSObject
     public var timestamp: NSDate = NSDate()
     public var build: NSString?
@@ -44,15 +44,16 @@ public struct UserDefault {
     }
 }
 
-/// ### UserDefaults
-/// A protocol declaring dictionary conformance. These methods are taken from `NSUbiquitousKeyValueStore`.
-public protocol UserDefaults {
+/// ### KeyValueStorage
+/// A protocol declaring dictionary conformance.
+/// - note: These methods are taken from `NSUbiquitousKeyValueStore`.
+public protocol KeyValueStorage {
     func dictionaryForKey(aKey: String) -> [String : AnyObject]?
     func setDictionary(aDictionary: [String : AnyObject]?, forKey aKey: String)
 }
 
-extension UserDefaults {
-    func userDefaultForKey(key: String) -> UserDefault? {
+extension KeyValueStorage {
+    func itemForKey(key: String) -> KeyValueItem? {
         guard let dictionary = self.dictionaryForKey(key) else {
             return nil
         }
@@ -67,31 +68,30 @@ extension UserDefaults {
         
         let build = dictionary[KeyValueUbiquityContainer.Keys.build] as? NSString
         
-        return UserDefault(value: value, timestamp: timestamp, build: build)
+        return KeyValueItem(value: value, timestamp: timestamp, build: build)
     }
     
     func valueForKey(key: String) -> NSObject? {
-        return userDefaultForKey(key)?.value
+        return itemForKey(key)?.value
     }
     
-    func setUserDefault(userDefault: UserDefault, forKey key: String) {
+    func setItem(item: KeyValueItem, forKey key: String) {
         var dictionary = [String : NSObject]()
-        dictionary[KeyValueUbiquityContainer.Keys.value] = userDefault.value
-        dictionary[KeyValueUbiquityContainer.Keys.timestamp] = userDefault.timestamp
-        if let build = userDefault.build {
+        dictionary[KeyValueUbiquityContainer.Keys.value] = item.value
+        dictionary[KeyValueUbiquityContainer.Keys.timestamp] = item.timestamp
+        if let build = item.build {
             dictionary[KeyValueUbiquityContainer.Keys.build] = build
         }
         
         self.setDictionary(dictionary, forKey: key)
     }
     
     func setValue(value: NSObject, forKey key: String) {
-        let userDefault = UserDefault(value: value, timestamp: NSDate(), build: nil)
-        self.setUserDefault(userDefault, forKey: key)
+        self.setItem(KeyValueItem(value: value, timestamp: NSDate(), build: nil), forKey: key)
     }
 }
 
-extension NSUserDefaults: UserDefaults {
+extension NSUserDefaults: KeyValueStorage {
     public func setDictionary(aDictionary: [String : AnyObject]?, forKey aKey: String) {
         if let dictionary = aDictionary {
             self.setObject(dictionary, forKey: aKey)
@@ -101,12 +101,12 @@ extension NSUserDefaults: UserDefaults {
     }
 }
 
-extension NSUbiquitousKeyValueStore: UserDefaults {
+extension NSUbiquitousKeyValueStore: KeyValueStorage {
 }
 
 public protocol KeyValueUbiquityContainerDelegate {
-    func shouldReplaceUserDefaults(existingDefualt oldValue: UserDefault, withDefault newValue: UserDefault, forKey key: String) -> Bool
-    func didSetUserDefault(userDefault: UserDefault, forKey key: String)
+    func shouldReplaceItem(existingItem existingItem: KeyValueItem, withItem newItem: KeyValueItem, forKey key: String) -> Bool
+    func didSetItem(item: KeyValueItem, forKey key: String)
 }
 
 /// ### KeyValueUbiquityContainer
@@ -165,29 +165,29 @@ public class KeyValueUbiquityContainer: UbiquityContainer {
             }
             
             for key in changedKeys {
-                guard let ubiquityUserDefault = keyValueStore.userDefaultForKey(key) else {
+                guard let ubiquityItem = keyValueStore.itemForKey(key) else {
                     Logger.debug("Removing NSUserDefaults object for key '\(key)'")
                     NSUserDefaults.standardUserDefaults().removeObjectForKey(key)
                     continue
                 }
                 
-                guard let standardUserDefault = NSUserDefaults.standardUserDefaults().userDefaultForKey(key) else {
-                    NSUserDefaults.standardUserDefaults().setUserDefault(ubiquityUserDefault, forKey: key)
+                guard let standardItem = NSUserDefaults.standardUserDefaults().itemForKey(key) else {
+                    NSUserDefaults.standardUserDefaults().setItem(ubiquityItem, forKey: key)
                     if let delegate = keyValueDelegate {
-                        delegate.didSetUserDefault(ubiquityUserDefault, forKey: key)
+                        delegate.didSetItem(ubiquityItem, forKey: key)
                     }
                     continue
                 }
                 
                 var replace = true
                 if let delegate = self.keyValueDelegate {
-                    replace = delegate.shouldReplaceUserDefaults(existingDefualt: standardUserDefault, withDefault: ubiquityUserDefault, forKey: key)
+                    replace = delegate.shouldReplaceItem(existingItem: standardItem, withItem: ubiquityItem, forKey: key)
                 }
                 
                 if replace {
-                    NSUserDefaults.standardUserDefaults().setUserDefault(ubiquityUserDefault, forKey: key)
+                    NSUserDefaults.standardUserDefaults().setItem(ubiquityItem, forKey: key)
                     if let delegate = keyValueDelegate {
-                        delegate.didSetUserDefault(ubiquityUserDefault, forKey: key)
+                        delegate.didSetItem(ubiquityItem, forKey: key)
                     }
                 }
             }
@@ -201,19 +201,24 @@ public class KeyValueUbiquityContainer: UbiquityContainer {
 public extension NSUserDefaults {
     public static var ubiquityUserDefaults: KeyValueUbiquityContainer = KeyValueUbiquityContainer()
     
-    public static func setUserDefault(userDefault: UserDefault, forKey key: String) {
+    /// Attempts to set an item on `NSUbiquitousKeyValueStore`. Will fallback to `NSUserDefaults`
+    public static func setItem(item: KeyValueItem, forKey key: String) {
         if let keyValueStore = NSUserDefaults.ubiquityUserDefaults.keyValueStore {
-            keyValueStore.setUserDefault(userDefault, forKey: key)
+            keyValueStore.setItem(item, forKey: key)
+            if let delegate = ubiquityUserDefaults.keyValueDelegate {
+                delegate.didSetItem(item, forKey: key)
+            }
         } else {
-            NSUserDefaults.standardUserDefaults().setUserDefault(userDefault, forKey: key)
+            NSUserDefaults.standardUserDefaults().setItem(item, forKey: key)
         }
     }
     
-    public static func userDefaultForKey(key: String) -> UserDefault? {
-        if let userDefault = NSUserDefaults.ubiquityUserDefaults.keyValueStore?.userDefaultForKey(key) {
-            return userDefault
+    /// Attemps to retrieve an item from `NSUbiquitousKeyValueStore`. Will fallback to `NSUserDefaults`
+    public static func itemForKey(key: String) -> KeyValueItem? {
+        if let item = NSUserDefaults.ubiquityUserDefaults.keyValueStore?.itemForKey(key) {
+            return item
         }
         
-        return NSUserDefaults.standardUserDefaults().userDefaultForKey(key)
+        return NSUserDefaults.standardUserDefaults().itemForKey(key)
     }
 }
diff --git a/CodeQuickKit.podspec b/CodeQuickKit.podspec
@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = "CodeQuickKit"
-  s.version          = "2.0.2"
+  s.version          = "2.1.0"
   s.summary          = "An iOS Library simplifying some everyday tasks."
   s.description      = <<-DESC
   CodeQuickKit is a collection of Swift extensions and classes designed to 

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ import Foundation`
`30`	`30`	`/// ### UserDefault`
`31`	`31`	/// A defined structure for storing information in `NSUserDefaults` and `NSUbiquitousKeyValueStore`.
`32`	`32`	/// The `timestamp` and optional `build` variables allow for comparisson during syncing.
`33`		`-public struct UserDefault {`
	`33`	`+public struct KeyValueItem {`
`34`	`34`	`public var value: NSObject`
`35`	`35`	`public var timestamp: NSDate = NSDate()`
`36`	`36`	`public var build: NSString?`
`@@ -44,15 +44,16 @@ public struct UserDefault {`
`44`	`44`	`}`
`45`	`45`	`}`
`46`	`46`
`47`		`-/// ### UserDefaults`
`48`		-/// A protocol declaring dictionary conformance. These methods are taken from `NSUbiquitousKeyValueStore`.
`49`		`-public protocol UserDefaults {`
	`47`	`+/// ### KeyValueStorage`
	`48`	`+/// A protocol declaring dictionary conformance.`
	`49`	+/// - note: These methods are taken from `NSUbiquitousKeyValueStore`.
	`50`	`+public protocol KeyValueStorage {`
`50`	`51`	`func dictionaryForKey(aKey: String) -> [String : AnyObject]?`
`51`	`52`	`func setDictionary(aDictionary: [String : AnyObject]?, forKey aKey: String)`
`52`	`53`	`}`
`53`	`54`
`54`		`-extension UserDefaults {`
`55`		`- func userDefaultForKey(key: String) -> UserDefault? {`
	`55`	`+extension KeyValueStorage {`
	`56`	`+ func itemForKey(key: String) -> KeyValueItem? {`
`56`	`57`	`guard let dictionary = self.dictionaryForKey(key) else {`
`57`	`58`	`return nil`
`58`	`59`	`}`
`@@ -67,31 +68,30 @@ extension UserDefaults {`
`67`	`68`
`68`	`69`	`let build = dictionary[KeyValueUbiquityContainer.Keys.build] as? NSString`
`69`	`70`
`70`		`- return UserDefault(value: value, timestamp: timestamp, build: build)`
	`71`	`+ return KeyValueItem(value: value, timestamp: timestamp, build: build)`
`71`	`72`	`}`
`72`	`73`
`73`	`74`	`func valueForKey(key: String) -> NSObject? {`
`74`		`- return userDefaultForKey(key)?.value`
	`75`	`+ return itemForKey(key)?.value`
`75`	`76`	`}`
`76`	`77`
`77`		`- func setUserDefault(userDefault: UserDefault, forKey key: String) {`
	`78`	`+ func setItem(item: KeyValueItem, forKey key: String) {`
`78`	`79`	`var dictionary = [String : NSObject]()`
`79`		`- dictionary[KeyValueUbiquityContainer.Keys.value] = userDefault.value`
`80`		`- dictionary[KeyValueUbiquityContainer.Keys.timestamp] = userDefault.timestamp`
`81`		`- if let build = userDefault.build {`
	`80`	`+ dictionary[KeyValueUbiquityContainer.Keys.value] = item.value`
	`81`	`+ dictionary[KeyValueUbiquityContainer.Keys.timestamp] = item.timestamp`
	`82`	`+ if let build = item.build {`
`82`	`83`	`dictionary[KeyValueUbiquityContainer.Keys.build] = build`
`83`	`84`	`}`
`84`	`85`
`85`	`86`	`self.setDictionary(dictionary, forKey: key)`
`86`	`87`	`}`
`87`	`88`
`88`	`89`	`func setValue(value: NSObject, forKey key: String) {`
`89`		`- let userDefault = UserDefault(value: value, timestamp: NSDate(), build: nil)`
`90`		`- self.setUserDefault(userDefault, forKey: key)`
	`90`	`+ self.setItem(KeyValueItem(value: value, timestamp: NSDate(), build: nil), forKey: key)`
`91`	`91`	`}`
`92`	`92`	`}`
`93`	`93`
`94`		`-extension NSUserDefaults: UserDefaults {`
	`94`	`+extension NSUserDefaults: KeyValueStorage {`
`95`	`95`	`public func setDictionary(aDictionary: [String : AnyObject]?, forKey aKey: String) {`
`96`	`96`	`if let dictionary = aDictionary {`
`97`	`97`	`self.setObject(dictionary, forKey: aKey)`
`@@ -101,12 +101,12 @@ extension NSUserDefaults: UserDefaults {`
`101`	`101`	`}`
`102`	`102`	`}`
`103`	`103`
`104`		`-extension NSUbiquitousKeyValueStore: UserDefaults {`
	`104`	`+extension NSUbiquitousKeyValueStore: KeyValueStorage {`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`public protocol KeyValueUbiquityContainerDelegate {`
`108`		`- func shouldReplaceUserDefaults(existingDefualt oldValue: UserDefault, withDefault newValue: UserDefault, forKey key: String) -> Bool`
`109`		`- func didSetUserDefault(userDefault: UserDefault, forKey key: String)`
	`108`	`+ func shouldReplaceItem(existingItem existingItem: KeyValueItem, withItem newItem: KeyValueItem, forKey key: String) -> Bool`
	`109`	`+ func didSetItem(item: KeyValueItem, forKey key: String)`
`110`	`110`	`}`
`111`	`111`
`112`	`112`	`/// ### KeyValueUbiquityContainer`
`@@ -165,29 +165,29 @@ public class KeyValueUbiquityContainer: UbiquityContainer {`
`165`	`165`	`}`
`166`	`166`
`167`	`167`	`for key in changedKeys {`
`168`		`- guard let ubiquityUserDefault = keyValueStore.userDefaultForKey(key) else {`
	`168`	`+ guard let ubiquityItem = keyValueStore.itemForKey(key) else {`
`169`	`169`	`Logger.debug("Removing NSUserDefaults object for key '\(key)'")`
`170`	`170`	`NSUserDefaults.standardUserDefaults().removeObjectForKey(key)`
`171`	`171`	`continue`
`172`	`172`	`}`
`173`	`173`
`174`		`- guard let standardUserDefault = NSUserDefaults.standardUserDefaults().userDefaultForKey(key) else {`
`175`		`- NSUserDefaults.standardUserDefaults().setUserDefault(ubiquityUserDefault, forKey: key)`
	`174`	`+ guard let standardItem = NSUserDefaults.standardUserDefaults().itemForKey(key) else {`
	`175`	`+ NSUserDefaults.standardUserDefaults().setItem(ubiquityItem, forKey: key)`
`176`	`176`	`if let delegate = keyValueDelegate {`
`177`		`- delegate.didSetUserDefault(ubiquityUserDefault, forKey: key)`
	`177`	`+ delegate.didSetItem(ubiquityItem, forKey: key)`
`178`	`178`	`}`
`179`	`179`	`continue`
`180`	`180`	`}`
`181`	`181`
`182`	`182`	`var replace = true`
`183`	`183`	`if let delegate = self.keyValueDelegate {`
`184`		`- replace = delegate.shouldReplaceUserDefaults(existingDefualt: standardUserDefault, withDefault: ubiquityUserDefault, forKey: key)`
	`184`	`+ replace = delegate.shouldReplaceItem(existingItem: standardItem, withItem: ubiquityItem, forKey: key)`
`185`	`185`	`}`
`186`	`186`
`187`	`187`	`if replace {`
`188`		`- NSUserDefaults.standardUserDefaults().setUserDefault(ubiquityUserDefault, forKey: key)`
	`188`	`+ NSUserDefaults.standardUserDefaults().setItem(ubiquityItem, forKey: key)`
`189`	`189`	`if let delegate = keyValueDelegate {`
`190`		`- delegate.didSetUserDefault(ubiquityUserDefault, forKey: key)`
	`190`	`+ delegate.didSetItem(ubiquityItem, forKey: key)`
`191`	`191`	`}`
`192`	`192`	`}`
`193`	`193`	`}`
`@@ -201,19 +201,24 @@ public class KeyValueUbiquityContainer: UbiquityContainer {`
`201`	`201`	`public extension NSUserDefaults {`
`202`	`202`	`public static var ubiquityUserDefaults: KeyValueUbiquityContainer = KeyValueUbiquityContainer()`
`203`	`203`
`204`		`- public static func setUserDefault(userDefault: UserDefault, forKey key: String) {`
	`204`	+ /// Attempts to set an item on `NSUbiquitousKeyValueStore`. Will fallback to `NSUserDefaults`
	`205`	`+ public static func setItem(item: KeyValueItem, forKey key: String) {`
`205`	`206`	`if let keyValueStore = NSUserDefaults.ubiquityUserDefaults.keyValueStore {`
`206`		`- keyValueStore.setUserDefault(userDefault, forKey: key)`
	`207`	`+ keyValueStore.setItem(item, forKey: key)`
	`208`	`+ if let delegate = ubiquityUserDefaults.keyValueDelegate {`
	`209`	`+ delegate.didSetItem(item, forKey: key)`
	`210`	`+ }`
`207`	`211`	`} else {`
`208`		`- NSUserDefaults.standardUserDefaults().setUserDefault(userDefault, forKey: key)`
	`212`	`+ NSUserDefaults.standardUserDefaults().setItem(item, forKey: key)`
`209`	`213`	`}`
`210`	`214`	`}`
`211`	`215`
`212`		`- public static func userDefaultForKey(key: String) -> UserDefault? {`
`213`		`- if let userDefault = NSUserDefaults.ubiquityUserDefaults.keyValueStore?.userDefaultForKey(key) {`
`214`		`- return userDefault`
	`216`	+ /// Attemps to retrieve an item from `NSUbiquitousKeyValueStore`. Will fallback to `NSUserDefaults`
	`217`	`+ public static func itemForKey(key: String) -> KeyValueItem? {`
	`218`	`+ if let item = NSUserDefaults.ubiquityUserDefaults.keyValueStore?.itemForKey(key) {`
	`219`	`+ return item`
`215`	`220`	`}`
`216`	`221`
`217`		`- return NSUserDefaults.standardUserDefaults().userDefaultForKey(key)`
	`222`	`+ return NSUserDefaults.standardUserDefaults().itemForKey(key)`
`218`	`223`	`}`
`219`	`224`	`}`