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 Codable objects to various persistence layers, in a few lines of code!
Persistence Layers
PersistenceKit offers 3 layers of persistence suitable for most use cases:
1. UserDefaults
- Stores data using
UserDefaults. - Suitable for storing a reasonable number of objects.
2. Files
- Stores data directly to directories in the app's documents directory using
FileManager. - Suitable for storing large number of objects.
3. Keychain
- Stores data to OS's keychain using the
Security Framework. - Suitable for storing sensitive data, like access tokens.
What's new in v1.3
v1.3 brings Swift 5.0 support
Installation
CocoaPods
To integrate PersistenceKit into your Xcode project using CocoaPods, specify it in your Podfile:
pod 'PersistenceKit'Carthage
To integrate PersistenceKit into your Xcode project using Carthage, specify it in your Cartfile:
github "Teknasyon-Teknoloji/PersistenceKit"
Swift Package Manager
You can use The Swift Package Manager to install PersistenceKit 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/Teknasyon-Teknoloji/PersistenceKit.git", from: "0.1")
]
)
Note that the Swift Package Manager is still in early design and development, for more information checkout its GitHub Page
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
}
1. Conform to the Identifiable protocol and set the idKey property
The Identifiable protocol lets PersistenceKit knows what is the unique id for each object.
struct User: Codable, Identifiable {
static let idKey = \User.id
...
}
struct Laptop: Codable, Identifiable {
static let idKey = \Laptop.model
...
}
Notice how
UserusesIntfor its id, whileLaptopusesString, in fact the id can be any type. PersistenceKit uses Swift keypaths to refer to properties without actually invoking them. Swift rocks🤘
2 Create Stores
// To save objects to UserDefaults, create UserDefaultsStore: let usersStore = UserDefaultsStore<User>(uniqueIdentifier: "users")! let laptopsStore = UserDefaultsStore<Laptop>(uniqueIdentifier: "laptops")! // To save a single object to UserDefaults, create UserDefaultsStore: let userStore = SingleUserDefaultsStore<User>(uniqueIdentifier: "user")! // To save objects to the file system, create FilesStore: let usersStore = FilesStore<User>(uniqueIdentifier: "users") let laptopsStore = FilesStore<Laptop>(uniqueIdentifier: "laptops") // To save a single object to the file system, create SingleFilesStore: let userStore = SingleFilesStore<User>(uniqueIdentifier: "user") // To save a single object to the system's keychain, create SingleKeychainStore: let userStore = SingleKeychainStore<User>(uniqueIdentifier: "user")
3. Voilà, you're all set!
let macbook = Laptop(model: "A1278", name: "MacBook Pro")
let john = User(userId: 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
Requirements
- iOS 8.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+
- Xcode 10.0+
- Swift 4.2+
Thanks
Special thanks to:
- Paul Hudson for his article on how to use Swift keypaths to write more natural code.
Credits
- Icon made by freepik from flaticon.com.
License
PersistenceKit is released under the MIT license. See LICENSE for more information.
17 Sep 24, 2022
47 Nov 3, 2022
56 Nov 5, 2022
173 Dec 30, 2022
3.3k Dec 29, 2022
67 Aug 7, 2022
119 Dec 21, 2022
6 May 13, 2022
252 Nov 4, 2022
65 Oct 23, 2022
452 Oct 17, 2022
36 Dec 20, 2022
6 Sep 28, 2022
620 Dec 3, 2022
489 Sep 9, 2022
475 Dec 20, 2022
19 Nov 25, 2022
372 Dec 7, 2022
380 Dec 19, 2022