Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nickoneill/Pantry
The missing light persistence layer for Swift
https://github.com/nickoneill/Pantry
Last synced: 5 days ago
JSON representation
The missing light persistence layer for Swift
- Host: GitHub
- URL: https://github.com/nickoneill/Pantry
- Owner: nickoneill
- License: mit
- Created: 2015-10-26T22:58:27.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-05-30T12:21:06.000Z (over 6 years ago)
- Last Synced: 2024-05-30T02:37:32.593Z (7 months ago)
- Language: Swift
- Homepage:
- Size: 136 KB
- Stars: 832
- Watchers: 19
- Forks: 55
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - Pantry - The missing light persistence layer for Swift. (Utility / Web View)
- awesome-ios-architecture - Pantry
- awesome-ios-star - Pantry - The missing light persistence layer for Swift. (Utility / Web View)
README
## If you're planning on using Swift 4 in the near future, please consider using the new [Codable](https://developer.apple.com/documentation/swift/codable) protocols which provide the same functionality as Pantry in the core Swift library. Pantry will not be supported going forward.
Installation
• Issues
• License
#### Please join us in [issues](https://github.com/nickoneill/Pantry/issues) if you'd like to help us get to 1.0. And read about more [use cases for Pantry](https://medium.com/ios-os-x-development/the-missing-light-persistence-layer-for-swift-35ce75d02d47).
Pantry is a lightweight way to persist structs containing user data, cached content or other relevant objects for later retrieval.
```swift
let someCustomStruct = SomeCustomStruct(...)
Pantry.pack(someCustomStruct, "user_data")
... later ...
if let unpackedCustomStruct: SomeCustomStruct = Pantry.unpack("user_data") {
print("got my data out",unpackedCustomStruct)
} else {
print("there was no struct data to get")
}
```
You can store:
* [x] Structs
* [x] Strings, Ints and Floats (our default types)
* [x] Arrays of structs and default types
* [x] Nested structs
* [ ] Nested Arrays
* [x] Classes
* [x] Arrays of classes and default types
* [x] Nested classes
* [x] Enums with raw types
Check out [the tests](https://github.com/nickoneill/Pantry/blob/master/PantryTests/) for a detailed look at the varied types you can easily store.
## Compatibility
Pantry requires iOS 8+ and is compatible with **Swift 3** projects. Please use release `0.2.2` for the final Swift 2.x supported version, or the `swift2` branch. Objective-C support is unlikely.
## Installation
Installation for [Carthage](https://github.com/Carthage/Carthage) is simple enough:
`github "nickoneill/Pantry" ~> 0.3`
As for [CocoaPods](https://cocoapods.org), use this to get the latest release:
```ruby
use_frameworks!
pod 'Pantry'
```
And `import Pantry` in the files you'd like to use it.
## Usage
### Basic types
Pantry provides serialization of some basic types (`String`, `Int`, `Float`, `Bool`) with no setup. You can use it as a simple expiring cache like this:
```swift
if let available: Bool = Pantry.unpack("promptAvailable") {
completion(available: available)
} else {
anExpensiveOperationToDetermineAvailability({ (available) -> () in
Pantry.pack(available, key: "promptAvailable", expires: .Seconds(60 * 10))
completion(available: available)
})
}
```
### Automagic Persistent Variables
Use Swift's get/set to automatically persist the value of a variable on write and get the latest value on read.
```swift
var autopersist: String? {
set {
if let newValue = newValue {
Pantry.pack(newValue, key: "autopersist")
}
}
get {
return Pantry.unpack("autopersist")
}
}
...later...
autopersist = "Hello!"
// restart app, reboot phone, etc
print(autopersist) // Hello!
```
### Structs
Add the `Storable` protocol to any struct you want stored and then ensure they comply by implementing an `init` method that gets each property from the warehouse, and a `toDictionary` method that converts the other way:
```swift
struct Basic: Storable {
let name: String
let age: Float
let number: Int
init(warehouse: Warehouseable) {
self.name = warehouse.get("name") ?? "default"
self.age = warehouse.get("age") ?? 20.5
self.number = warehouse.get("number") ?? 10
}
func toDictionary() -> [String : Any] {
return [ "name": self.name, "age": self.age, "number": self.number ]
}
}
```
Getters always provide an optional value, leaving you the opportunity to fill in a default if a value isn't available. This makes for hassle-free property additions to your structs.
### Classes
Classes are also supported and can be setup the same way Structs are however the init method must be marked `required` in this case. Class inheritance and nested `Storable` properties are also possible:
```swift
class ModelBase: Storable {
let id: String
required init(warehouse: Warehouseable) {
self.id = warehouse.get("id") ?? "default_id"
}
func toDictionary() -> [String : Any] {
return [ "id": self.id ]
}
}
class BasicClassModel: ModelBase {
let name: String
let age: Float
let number: Int
required init(warehouse: Warehouseable) {
self.name = warehouse.get("name") ?? "default"
self.age = warehouse.get("age") ?? 20.5
self.number = warehouse.get("number") ?? 10
super.init(warehouse: warehouse)
}
func toDictionary() -> [String : Any] {
var dictionary = super.toDictionary()
dictionary["name"] = self.name
dictionary["age"] = self.age
dictionary["number"] = self.number
return dictionary
}
}
```
## Also
Pantry works great with network data when paired with a JSON struct decoder such as [Unbox](https://github.com/JohnSundell/Unbox). Download JSON, decode it with Unbox, save it with Pantry and have it available for as long as you need. The architecture of Pantry is heavily influenced by Unbox, it's worth a look in any case.
## License
Pantry uses the MIT license. Please file an issue if you have any questions or if you'd like to share how you're using this tool.
## ack
Pantry "can icon" by [CDH from the Noun Project](https://thenounproject.com/term/soup-can/49680/)