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
Codable objects, in a couple lines of code!
Introducing v2.0
- Removed the
Identifiableprotocol in favor of Swift'sIdentifiable. - Increased deployment targets to iOS
13.0,tvOS 13.0,macOS 10.15, andwatchOS 6.0. - Objects defined as non-final classes can now be used as well.
- Added new
generateSnapshot()andrestoreSnapshot(_:)methods to generate and restore aSnapshotobject that can be saved (e.g. to iCloud) and restored later. - Fixed a bug where
objectsCountmight run out of sync with the actual count of objects in store.
Installation
Swift Package Manager (Recommended)
You can use The Swift Package Manager to install UserDefaultsStore by adding the proper description to your Package.swift file:
import PackageDescription
let package = Package(
name: "YOUR_PROJECT_NAME",
targets: [],
dependencies: [
.package(url: "https://github.com/omaralbeik/UserDefaultsStore.git", from: "2.0.0")
]
)
Next, add UserDefaultsStore to your targets dependencies like so:
.target(
name: "YOUR_TARGET_NAME",
dependencies: [
"UserDefaultsStore",
]
),Then run swift package update.
CocoaPods
To integrate UserDefaultsStore into your Xcode project using CocoaPods, specify it in your Podfile:
pod 'UserDefaultsStore'Carthage
To integrate UserDefaultsStore into your Xcode project using Carthage, specify it in your Cartfile:
github "omaralbeik/UserDefaultsStore" ~> 2.0.0
Usage
Let's say you have 2 structs; User and Laptop defined as bellow:
struct User: Codable {
var id: Int
var firstName: String
var lastName: String
var laptop: Laptop?
}
struct Laptop: Codable {
var model: String
var name: String
}
Here is how you store them in UserDefaultsStore:
1. Conform to the Identifiable protocol and set the id property
The Identifiable protocol lets UserDefaultsStore knows what is the unique id for each object.
struct User: Codable, Identifiable {
...
}
struct Laptop: Codable, Identifiable {
var id: String { model }
...
}
2. Create UserDefaults Stores
let usersStore = UserDefaultsStore<User>(uniqueIdentifier: "users")
let laptopsStore = UserDefaultsStore<Laptop>(uniqueIdentifier: "laptops")
3. VoilĂ , you're all set!
let macbook = Laptop(model: "A1278", name: "MacBook Pro")
let john = User(id: 1, firstName: "John", lastName: "Appleseed", laptop: macbook)
// Save an object to a store
try! usersStore.save(john)
// Save an array of objects to a store
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()
// Check if store has an object
print(usersStore.hasObject(withId: 10)) // false
// Iterate over all objects in a store
laptopsStore.forEach { laptop in
print(laptop.name)
}
// Delete an object from a store
usersStore.delete(withId: 1)
// Delete all objects in a store
laptops.deleteAll()
// Know how many objects are stored in a store
let usersCount = usersStore.objectsCount
// Create a snapshot
let snapshot = usersStore.generateSnapshot()
// Restore a pre-generated snapshot
try? usersStore.restoreSnapshot(snapshot)
Looking to store a single item only?
Use SingleUserDefaultsStore, it enables storing and retrieving a single value of Int, Double, String, or any Codable type.
Requirements
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
- Swift 5.0+
Thanks
Special thanks to:
- Paul Hudson for his article on how to use Swift keypaths to write more natural code.
- Batuhan Saka for translating this document into Turkish.
Credits
Icon made by freepik from flaticon.com.
License
UserDefaultsStore is released under the MIT license. See LICENSE for more information.
17 Sep 20, 2022
557 Nov 22, 2022
1.3k Jan 6, 2023
1.4k Dec 26, 2022
845 Jan 6, 2023
7 Dec 13, 2022
24 Aug 30, 2022
5.2k Dec 11, 2022
1 Feb 27, 2022
452 Oct 17, 2022
65 Oct 23, 2022
2 Oct 6, 2022
12 May 9, 2022
4 Aug 22, 2022
4 Jan 28, 2022
369 Jan 8, 2023
149 Dec 15, 2022
251 Jan 8, 2023