Keychain dependency implementation

.github/workflows/code-quality.yml

@@ -0,0 +1,16 @@
+name: Code Quality
+
+on:
+  workflow_dispatch:
+  pull_request:
+
+jobs:
+  SwiftLint:
+    name: Swift files are formatted
+    runs-on: self-hosted
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: SwiftLint
+        run: swiftlint --quiet --reporter github-actions-logging

.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: Test
+
+on:
+  workflow_dispatch:
+  pull_request:
+
+jobs:
+  Test:
+    name: Unit tests pass
+    runs-on: self-hosted
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - id: cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            .build
+            .swiftpm
+          key: ${{ runner.os }}-cache
+      - run: swift test

.swiftlint.yml

@@ -1,11 +1,9 @@
 disabled_rules:
-  - closure_parameter_position
   - identifier_name
   - multiple_closures_with_trailing_closure
+  - todo
 opt_in_rules:
-  - attributes
   - closure_end_indentation
-  - closure_parameter_position
   - closure_spacing
   - contains_over_filter_count
   - contains_over_filter_is_empty
@@ -19,11 +17,9 @@ opt_in_rules:
   - first_where
   - flatmap_over_map_reduce
   - indentation_width
-  - legacy_random
   - literal_expression_end_indentation
   - lower_acl_than_parent
   - operator_usage_whitespace
-  - redundant_nil_coalescing
   - redundant_type_annotation
   - sorted_first_last
   - sorted_imports
@@ -35,8 +31,8 @@ opt_in_rules:
   - vertical_parameter_alignment_on_call
   - yoda_condition
 excluded:
-  - .build
-  - .swiftpm
+  - "**/.build/"
+  - "**/.swiftpm/"
 indentation_width:
   include_comments: false
   include_compiler_directives: false

Package.swift

@@ -1,13 +1,30 @@
-// swift-tools-version:5.9
+// swift-tools-version:6.0
 import PackageDescription
 
 let package = Package(
-	name: "SwiftPackage",
+	name: "keychain",
+	platforms: [
+		.iOS(.v16),
+		.macOS(.v13),
+		.tvOS(.v16),
+		.visionOS(.v1),
+		.watchOS(.v9)
+	],
 	products: [
-		.library(name: "SwiftPackage", targets: ["SwiftPackage"])
+		.library(name: "Keychain", targets: ["Keychain"])
+	],
+	dependencies: [
+		.package(url: "https://github.com/pointfreeco/swift-dependencies", from: "1.9.1"),
+		.package(url: "https://github.com/square/Valet", from: "5.0.0")
 	],
 	targets: [
-		.target(name: "SwiftPackage"),
-		.testTarget(name: "SwiftPackageTests", dependencies: ["SwiftPackage"])
+		.target(
+			name: "Keychain",
+			dependencies: [
+				.product(name: "Dependencies", package: "swift-dependencies"),
+				.product(name: "Valet", package: "Valet")
+			]
+		),
+		.testTarget(name: "KeychainTests", dependencies: ["Keychain"])
 	]
 )

README.md

@@ -1,7 +1,3 @@
-# Swift Package Repository Template
+# Keychain dependency
 
-This is a project template for Swift packages.
-
-* Sensible `.gitignore`
-* `.swiftlint.yml` for linting
-* `.editorconfig` enforcing tabs with a size of 2.
+Vends a [dependency](https://github.com/pointfreeco/swift-dependencies) for accessing the keychain

Sources/Keychain/InMemoryKeychain.swift

@@ -0,0 +1,33 @@
+import Dependencies
+import Foundation
+import os
+
+public final class InMemoryKeychain {
+
+	private static let data = OSAllocatedUnfairLock(initialState: [String: Data]())
+
+	init() {}
+
+	private let encoder = JSONEncoder()
+	private let decoder = JSONDecoder()
+
+}
+
+// MARK: Keychain
+
+extension InMemoryKeychain: Keychain {
+
+	public func load<T>(key: String) throws -> T where T: Decodable {
+		return try decoder.decode(T.self, from: InMemoryKeychain.data.withLock { $0[key] } ?? Data())
+	}
+
+	public func save<T>(key: String, value: T) throws where T: Encodable {
+		let data = try encoder.encode(value)
+		InMemoryKeychain.data.withLock { $0[key] = data }
+	}
+
+	public func delete(key: String) throws {
+		_ = InMemoryKeychain.data.withLock { $0.removeValue(forKey: key) }
+	}
+
+}

Sources/Keychain/Keychain+Dependencies.swift

@@ -0,0 +1,19 @@
+import Dependencies
+import Foundation
+
+extension DependencyValues {
+
+	public var keychain: any Keychain {
+		get { self[KeychainDependencyKey.self] }
+		set { self[KeychainDependencyKey.self] = newValue }
+	}
+
+}
+
+public enum KeychainDependencyKey: DependencyKey {
+	public static let liveValue: any Keychain = ValetKeychain()
+}
+
+extension KeychainDependencyKey: TestDependencyKey {
+	public static let testValue: any Keychain = InMemoryKeychain()
+}

Sources/Keychain/Keychain.swift

@@ -0,0 +1,13 @@
+import Foundation
+
+public protocol Keychain: Sendable {
+
+	@inlinable
+	func load<T>(key: String) throws -> T where T: Decodable
+
+	@inlinable
+	func save<T>(key: String, value: T) throws where T: Encodable
+
+	func delete(key: String) throws
+
+}

Sources/Keychain/KeychainConfiguration+Dependencies.swift

@@ -0,0 +1,20 @@
+import Dependencies
+import Foundation
+import XCTestDynamicOverlay
+
+extension DependencyValues {
+
+	public var keychainConfiguration: KeychainConfiguration {
+		get { self[KeychainConfiguration.self] }
+		set { self[KeychainConfiguration.self] = newValue }
+	}
+
+}
+
+extension KeychainConfiguration: TestDependencyKey {
+
+	public static var testValue: KeychainConfiguration {
+		KeychainConfiguration(type: .local, identifier: Identifier.identifier("test"), accessibility: .afterFirstUnlock)
+	}
+
+}

Sources/Keychain/KeychainConfiguration.swift

@@ -0,0 +1,34 @@
+import Foundation
+
+public struct KeychainConfiguration: Hashable, Sendable {
+
+	public let type: Type
+	public let identifier: Identifier
+	public let accessibility: Accessibility
+
+	public init(
+		type: `Type`,
+		identifier: Identifier,
+		accessibility: Accessibility
+	) {
+		self.type = type
+		self.identifier = identifier
+		self.accessibility = accessibility
+	}
+
+	public enum `Type`: Hashable, Sendable {
+		case iCloud
+		case local
+	}
+
+	public enum Identifier: Hashable, Sendable {
+		case identifier(String)
+		case sharedGroup(appIDPrefix: String, groupIdentifier: String)
+	}
+
+	public enum Accessibility: Hashable, Sendable {
+		case whenUnlocked
+		case afterFirstUnlock
+	}
+
+}