Defaults/Sources/Defaults.swift

155 lines
3.4 KiB
Swift
Raw Permalink Normal View History

2018-04-12 01:19:30 +08:00
// MIT License © Sindre Sorhus
import Foundation
2018-04-12 01:19:30 +08:00
public final class Defaults {
public class Keys {
public typealias Key = Defaults.Key
public typealias OptionalKey = Defaults.OptionalKey
fileprivate init() {}
}
2018-04-12 01:19:30 +08:00
public final class Key<T: Codable>: Keys {
public let name: String
public let defaultValue: T
public let suite: UserDefaults
2018-04-12 01:19:30 +08:00
public init(_ key: String, default defaultValue: T, suite: UserDefaults = .standard) {
2018-04-12 01:19:30 +08:00
self.name = key
self.defaultValue = defaultValue
self.suite = suite
super.init()
// Sets the default value in the actual UserDefaults, so it can be used in other contexts, like binding.
if UserDefaults.isNativelySupportedType(T.self) {
suite.register(defaults: [key: defaultValue])
} else if let value = suite._encode(defaultValue) {
suite.register(defaults: [key: value])
}
2018-04-12 01:19:30 +08:00
}
}
public final class OptionalKey<T: Codable>: Keys {
public let name: String
public let suite: UserDefaults
2018-04-12 01:19:30 +08:00
public init(_ key: String, suite: UserDefaults = .standard) {
2018-04-12 01:19:30 +08:00
self.name = key
self.suite = suite
2018-04-12 01:19:30 +08:00
}
}
fileprivate init() {}
2018-04-12 01:19:30 +08:00
public subscript<T: Codable>(key: Defaults.Key<T>) -> T {
get {
return key.suite[key]
2018-04-12 01:19:30 +08:00
}
set {
key.suite[key] = newValue
2018-04-12 01:19:30 +08:00
}
}
public subscript<T: Codable>(key: Defaults.OptionalKey<T>) -> T? {
get {
return key.suite[key]
2018-04-12 01:19:30 +08:00
}
set {
key.suite[key] = newValue
2018-04-12 01:19:30 +08:00
}
}
public func clear(suite: UserDefaults = .standard) {
for key in suite.dictionaryRepresentation().keys {
suite.removeObject(forKey: key)
2018-04-12 01:19:30 +08:00
}
}
}
// Has to be `defaults` lowercase until Swift supports static subscripts
public let defaults = Defaults()
2018-06-29 16:49:06 +08:00
extension UserDefaults {
2018-04-12 01:19:30 +08:00
private func _get<T: Codable>(_ key: String) -> T? {
if UserDefaults.isNativelySupportedType(T.self) {
2018-04-12 01:19:30 +08:00
return object(forKey: key) as? T
}
2018-06-29 16:49:06 +08:00
guard
let text = string(forKey: key),
let data = "[\(text)]".data(using: .utf8)
else {
return nil
2018-04-12 01:19:30 +08:00
}
do {
return (try JSONDecoder().decode([T].self, from: data)).first
} catch {
print(error)
}
return nil
}
fileprivate func _encode<T: Codable>(_ value: T) -> String? {
2018-04-12 01:19:30 +08:00
do {
// Some codable values like URL and enum are encoded as a top-level
// string which JSON can't handle, so we need to wrap it in an array
// We need this: https://forums.swift.org/t/allowing-top-level-fragments-in-jsondecoder/11750
let data = try JSONEncoder().encode([value])
return String(String(data: data, encoding: .utf8)!.dropFirst().dropLast())
2018-04-12 01:19:30 +08:00
} catch {
print(error)
return nil
2018-04-12 01:19:30 +08:00
}
}
private func _set<T: Codable>(_ key: String, to value: T) {
if UserDefaults.isNativelySupportedType(T.self) {
set(value, forKey: key)
return
}
set(_encode(value), forKey: key)
}
2018-04-12 01:19:30 +08:00
public subscript<T: Codable>(key: Defaults.Key<T>) -> T {
get {
return _get(key.name) ?? key.defaultValue
}
set {
_set(key.name, to: newValue)
}
}
public subscript<T: Codable>(key: Defaults.OptionalKey<T>) -> T? {
get {
return _get(key.name)
}
set {
guard let value = newValue else {
set(nil, forKey: key.name)
return
2018-04-12 01:19:30 +08:00
}
_set(key.name, to: value)
2018-04-12 01:19:30 +08:00
}
}
fileprivate static func isNativelySupportedType<T>(_ type: T.Type) -> Bool {
2018-04-12 01:19:30 +08:00
switch type {
case is Bool.Type,
is String.Type,
is Int.Type,
is Double.Type,
is Float.Type,
2018-04-16 02:09:53 +08:00
is Date.Type,
is Data.Type:
2018-04-12 01:19:30 +08:00
return true
default:
return false
}
}
}