Fix a bug in save objects (#40)

Fix a bug where saving an array of objects with an invalid object will cause the store to have an invalid count

Author: omaralbeik

.codebeatignore

@@ -0,0 +1 @@
+docs/**

.travis.yml

@@ -1,11 +1,11 @@
 os: osx
 language: swift
-osx_image: xcode10.2
+osx_image: xcode11.2
 
 env:
   - ACTION=test  PLATFORM=Mac     DESTINATION='platform=OS X'
-  - ACTION=test  PLATFORM=iOS     DESTINATION='platform=iOS Simulator,name=iPhone X'
-  - ACTION=build PLATFORM=watchOS DESTINATION='platform=watchOS Simulator,name=Apple Watch - 42mm'
+  - ACTION=test  PLATFORM=iOS     DESTINATION='platform=iOS Simulator,name=iPhone 11'
+  - ACTION=build PLATFORM=watchOS DESTINATION='platform=watchOS Simulator,name=Apple Watch Series 5 - 40mm'
   - ACTION=test  PLATFORM=tvOS    DESTINATION='platform=tvOS Simulator,name=Apple TV 4K (at 1080p)'
 
 before_install:

Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 gem 'xcpretty'
 gem 'xcpretty-json-formatter'
+gem 'cocoapods'
+gem 'jazzy'

Gemfile.lock

@@ -0,0 +1,110 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    CFPropertyList (3.0.1)
+    activesupport (4.2.11.1)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    algoliasearch (1.27.1)
+      httpclient (~> 2.8, >= 2.8.3)
+      json (>= 1.5.1)
+    atomos (0.1.3)
+    claide (1.0.3)
+    cocoapods (1.8.4)
+      activesupport (>= 4.0.2, < 5)
+      claide (>= 1.0.2, < 2.0)
+      cocoapods-core (= 1.8.4)
+      cocoapods-deintegrate (>= 1.0.3, < 2.0)
+      cocoapods-downloader (>= 1.2.2, < 2.0)
+      cocoapods-plugins (>= 1.0.0, < 2.0)
+      cocoapods-search (>= 1.0.0, < 2.0)
+      cocoapods-stats (>= 1.0.0, < 2.0)
+      cocoapods-trunk (>= 1.4.0, < 2.0)
+      cocoapods-try (>= 1.1.0, < 2.0)
+      colored2 (~> 3.1)
+      escape (~> 0.0.4)
+      fourflusher (>= 2.3.0, < 3.0)
+      gh_inspector (~> 1.0)
+      molinillo (~> 0.6.6)
+      nap (~> 1.0)
+      ruby-macho (~> 1.4)
+      xcodeproj (>= 1.11.1, < 2.0)
+    cocoapods-core (1.8.4)
+      activesupport (>= 4.0.2, < 6)
+      algoliasearch (~> 1.0)
+      concurrent-ruby (~> 1.1)
+      fuzzy_match (~> 2.0.4)
+      nap (~> 1.0)
+    cocoapods-deintegrate (1.0.4)
+    cocoapods-downloader (1.3.0)
+    cocoapods-plugins (1.0.0)
+      nap
+    cocoapods-search (1.0.0)
+    cocoapods-stats (1.1.0)
+    cocoapods-trunk (1.4.1)
+      nap (>= 0.8, < 2.0)
+      netrc (~> 0.11)
+    cocoapods-try (1.1.0)
+    colored2 (3.1.2)
+    concurrent-ruby (1.1.5)
+    escape (0.0.4)
+    ffi (1.11.2)
+    fourflusher (2.3.1)
+    fuzzy_match (2.0.4)
+    gh_inspector (1.1.3)
+    httpclient (2.8.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jazzy (0.12.0)
+      cocoapods (~> 1.5)
+      mustache (~> 1.1)
+      open4
+      redcarpet (~> 3.4)
+      rouge (>= 2.0.6, < 4.0)
+      sassc (~> 2.1)
+      sqlite3 (~> 1.3)
+      xcinvoke (~> 0.3.0)
+    json (2.2.0)
+    liferaft (0.0.6)
+    minitest (5.13.0)
+    molinillo (0.6.6)
+    mustache (1.1.0)
+    nanaimo (0.2.6)
+    nap (1.1.0)
+    netrc (0.11.0)
+    open4 (1.3.4)
+    redcarpet (3.5.0)
+    rouge (2.0.7)
+    ruby-macho (1.4.0)
+    sassc (2.2.1)
+      ffi (~> 1.9)
+    sqlite3 (1.4.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    xcinvoke (0.3.0)
+      liferaft (~> 0.0.6)
+    xcodeproj (1.13.0)
+      CFPropertyList (>= 2.3.3, < 4.0)
+      atomos (~> 0.1.3)
+      claide (>= 1.0.2, < 2.0)
+      colored2 (~> 3.1)
+      nanaimo (~> 0.2.6)
+    xcpretty (0.3.0)
+      rouge (~> 2.0.7)
+    xcpretty-json-formatter (0.1.1)
+      xcpretty (~> 0.2, >= 0.0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cocoapods
+  jazzy
+  xcpretty
+  xcpretty-json-formatter
+
+BUNDLED WITH
+   2.0.2

README.md

@@ -15,8 +15,6 @@
   <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>
 
-> A Turkish version of this document can be found [here](https://github.com/omaralbeik/UserDefaultsStore/blob/master/README_TR.md).
-
 # tl;dr
 You love Swift's `Codable` protocol and use it everywhere, who doesn't! Here is an easy and very light way to store and retrieve -**reasonable amount 😅**- of `Codable` objects, in a couple lines of code!
 
@@ -35,7 +33,7 @@ You love Swift's `Codable` protocol and use it everywhere, who doesn't! Here is
 </br>
 <p>To integrate UserDefaultsStore into your Xcode project using <a href="https://github.com/Carthage/Carthage">Carthage</a>, specify it in your <code>Cartfile</code>:</p>
 
-<pre><code class="ogdl language-ogdl">github "omaralbeik/UserDefaultsStore" ~&gt; 1.0
+<pre><code class="ogdl language-ogdl">github "omaralbeik/UserDefaultsStore" ~&gt; 1.4.3
 </code></pre>
 </details>
 
@@ -50,7 +48,7 @@ let package = Package(
     name: "YOUR_PROJECT_NAME",
     targets: [],
     dependencies: [
-        .package(url: "https://github.com/omaralbeik/UserDefaultsStore.git", from: "1.4.2")
+        .package(url: "https://github.com/omaralbeik/UserDefaultsStore.git", from: "1.4.3")
     ]
 )
 </code></pre>

README_TR.md

@@ -38,7 +38,7 @@ Swift'in `Codable` protokolüne bayılıyorsun ve her yerde kullanıyorsun, kim
 </br>
 <p>UserDefaultsStore'u <a href="https://github.com/Carthage/Carthage">Carthage</a>'u kullanarak Xcode projenize entegre etmek için, bunu <code>Cartfile</code>'da belirtin:
 
-<pre><code class="ogdl language-ogdl">github "omaralbeik/UserDefaultsStore" ~&gt; 1.0
+<pre><code class="ogdl language-ogdl">github "omaralbeik/UserDefaultsStore" ~&gt; 1.4.3
 </code></pre>
 </details>
 
@@ -52,7 +52,7 @@ Swift'in `Codable` protokolüne bayılıyorsun ve her yerde kullanıyorsun, kim
 
 <pre><code class="swift language-swift">import PackageDescription
 dependencies: [
-    .package(url: "https://github.com/omaralbeik/UserDefaultsStore.git", from: "1.0.2")
+    .package(url: "https://github.com/omaralbeik/UserDefaultsStore.git", from: "1.4.3")
 ]
 </code></pre>
 </details>

Sources/Identifiable.swift

@@ -21,15 +21,13 @@
 //  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 //  THE SOFTWARE.
 
-import Foundation
-
 /// Conform to `Identifiable` protocol in uniquely identified objects you want to store in a `UserDefaultsStore`.
 public protocol Identifiable {
 
-	/// ID type.
-	associatedtype ID
+    /// ID type.
+    associatedtype ID
 
-	/// Id Key.
-	static var idKey: WritableKeyPath<Self, ID> { get }
+    /// Id Key.
+    static var idKey: WritableKeyPath<Self, ID> { get }
 
 }

Sources/Info.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.4.2</string>
+	<string>$(MARKETING_VERSION)</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>

Sources/SingleUserDefaultsStore.swift

@@ -26,77 +26,77 @@ import Foundation
 /// `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()`_
-	open var encoder = JSONEncoder()
-
-	/// 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.
-	required public init?(uniqueIdentifier: String) {
-		guard let store = UserDefaults(suiteName: uniqueIdentifier) else { return nil }
-		self.uniqueIdentifier = uniqueIdentifier
-		self.store = store
-	}
-
-	/// Save object to store. _O(1)_
-	///
-	/// - Parameter object: object to save.
-	/// - Throws: JSON encoding error.
-	public func save(_ object: T) throws {
-		let data = try encoder.encode(generateDict(for: object))
-		store.set(data, forKey: key)
-	}
-
-	/// Get object from store. _O(1)_
-	public var object: T? {
-		guard let data = store.data(forKey: key) else { return nil }
-		guard let dict = try? decoder.decode([String: T].self, from: data) else { return nil }
-		return extractObject(from: dict)
-	}
-
-	/// Delete object from store. _O(1)_
-	public func delete() {
-		store.set(nil, forKey: key)
-		store.removeSuite(named: uniqueIdentifier)
-	}
+    /// 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()`_
+    open var encoder = JSONEncoder()
+
+    /// 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.
+    required public init?(uniqueIdentifier: String) {
+        guard let store = UserDefaults(suiteName: uniqueIdentifier) else { return nil }
+        self.uniqueIdentifier = uniqueIdentifier
+        self.store = store
+    }
+
+    /// Save object to store. _O(1)_
+    ///
+    /// - Parameter object: object to save.
+    /// - Throws: JSON encoding error.
+    public func save(_ object: T) throws {
+        let data = try encoder.encode(generateDict(for: object))
+        store.set(data, forKey: key)
+    }
+
+    /// Get object from store. _O(1)_
+    public var object: T? {
+        guard let data = store.data(forKey: key) else { return nil }
+        guard let dict = try? decoder.decode([String: T].self, from: data) else { return nil }
+        return extractObject(from: dict)
+    }
+
+    /// Delete object from store. _O(1)_
+    public func delete() {
+        store.set(nil, forKey: key)
+        store.removeSuite(named: uniqueIdentifier)
+    }
 
 }
 
 // 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.
-	var key: String {
-		return "\(uniqueIdentifier)-single-object"
-	}
+    /// 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.
+    var key: String {
+        return "\(uniqueIdentifier)-single-object"
+    }
 
 }

Sources/UserDefaultsStore.h

@@ -24,4 +24,4 @@
 #import <Foundation/Foundation.h>
 
 FOUNDATION_EXPORT double UserDefaultsStoreVersionNumber;
-FOUNDATION_EXPORT const unsigned char UserDefaultsStoreVersionString[];
+FOUNDATION_EXPORT const unsigned char UserDefaultsStoreVersionString[];