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
Intvalue into file on device and read it.
- You can write
- Recently user inserted textfield value.
- You can write
Stringvalue into file named for each textfield and read it.
- You can write
- Structured data without any DB system.
- You can write struct values into file on device and read it.
Usage
Standard values
Int
// (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
let text: String = "Pencil store value easily."
text.write(to: storedURL)
// ...
let stored: String? = String.value(from: storedURL)
Array (containing writable values)
let nums: [Int] = [2016, 11, 28]
nums.write(to: storedURL)
// ...
let stored: [Int]? = [Int].value(from: storedURL)
Dictionary (contaning writable values with string key)
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.
let sample: Sample = .two
sample.write(to: storedURL)
// ...
let stored: Sample? = Sample.value(from: url)
Custom struct
Define writable and readable custom struct
- Define custom struct (named
Samplein this case). - Conform protocol
CustomReadWriteElement. - Implement function
static func readand returnSampleornil.
- Apply each parameters with parameter name.
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.
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.
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.
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.
// 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
License
Pencil is released under the MIT license. See LICENSE for details.
25 May 15, 2022
27.3k Jan 8, 2023
1 Jun 17, 2020
2k Dec 29, 2022
628 Dec 29, 2022
270 Dec 2, 2022
7 Mar 17, 2022
3.3k Jan 4, 2023
0 Oct 21, 2021
2.7k Jan 5, 2023
1.3k Dec 20, 2022
2.1k Dec 28, 2022
120 Sep 9, 2022
4.2k Jan 4, 2023
2.5k Dec 26, 2022
348 Aug 2, 2022
700 Dec 16, 2022
166 Oct 6, 2022