Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rebeloper/swiftyplistmanager
Lightweight plist data management framework for iOS 10.3+
https://github.com/rebeloper/swiftyplistmanager
apple datamanager ios plis-tool plist read-write swift-3 swift-4 swift4
Last synced: 3 months ago
JSON representation
Lightweight plist data management framework for iOS 10.3+
- Host: GitHub
- URL: https://github.com/rebeloper/swiftyplistmanager
- Owner: rebeloper
- License: mit
- Created: 2017-04-19T16:12:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-04-10T11:13:12.000Z (over 4 years ago)
- Last Synced: 2024-10-12T14:40:36.428Z (3 months ago)
- Topics: apple, datamanager, ios, plis-tool, plist, read-write, swift-3, swift-4, swift4
- Language: Swift
- Homepage: http://rebeloper.com
- Size: 2.61 MB
- Stars: 77
- Watchers: 10
- Forks: 19
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](http://mit-license.org)
[](https://developer.apple.com/resources/)
[](https://developer.apple.com/swift)
[](https://developer.apple.com/swift)
[](http://cocoadocs.org/)
[](http://twitter.com/rebeloper)
SwiftyPlistManager is a lightweight plist data management framework for iOS 10.3+
## Step by step tutorial
I have written a [blog post on rebeloper.com](http://rebeloper.com/read-write-plist-file-swift/) with even more info on the usage of SwiftyPlistManager and handy images.
## YouTube series on how to use SwiftyPlistManager
Now you can watch my YouTube video series on how to use SwiftyPlistManager [here](https://www.youtube.com/watch?v=q5v6tqWdXiI&list=PL_csAAO9PQ8bKg79CX5PEfn886SMMDj3j).
## Screenshots
## Setup
SwiftyPlistManager needs template plist files to use them as the starting point of your data saving and loading. Basically on the first launch of the app it will copy it into it's Document directory and after that you'll be interacting with this copied version of the plist.
Just drag and drop (or create) your plist file(s) into your project. Optionaly you could edit the values to reflect your desired datastructure.
## Starting SwiftyPlistManager
**IMPORTANT**: You always have to "start" SwiftyPlistManager on every launch of your app. Let's assume you have an empty `Data.plist` file added to your project and you want to log Add the next line of code to your `application(_:didFinishLaunchingWithOptions:)` function in `Appdelegate.swift`
```swift
SwiftyPlistManager.shared.start(plistNames: ["Data"], logging: true)
```
Set `logging` to `true` if you want to log what's going on under the hood. Optionally, set it to `false` before release or when you are fed up with too much text in the console.
The `plistNames` parameter takes in an array of `String`s. You may start SwiftyPlistManager with as many plist file names as you'd like.
```swift
SwiftyPlistManager.shared.start(plistNames: ["Data", "OtherData"], logging: true)
```
## Usage
### Add new value
Before you can interact with any key-value pair you need to add it to your data structure. All types that are supported in plist files are suported. SwiftyPlistManager uses completion handlers so you can know when the operation has completed.
```swift
SwiftyPlistManager.shared.addNew("helloNewValue", key: "newKey", toPlistWithName: "Data") { (err) in
if err == nil {
print("Value successfully added into plist.")
}
}
```
### Save value
Next you want to edit your value. You just need to `save` a new value.
```swift
SwiftyPlistManager.shared.save("helloNewValue", forKey: "newKey", toPlistWithName: "Data") { (err) in
if err == nil {
print("Value successfully saved into plist.")
}
}
```
### Get value
If you want to get back the value in a completion handler you'll get back your `result` as an `Any?` object.
```swift
SwiftyPlistManager.shared.getValue(for: "newKey", fromPlistWithName: "Data") { (result, err) in
if err == nil {
print("The Value is: '\(result ?? "No Value Fetched")'")
}
}
```
### Fetch value
Most of the times you want to cast yor result into a constant right away and not wait for the completion handler to finish. You can use the following call to do just that. For this example we'll unwrap it with a `guard-let` statement.
```swift
guard let fetchedValue = SwiftyPlistManager.shared.fetchValue(for: "newKey", fromPlistWithName: "Data") else { return }
```
### Remove key-value pair
Once in a while you might want to remove a key-value pair.
```swift
SwiftyPlistManager.shared.removeKeyValuePair(for: "newKey", fromPlistWithName: "Data") { (err) in
if err == nil {
print("Key-Value pair successfully removed from plist")
}
}
```
### Remove all key-value pairs
Or you might want to delete all the data from your plist file.
```swift
SwiftyPlistManager.shared.removeAllKeyValuePairs(fromPlistWithName: "Data") { (err) in
if err == nil {
print("Successfully removed all Key-Value pairs from plist")
}
}
```
Note: this will not remove the plist from disk. It will just empty it from all the key-value pairs.
### Error handling
Let's talk about error-handling. When performing calls with SwiftyPlistManager you get access to possible errors in the completion handlers.
```swift
public enum SwiftyPlistManagerError: Error {
case fileNotWritten
case fileDoesNotExist
case fileUnavailable
case fileAlreadyEmpty
case keyValuePairAlreadyExists
case keyValuePairDoesNotExist
}
```
## Installation
### CocoaPods
SwiftyPlistManager can be installed as a [CocoaPod](https://cocoapods.org/) and builds as a Swift framework. To install, include this in your Podfile.
```ruby
use_frameworks!
pod 'SwiftyPlistManager'
```
Once installed, just ```import SwiftyPlistManager``` in your classes and you're good to go.
### Manualy
Clone or download the repo. Find the `SwiftyPlistManager.swift` file. Drag and drop it into your project and you're set up.
## Swift 3.1
| Language | Branch | Pod version | Xcode version |
| --------- | ------ | ----------- | ------------- |
| Swift 3.1 | [master](https://github.com/rebeloper/SwiftyPlistManager/tree/master) | >= 1.0.1 | Xcode 8.3 or greater|
| Swift 4 | [master](https://github.com/rebeloper/SwiftyPlistManager/tree/master) | >= 1.0.1 | Xcode 9 or greater|
## Change Log
See the [Releases Page](https://github.com/rebeloper/SwiftyPlistManager/releases)
## Known caveats
* You can manipulate the plist file only on the root-keys. Nested key-value pairs (like elemnts in a dictionary) cannot be accessed directly. You'll need to get the whole dictionary from the plist, make your changes, than finally save your changed dictionary back into the plist.
* The actual saving takes place under the hood in the Document directory. Because of this your changes will not be reflected in the plist file you added into your project.
## Sample Code
The project includes a demo app for iOS with a sample [ViewController.swift](https://github.com/rebeloper/SwiftyPlistManager/blob/master/SwiftyPlistManager/ViewController.swift) showing how to use SwiftyPlistManager.
## License
[MIT License](https://github.com/rebeloper/SwiftyPlistManager/blob/master/LICENSE.md)
Copyright (c) 2017 Alex Nagy
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.