v1.2.2 (#28)

Author: omaralbeik

.swiftlint.yml

@@ -1,6 +1,3 @@
 disabled_rules:
   - identifier_name
   - type_name
-
-excluded:
-  - Example

README.md

@@ -11,7 +11,7 @@
   <a href="https://github.com/Carthage/Carthage"><img src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat" alt="Carthage compatible" /></a>
   <a href="https://swift.org/package-manager/"><img src="https://img.shields.io/badge/SPM-compatible-4BC51D.svg?style=flat" alt="Swift Package Manager compatible" /></a>
   <a href="https://swift.org"><img src="https://img.shields.io/badge/Swift-4.2-orange.svg" alt="Swift" /></a>
-  <a href="https://developer.apple.com/xcode"><img src="https://img.shields.io/badge/Xcode-9.4-blue.svg" alt="Xcode"></a>
+  <a href="https://developer.apple.com/xcode"><img src="https://img.shields.io/badge/Xcode-10-blue.svg" alt="Xcode"></a>
   <a href="https://github.com/omaralbeik/UserDefaultsStore/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-MIT-red.svg" alt="MIT"></a>
 </p>
 
@@ -61,6 +61,7 @@ dependencies: [
 ## Usage
 
 Let's say you have 2 structs; `User` and `Laptop` defined as bellow:
+
 ```swift
 struct User: Codable {
     var id: Int
@@ -81,6 +82,7 @@ Here is how you store them in **UserDefaultsStore**:
 
 
 ### 1. Conform to the `Identifiable` protocol and set the `idKey` property
+
 The `Identifiable` protocol lets UserDefaultsStore knows what is the unique id for each object.
 
 ```swift
@@ -97,15 +99,18 @@ struct Laptop: Codable, Identifiable {
 }
 ```
 
-* Notice how `User` uses `Int` for its id, while `Laptop` uses `String`. Swift rocks 🤘
+> Notice how `User` uses `Int` for its id, while `Laptop` uses `String`, in fact the id can be any `Hashable` type. UserDefaults uses Swift keypaths to refer to properties without actually invoking them. Swift rocks 🤘
+
 
 ### 2. Create UserDefaults Stores
+
 ```swift
 let usersStore = UserDefaultsStore<User>(uniqueIdentifier: "users")!
 let laptopsStore = UserDefaultsStore<Laptop>(uniqueIdentifier: "laptops")!
 ```
 
 ### 3. Voilà, you're all set!
+
 ```swift
 let macbook = Laptop(model: "A1278", name: "MacBook Pro")
 let john = User(userId: 1, firstName: "John", lastName: "Appleseed", laptop: macbook)
@@ -118,6 +123,7 @@ try! usersStore.save([jane, steve, jessica])
 
 // Get an object from store
 let user = store.object(withId: 1)
+let laptop = store.object(withId: "A1278")
 
 // Get all objects in a store
 let laptops = laptopsStore.allObjects()
@@ -143,22 +149,27 @@ let usersCount = usersStore.objectsCount
 
 
 ## Looking to store a single item only?
-Use [`SingleUserDefaultsStore`](https://github.com/omaralbeik/UserDefaultsStore/blob/master/Sources/SingleUserDefaultsStore.swift), it enables storing and retrieving a single `Codable` object only.
+
+Use [`SingleUserDefaultsStore`](https://github.com/omaralbeik/UserDefaultsStore/blob/master/Sources/SingleUserDefaultsStore.swift), it enables storing and retrieving a single value of `Int`, `Double`, `String`, or any `Codable` type.
 
 
 ## Requirements
+
 - iOS 8.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+
-- Xcode 9+
-- Swift 4+
+- Xcode 10.0+
+- Swift 4.2+
 
 
 ## Thanks
+
 Special thanks to [Paul Hudson](https://twitter.com/twostraws) for his [article](https://www.hackingwithswift.com/articles/57/how-swift-keypaths-let-us-write-more-natural-code) on how to use Swift keypaths to write more natural code.
 
 
 ## Credits
+
 Icon made by [freepik](https://www.flaticon.com/authors/freepik) from [flaticon.com](https://www.flaticon.com).
 
 
 ## License
+
 UserDefaultsStore is released under the MIT license. See [LICENSE](https://github.com/omaralbeik/UserDefaultsStore/blob/master/LICENSE) for more information.

Sources/Identifiable.swift

@@ -23,7 +23,7 @@
 
 import Foundation
 
-/// Conform to `Identifiable` protocol in uniquely identified objects you want to store in a UserDefaultsStore.
+/// Conform to `Identifiable` protocol in uniquely identified objects you want to store in a `UserDefaultsStore`.
 public protocol Identifiable {
 
 	/// ID type.

Sources/Info.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.2.1</string>
+	<string>1.2.2</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>

Sources/SingleUserDefaultsStore.swift

@@ -23,23 +23,25 @@
 
 import Foundation
 
-/// SingleUserDefaults Store.
+/// `SingleUserDefaultsStore` offers a convenient way to store a single `Codable` object in `UserDefaults`.
 open class SingleUserDefaultsStore<T: Codable> {
 
 	/// Store's unique identifier.
+	///
 	/// **Warning**: Never use the same identifier for two -or more- different stores.
 	public let uniqueIdentifier: String
 
-	/// JSON encoder. _(default is JSONEncoder())_
+	/// JSON encoder. _default is `JSONEncoder()`_
 	open var encoder = JSONEncoder()
 
-	/// JSON decoder. _(default is JSONDecoder())_
+	/// JSON decoder. _default is `JSONDecoder()`_
 	open var decoder = JSONDecoder()
 
 	/// UserDefaults store.
 	private var store: UserDefaults
 
 	/// Initialize store with given identifier.
+	///
 	/// **Warning**: Never use the same identifier for two -or more- different stores.
 	///
 	/// - Parameter uniqueIdentifier: store's unique identifier.
@@ -75,15 +77,23 @@ open class SingleUserDefaultsStore<T: Codable> {
 // MARK: - Helpers
 private extension SingleUserDefaultsStore {
 
+	/// Enclose the object in a dictionary to enable single object storing.
+	///
+	/// - Parameter object: object.
+	/// - Returns: dictionary enclosing object.
 	func generateDict(for object: T) -> [String: T] {
 		return ["object": object]
 	}
 
+	/// Extract object from dictionary.
+	///
+	/// - Parameter dict: dictionary.
+	/// - Returns: object.
 	func extractObject(from dict: [String: T]) -> T? {
 		return dict["object"]
 	}
 
-	/// store key for object.
+	/// Store key for object.
 	var key: String {
 		return "\(uniqueIdentifier)-single-object"
 	}

Sources/UserDefaultsStore.swift

@@ -23,23 +23,25 @@
 
 import Foundation
 
-/// UserDefaults Store.
+/// `UserDefaultsStore` offers a convenient way to store a collection of `Codable` objects in `UserDefaults`.
 open class UserDefaultsStore<T: Codable & Identifiable> {
 
 	/// Store's unique identifier.
+	///
 	/// **Warning**: Never use the same identifier for two -or more- different stores.
 	public let uniqueIdentifier: String
 
-	/// JSON encoder. _(default is JSONEncoder())_
+	/// JSON encoder. _default is `JSONEncoder()`_
 	open var encoder = JSONEncoder()
 
-	/// JSON decoder. _(default is JSONDecoder())_
+	/// JSON decoder. _default is `JSONDecoder()`_
 	open var decoder = JSONDecoder()
 
 	/// UserDefaults store.
 	private var store: UserDefaults
 
 	/// Initialize store with given identifier.
+	///
 	/// **Warning**: Never use the same identifier for two -or more- different stores.
 	///
 	/// - Parameter uniqueIdentifier: store's unique identifier.

UserDefaultsStore.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
     s.name = "UserDefaultsStore"
-    s.version = "1.2.1"
+    s.version = "1.2.2"
     s.summary = "Why not use UserDefaults to store Codable objects 😉"
     s.description = <<-DESC
     You love Swift"s Codable protocol and use it everywhere, here is an easy and very light way to store - reasonable amount 😅 - of Codable objects, in a couple lines of code.
@@ -15,7 +15,7 @@ Pod::Spec.new do |s|
     s.module_name  = "UserDefaultsStore"
     s.source = { :git => "https://github.com/omaralbeik/UserDefaultsStore.git", :tag => s.version }
     s.source_files = "Sources/**/*.swift"
-    s.swift_version = "4.1"
+    s.swift_version = "4.2"
     s.requires_arc = true
 
     s.ios.deployment_target = "8.0"

UserDefaultsStore.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict/>
+</plist>