UserDefaultSugar

Overview

UserDefaultSugar is a Swift library that provides a simple and convenient way to work with UserDefaults. It includes extensions for UserDefaults that allow you to easily store and retrieve Codable objects, check if a key exists, and more.

Usage

To use UserDefaultSugar in your project, simply add the following line to your Package.swift file:

`"github.com/eonist/UserDefaultSugar" branch: "master"`

Then, import the library in your Swift file: import UserDefaultSugar

You can then use the various extensions provided by the library. For example, to print all data stored in UserDefaults, use:

UserDefaults.debug()

To remove all data stored in UserDefaults, use:

UserDefaults.removeAll()

To check if a key exists in UserDefaults, use:

let exists = UserDefaults.standard.exists(keyName: "myKey")

To store a Codable object in UserDefaults, use:

let myObject = MyObject()
UserDefaults.standard.set(object: myObject, forKey: "myKey")

To retrieve a Codable object from UserDefaults, use:

if let myObject = try? UserDefaults.standard.get(objectType: MyObject.self, forKey: "myKey") {
    // Do something with myObject
}

Examples:

import UserDefaultSugar

struct Prefs: UserDefKind {
      var allowTelemetry: Bool
      var userName: String

      static var key: String { "app-name-prefs" }

      static var defaultModel: Self {
         return Prefs(allowTelemetry: true, userName: "John Doe")
      }
}

// Accessing the model
var prefs = Prefs.model
prefs.userName = "James" // Modify the property
Prefs.model = prefs       // Save the updated model back to UserDefaults

Blog post about using userDefaults

http://eon.codes/blog/2018/09/18/userdefaults/

Resources

• SwiftyUserDefaults Another popular library for working with UserDefaults in Swift.
• Share UserDefault between app and extension See for more details: A Stack Overflow post that explains how to share UserDefaults between an app and its extensions.
• Blog post about using UserDefaults: A blog post that provides an overview of UserDefaults and how to use it in Swift.

Todo:

• Make examples using UserDefKind
• Make headless xcodeproj?
• Add support for UserDefaults(suiteName: "group.your.bundle.here") etc
• Add Unit-tests 👈
• Implementing unit tests ensures your code works as expected and prevents future regressions. Here's an example test case:

// Tests/UserDefaultSugarTests/UserDefaultSugarTests.swift
import XCTest
@testable import UserDefaultSugar

final class UserDefaultSugarTests: XCTestCase {
      func testUserDefKind() {
         struct TestPrefs: UserDefKind {
            var value: String

            static var key: String { "test-prefs" }

            static var defaultModel: Self {
                  return TestPrefs(value: "default")
            }
         }

         var prefs = TestPrefs.model
         prefs.value = "updated"
         TestPrefs.model = prefs

         let retrievedPrefs = TestPrefs.model
         XCTAssertEqual(retrievedPrefs.value, "updated")
      }
}

• Allow users to specify custom UserDefaults instances, such as those for app groups or testing.

  public protocol UserDefKind: Codable {
      static var key: String { get }
      static var defaultModel: Self { get }
      static var userDefaults: UserDefaults { get }
  }
  
  extension UserDefKind {
      public static var userDefaults: UserDefaults {
          return .standard
      }
  }

  Users can override userDefaults when conforming to UserDefKind.

  struct GroupPrefs: UserDefKind {
      var sharedValue: String
  
      static var key: String { "group-prefs" }
  
      static var defaultModel: Self {
          return GroupPrefs(sharedValue: "default")
      }
  
      static var userDefaults: UserDefaults {
          return UserDefaults(suiteName: "group.com.your.app") ?? .standard
      }
  }