jrtibbetts/Stylobate

View on GitHub
Source/Util/Settings.swift

Summary

Maintainability
A
0 mins
Test Coverage
//  Copyright © 2019 Poikile Creations. All rights reserved.

import Foundation

/// A useful wrapper for the `UserDefaults`. The `defaults` point to the
/// `UserDefaults.standard` ones, but it can be changed for things like unit
/// testing. To use it in an app, create an extension with the desired
/// properties, and provide a `get` and `set` for each one that calls these
/// utility ones, like
///
///    public static var someSize: CGFloat {
//
///        get {
///            return Settings.get(key: "someSize", defaultValue: 24.0)
///        }
//
///        set {
///            Settings.set(newValue, forKey: "someSize")
///        }
///    }
public struct Settings {

    public static var defaults: UserDefaults = UserDefaults.standard

    public static func get<T>(key: String, defaultValue: T) -> T {
        // This was a one-liner, but breaking it out makes it easier to debug.
        let value = Settings.defaults.value(forKey: key)
        let typedValue = value as? T

        return typedValue ?? defaultValue
    }

    public static func set<T>(_ value: T, forKey key: String) {
        Settings.defaults.set(value, forKey: key)
    }

}