Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/naru-jpn/pencil
Super lightweight DB written in Swift.
https://github.com/naru-jpn/pencil
carthage coccoapods complex-values enum pencil swift
Last synced: about 1 month ago
JSON representation
Super lightweight DB written in Swift.
- Host: GitHub
- URL: https://github.com/naru-jpn/pencil
- Owner: naru-jpn
- License: mit
- Created: 2016-10-10T07:13:49.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-25T14:04:24.000Z (over 6 years ago)
- Last Synced: 2024-07-18T13:23:47.064Z (2 months ago)
- Topics: carthage, coccoapods, complex-values, enum, pencil, swift
- Language: Swift
- Homepage:
- Size: 874 KB
- Stars: 90
- Watchers: 9
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - Pencil - Write values to file and read it more easily. (Data Structures / Algorithms / Getting Started)
- awesome-swift - Pencil - Write any value to file. (Libs / Data Management)
- awesome-swift - Pencil - Write any value to file. (Libs / Data Management)
- fucking-awesome-swift - Pencil - Write any value to file. (Libs / Data Management)
- awesome-ios-star - Pencil - Write values to file and read it more easily. (Data Structures / Algorithms / Getting Started)
- awesome-swift - Pencil - Super lightweight DB written in Swift. (Data Management [🔝](#readme))
README
Use of value types is recommended and we define standard values, simple structured data, application state and etc. as struct or enum.
Pencil makes us store these values more easily.
## Installation
__Carthage__
```
github "naru-jpn/Pencil"
```
__CocoaPods__
```
pod 'pencil'
```
__Swift Package Manager__
Compatible.
__Manually__
Copy all `*.swift` files contained in `Sources` directory into your project.
## Recommeded / Example
- __Application state such as tab index application selected at last time.__
- You can write `Int` value into file on device and read it.
- __Recently user inserted textfield value.__
- You can write `String` value into file named for each textfield and read it.
- __Structured data without any DB system.__
- You can write struct values into file on device and read it.
## Usage
### Standard values
#### Int
```swift
// (create stored url)
guard let storedURL = Directory.Documents?.append(path: "int.data") else {
return
}
let num: Int = 2016
// write
num.write(to: storedURL)
// ...
// read
let stored: Int? = Int.value(from: storedURL)
```
#### String
```swift
let text: String = "Pencil store value easily."
text.write(to: storedURL)
// ...
let stored: String? = String.value(from: storedURL)
```
#### Array (containing writable values)
```swift
let nums: [Int] = [2016, 11, 28]
nums.write(to: storedURL)
// ...
let stored: [Int]? = [Int].value(from: storedURL)
```
#### Dictionary (contaning writable values with string key)
```swift
let dictionary: [String: Int] = ["year": 2016, "month": 11, "day": 28]
dictionary.write(to: storedURL)
// ...
let stored: [String: Int]? = [String: Int].value(from: url)
```
Other standard writable and readable values are `Set`, `Bool`, `Float`, `Double`, `Date`, `Int8`, `Int16`, `Int32`, `Int64`, `UInt`, `UInt8`, `UInt16`, `UInt32` and `UInt64`.
### Enum
#### Define writable and readable enum
Type of raw value should conform `ReadWriteElement` and add `ReadWriteElement` for enum.
```
enum Sample: Int, ReadWriteElement {
case one = 1
case two = 2
}
```
#### write to file / read from file path
Read and write values by the same way with standard values.
```swift
let sample: Sample = .two
sample.write(to: storedURL)
// ...
let stored: Sample? = Sample.value(from: url)
```
### Custom struct
#### Define writable and readable custom struct
1. Define custom struct (named `Sample` in this case).
1. Conform protocol `CustomReadWriteElement`.
1. Implement function `static func read` and return `Sample` or `nil`.
- Apply each parameters with parameter name.
```swift
struct Sample: CustomReadWriteElement {
let dictionary: [String: Int]
let array: [Int]?
let identifier: String
static func read(components: Components) -> Sample? {
do {
return try Sample(
dictionary: components.component(for: "dictionary"),
    array: components.component(for: "array"),
identifier: components.component(for: "identifier")
)
} catch {
return nil
}
}
}
```
#### write to file / read from file path
Read and write values by the same way with standard values.
```swift
let sample: Sample = Sample(dictionary: ["one": 2, "two": 5], array: [2, 3], identifier: "abc123")
sample.write(to: storedURL)
// ...
let stored: Sample? = Sample.value(from: url)
```
#### Complex values containing custom struct
You can now write and read complex values containing custom struct.
```swift
let sample: Sample = Sample(dictionary: ["one": 2, "two": 5], array: [2, 3], identifier: "abc123")
let samples: [Samples] = [sample, sample, sample]
samples.write(to: storedURL)
// ...
let stored: [Sample]? = [Sample].value(from: url)
```
#### Read struct with default parameters
Define custom struct with default parameters. You need not to `try` if all properties have default values or optional.
```swift
struct Sample: CustomReadWriteElement {
let dictionary: [String: Int]
let array: [Int]?
let identifier: String
static func read(components: Components) -> Sample? {
return Sample(
dictionary: components.component(for: "dictionary", defaultValue: ["default": 100]),
      array: components.component(for: "array"),
identifier: components.component(for: "identifier", defaultValue: "default")
)
}
}
```
### Create stored file path
Pencil support to create file path using class `Directory`.
```swift
// Create path ~/Documents/pencil.data
let url: URL? = Directory.Documents?.append(path: "pencil.data")
```
Other directories are `Applications`, `Demos`, `Documentation`, `Documents`, `AutosavedInformation`, `Caches` and `Downloads`.
## Example
[PencilExample](https://github.com/naru-jpn/pencil/tree/master/Example)
## License
Pencil is released under the MIT license. See LICENSE for details.