Skip to content

armgit / peel

Public Imported from GitHub
0

Uninstall Mac apps with every file they leave behind, and see why each belongs. Free up space, fine-tune macOS, and set up Terminal.

Let Peel give Terminal a theme and take it back

Țugui Dragoș402ce50f73a4
diff --git a/Packages/PeelCore/Sources/PeelCore/Terminal/TerminalProfile.swift b/Packages/PeelCore/Sources/PeelCore/Terminal/TerminalProfile.swift
index 4d9d9219..e90b91cd 100644
--- a/Packages/PeelCore/Sources/PeelCore/Terminal/TerminalProfile.swift
+++ b/Packages/PeelCore/Sources/PeelCore/Terminal/TerminalProfile.swift
@@ -1,4 +1,5 @@
import AppKit
+import CryptoKit
public enum TerminalProfile {
public static func settings(for theme: TerminalTheme) throws -> [String: Any] {
@@ -28,6 +29,11 @@ public enum TerminalProfile {
return settings
}
+ public static func fingerprint(of settings: [String: Any]) -> String? {
+ guard let data = try? PropertyListSerialization.data(fromPropertyList: settings, format: .xml, options: 0) else { return nil }
+ return SHA256.hash(data: data).map { String(format: "%02x", $0) }.joined()
+ }
+
private static let ansiNames = ["Black", "Red", "Green", "Yellow", "Blue", "Magenta", "Cyan", "White"]
private static func archive(_ color: UInt32, alpha: CGFloat = 1) throws -> Data {
diff --git a/Packages/PeelCore/Sources/PeelCore/Terminal/TerminalSettingsStoring.swift b/Packages/PeelCore/Sources/PeelCore/Terminal/TerminalSettingsStoring.swift
new file mode 100644
index 00000000..dec35ac2
--- /dev/null
+++ b/Packages/PeelCore/Sources/PeelCore/Terminal/TerminalSettingsStoring.swift
@@ -0,0 +1,13 @@
+public enum TerminalProfileRole: String, CaseIterable, Sendable {
+ case newWindows = "Default Window Settings"
+ case startup = "Startup Window Settings"
+}
+
+public protocol TerminalSettingsStoring {
+ var isTerminalOpen: Bool { get }
+ var isManaged: Bool { get }
+ func profiles() -> [String: [String: Any]]
+ func setProfiles(_ profiles: [String: [String: Any]]) -> Bool
+ func profileName(for role: TerminalProfileRole) -> String?
+ func setProfileName(_ name: String?, for role: TerminalProfileRole) -> Bool
+}
diff --git a/Packages/PeelCore/Sources/PeelCore/Terminal/TerminalThemeLedger.swift b/Packages/PeelCore/Sources/PeelCore/Terminal/TerminalThemeLedger.swift
new file mode 100644
index 00000000..20101b40
--- /dev/null
+++ b/Packages/PeelCore/Sources/PeelCore/Terminal/TerminalThemeLedger.swift
@@ -0,0 +1,91 @@
+public struct TerminalThemeLedger {
+ public enum Outcome: Sendable, Equatable {
+ case changed
+ case unchanged
+ case terminalIsOpen
+ case managed
+ case refused
+ }
+
+ public private(set) var before: [TerminalProfileRole: String]?
+ public private(set) var chosen: String?
+ public private(set) var written: [String: String]
+
+ public init(stored: [String: Any] = [:]) {
+ before = (stored["before"] as? [String: String]).map { names in
+ Dictionary(uniqueKeysWithValues: names.compactMap { role, name in TerminalProfileRole(rawValue: role).map { ($0, name) } })
+ }
+ chosen = stored["chosen"] as? String
+ written = stored["written"] as? [String: String] ?? [:]
+ }
+
+ public var stored: [String: Any] {
+ var stored: [String: Any] = ["written": written]
+ if let before {
+ stored["before"] = Dictionary(uniqueKeysWithValues: before.map { ($0.key.rawValue, $0.value) })
+ }
+ if let chosen {
+ stored["chosen"] = chosen
+ }
+ return stored
+ }
+
+ public var canPutBack: Bool {
+ before != nil
+ }
+
+ public func theme(in terminal: some TerminalSettingsStoring) -> TerminalTheme? {
+ let name = terminal.profileName(for: .newWindows)
+ return TerminalThemeCatalog.all.first { $0.profileName == name }
+ }
+
+ public mutating func use(_ theme: TerminalTheme, in terminal: some TerminalSettingsStoring) throws -> Outcome {
+ guard !terminal.isTerminalOpen else { return .terminalIsOpen }
+ guard !terminal.isManaged else { return .managed }
+ let name = theme.profileName
+ let settings = try TerminalProfile.settings(for: theme)
+ guard let fingerprint = TerminalProfile.fingerprint(of: settings) else { return .refused }
+ var profiles = terminal.profiles()
+ let isStillPeels = written[name] != nil && profiles[name].flatMap(TerminalProfile.fingerprint(of:)) == written[name]
+ let rewritesProfile = profiles[name] == nil || (isStillPeels && written[name] != fingerprint)
+ let isInUse = TerminalProfileRole.allCases.allSatisfy { terminal.profileName(for: $0) == name }
+ guard rewritesProfile || !isInUse else { return .unchanged }
+ if rewritesProfile {
+ profiles[name] = settings
+ guard terminal.setProfiles(profiles) else { return .refused }
+ written[name] = fingerprint
+ }
+ if before == nil {
+ before = Dictionary(uniqueKeysWithValues: TerminalProfileRole.allCases.compactMap { role in
+ terminal.profileName(for: role).map { (role, $0) }
+ })
+ }
+ chosen = name
+ for role in TerminalProfileRole.allCases {
+ guard terminal.setProfileName(name, for: role) else { return .refused }
+ }
+ return .changed
+ }
+
+ public mutating func putBack(in terminal: some TerminalSettingsStoring) -> Outcome {
+ guard let before else { return .unchanged }
+ guard !terminal.isTerminalOpen else { return .terminalIsOpen }
+ guard !terminal.isManaged else { return .managed }
+ for role in TerminalProfileRole.allCases where terminal.profileName(for: role) == chosen {
+ guard terminal.setProfileName(before[role], for: role) else { return .refused }
+ }
+ let inUse = Set(TerminalProfileRole.allCases.compactMap { terminal.profileName(for: $0) })
+ var profiles = terminal.profiles()
+ let untouched = written.filter { name, fingerprint in
+ !inUse.contains(name) && profiles[name].flatMap(TerminalProfile.fingerprint(of:)) == fingerprint
+ }
+ if !untouched.isEmpty {
+ untouched.keys.forEach { profiles[$0] = nil }
+ guard terminal.setProfiles(profiles) else { return .refused }
+ }
+ self.before = nil
+ chosen = nil
+ written = [:]
+ return .changed
+ }
+}
diff --git a/Packages/PeelCore/Tests/PeelCoreTests/TerminalThemeLedgerTests.swift b/Packages/PeelCore/Tests/PeelCoreTests/TerminalThemeLedgerTests.swift
new file mode 100644
index 00000000..007b2d55
--- /dev/null
+++ b/Packages/PeelCore/Tests/PeelCoreTests/TerminalThemeLedgerTests.swift
@@ -0,0 +1,209 @@
+import Foundation
+@testable import PeelCore
+import Testing
+
+private final class InMemoryTerminalSettings: TerminalSettingsStoring {
+ var isTerminalOpen = false
+ var isManaged = false
+ var refusesWrites = false
+ var refusesNames = false
+ var storedProfiles: [String: [String: Any]] = ["Basic": ["name": "Basic"], "Pro": ["name": "Pro"]]
+ var names: [TerminalProfileRole: String] = [.newWindows: "Basic", .startup: "Basic"]
+
+ func profiles() -> [String: [String: Any]] {
+ storedProfiles
+ }
+
+ func setProfiles(_ profiles: [String: [String: Any]]) -> Bool {
+ guard !refusesWrites else { return false }
+ storedProfiles = profiles
+ return true
+ }
+
+ func profileName(for role: TerminalProfileRole) -> String? {
+ names[role]
+ }
+
+ func setProfileName(_ name: String?, for role: TerminalProfileRole) -> Bool {
+ guard !refusesWrites, !refusesNames else { return false }
+ names[role] = name
+ return true
+ }
+}
+
+struct TerminalThemeLedgerTests {
+ private let theme = TerminalThemeCatalog.all[0]
+ private let otherTheme = TerminalThemeCatalog.all[1]
+
+ @Test func aThemeInUseOpensEveryTerminalWindowWithIt() throws {
+ let terminal = InMemoryTerminalSettings()
+ var ledger = TerminalThemeLedger()
+
+ #expect(try ledger.use(theme, in: terminal) == .changed)
+ let written = try #require(terminal.storedProfiles[theme.profileName])
+ #expect(TerminalProfile.fingerprint(of: written) == TerminalProfile.fingerprint(of: try TerminalProfile.settings(for: theme)))
+ #expect(terminal.storedProfiles["Basic"] != nil)
+ #expect(terminal.names == [.newWindows: theme.profileName, .startup: theme.profileName])
+ #expect(ledger.theme(in: terminal) == theme)
+ #expect(ledger.canPutBack)
+ }
+
+ @Test func puttingBackGivesTerminalItsProfilesBackAndTakesPeelsAway() throws {
+ let terminal = InMemoryTerminalSettings()
+ terminal.names[.startup] = "Pro"
+ var ledger = TerminalThemeLedger()
+ _ = try ledger.use(theme, in: terminal)
+ _ = try ledger.use(otherTheme, in: terminal)
+
+ #expect(ledger.putBack(in: terminal) == .changed)
+ #expect(terminal.names == [.newWindows: "Basic", .startup: "Pro"])
+ #expect(Set(terminal.storedProfiles.keys) == ["Basic", "Pro"])
+ #expect(ledger.theme(in: terminal) == nil)
+ #expect(!ledger.canPutBack)
+ }
+
+ @Test func puttingBackLeavesNoChoiceWhereTerminalHadNone() throws {
+ let terminal = InMemoryTerminalSettings()
+ terminal.names = [:]
+ var ledger = TerminalThemeLedger()
+ _ = try ledger.use(theme, in: terminal)
+
+ #expect(ledger.putBack(in: terminal) == .changed)
+ #expect(terminal.names.isEmpty)
+ }
+
+ @Test func nothingChangesWhileTerminalIsOpen() throws {
+ let terminal = InMemoryTerminalSettings()
+ terminal.isTerminalOpen = true
+ var ledger = TerminalThemeLedger()
+
+ #expect(try ledger.use(theme, in: terminal) == .terminalIsOpen)
+ #expect(terminal.storedProfiles[theme.profileName] == nil)
+ #expect(terminal.names == [.newWindows: "Basic", .startup: "Basic"])
+ #expect(!ledger.canPutBack)
+
+ terminal.isTerminalOpen = false
+ _ = try ledger.use(theme, in: terminal)
+ terminal.isTerminalOpen = true
+ #expect(ledger.putBack(in: terminal) == .terminalIsOpen)
+ #expect(terminal.names[.newWindows] == theme.profileName)
+ #expect(ledger.canPutBack)
+ }
+
+ @Test func nothingChangesWhileAProfileManagesTerminal() throws {
+ let terminal = InMemoryTerminalSettings()
+ terminal.isManaged = true
+ var ledger = TerminalThemeLedger()
+
+ #expect(try ledger.use(theme, in: terminal) == .managed)
+ #expect(terminal.storedProfiles[theme.profileName] == nil)
+ #expect(terminal.names == [.newWindows: "Basic", .startup: "Basic"])
+ }
+
+ @Test func aThemeThePersonChangedIsNeitherWrittenOverNorTakenAway() throws {
+ let terminal = InMemoryTerminalSettings()
+ var ledger = TerminalThemeLedger()
+ _ = try ledger.use(theme, in: terminal)
+ terminal.storedProfiles[theme.profileName]?["columnCount"] = 80
+
+ #expect(try ledger.use(theme, in: terminal) == .unchanged)
+ #expect(terminal.storedProfiles[theme.profileName]?["columnCount"] as? Int == 80)
+ #expect(ledger.putBack(in: terminal) == .changed)
+ #expect(terminal.storedProfiles[theme.profileName]?["columnCount"] as? Int == 80)
+ #expect(terminal.names == [.newWindows: "Basic", .startup: "Basic"])
+ }
+
+ @Test func aProfileThePersonChoseSinceStaysWhenPeelPutsBack() throws {
+ let terminal = InMemoryTerminalSettings()
+ var ledger = TerminalThemeLedger()
+ _ = try ledger.use(theme, in: terminal)
+ terminal.names[.newWindows] = "Pro"
+
+ #expect(ledger.putBack(in: terminal) == .changed)
+ #expect(terminal.names == [.newWindows: "Pro", .startup: "Basic"])
+ #expect(terminal.storedProfiles[theme.profileName] == nil)
+ }
+
+ @Test func aPeelThemeStillInUseIsKept() throws {
+ let terminal = InMemoryTerminalSettings()
+ var ledger = TerminalThemeLedger()
+ _ = try ledger.use(theme, in: terminal)
+ _ = try ledger.use(otherTheme, in: terminal)
+ terminal.names[.startup] = theme.profileName
+
+ #expect(ledger.putBack(in: terminal) == .changed)
+ #expect(terminal.names == [.newWindows: "Basic", .startup: theme.profileName])
+ #expect(terminal.storedProfiles[theme.profileName] != nil)
+ #expect(terminal.storedProfiles[otherTheme.profileName] == nil)
+ }
+
+ @Test func aWriteTerminalRefusesLeavesEverythingAsItWas() throws {
+ let terminal = InMemoryTerminalSettings()
+ terminal.refusesWrites = true
+ var ledger = TerminalThemeLedger()
+
+ #expect(try ledger.use(theme, in: terminal) == .refused)
+ #expect(!ledger.canPutBack)
+ #expect(ledger.written.isEmpty)
+ #expect(terminal.names == [.newWindows: "Basic", .startup: "Basic"])
+ }
+
+ @Test func aChoiceTerminalRefusesStillLetsPeelTakeItsThemeAway() throws {
+ let terminal = InMemoryTerminalSettings()
+ terminal.refusesNames = true
+ var ledger = TerminalThemeLedger()
+
+ #expect(try ledger.use(theme, in: terminal) == .refused)
+ #expect(terminal.storedProfiles[theme.profileName] != nil)
+ terminal.refusesNames = false
+ #expect(ledger.putBack(in: terminal) == .changed)
+ #expect(terminal.storedProfiles[theme.profileName] == nil)
+ #expect(terminal.names == [.newWindows: "Basic", .startup: "Basic"])
+ }
+
+ @Test func aProfileNamedLikePeelsThatPeelNeverWroteIsLeftAsItIs() throws {
+ let terminal = InMemoryTerminalSettings()
+ terminal.storedProfiles[theme.profileName] = ["name": theme.profileName, "columnCount": 80]
+ var ledger = TerminalThemeLedger()
+
+ #expect(try ledger.use(theme, in: terminal) == .changed)
+ #expect(terminal.storedProfiles[theme.profileName]?["columnCount"] as? Int == 80)
+ #expect(ledger.putBack(in: terminal) == .changed)
+ #expect(terminal.storedProfiles[theme.profileName]?["columnCount"] as? Int == 80)
+ }
+
+ @Test func peelBringsItsOwnUntouchedThemeUpToDate() throws {
+ let terminal = InMemoryTerminalSettings()
+ var older = try TerminalProfile.settings(for: theme)
+ older["TextColor"] = Data([1, 2, 3])
+ terminal.storedProfiles[theme.profileName] = older
+ let olderFingerprint = try #require(TerminalProfile.fingerprint(of: older))
+ var ledger = TerminalThemeLedger(stored: ["written": [theme.profileName: olderFingerprint]])
+
+ #expect(try ledger.use(theme, in: terminal) == .changed)
+ let current = try #require(terminal.storedProfiles[theme.profileName])
+ #expect(TerminalProfile.fingerprint(of: current) == TerminalProfile.fingerprint(of: try TerminalProfile.settings(for: theme)))
+ }
+
+ @Test func theLedgerReadsBackWhatItStored() throws {
+ let terminal = InMemoryTerminalSettings()
+ var ledger = TerminalThemeLedger()
+ _ = try ledger.use(theme, in: terminal)
+
+ var copy = TerminalThemeLedger(stored: ledger.stored)
+ #expect(copy.before == ledger.before)
+ #expect(copy.chosen == ledger.chosen)
+ #expect(copy.written == ledger.written)
+ #expect(copy.putBack(in: terminal) == .changed)
+ #expect(terminal.names == [.newWindows: "Basic", .startup: "Basic"])
+ }
+
+ @Test func aFingerprintFollowsTheProfileAndNothingElse() throws {
+ let settings = try TerminalProfile.settings(for: theme)
+ let fingerprint = try #require(TerminalProfile.fingerprint(of: settings))
+ #expect(TerminalProfile.fingerprint(of: try TerminalProfile.settings(for: theme)) == fingerprint)
+ var changed = settings
+ changed["rowCount"] = 31
+ #expect(TerminalProfile.fingerprint(of: changed) != fingerprint)
+ }
+}