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.

Keep Turn All Off from writing over a shell or ssh file Peel couldn't read

Țugui Dragoșf54a4d9d43f4
diff --git a/Packages/PeelCore/Sources/PeelCore/Terminal/ShellSessions.swift b/Packages/PeelCore/Sources/PeelCore/Terminal/ShellSessions.swift
index 6191e52e..dd3e64fb 100644
--- a/Packages/PeelCore/Sources/PeelCore/Terminal/ShellSessions.swift
+++ b/Packages/PeelCore/Sources/PeelCore/Terminal/ShellSessions.swift
@@ -5,7 +5,9 @@ public enum ShellSessions: Sendable, Equatable {
case zsh(startupFile: URL)
case bash
- public static func inTerminal(_ terminal: TerminalSettings, home: URL = .homeDirectory) -> ShellSessions? {
+ public static func inTerminal(
+ _ terminal: some TerminalSettingsStoring, home: URL = .homeDirectory
+ ) -> ShellSessions? {
of(terminalSetting: terminal.shell(), loginShell: loginShell(), zdotdir: sessionZDOTDIR, home: home)
}
diff --git a/Packages/PeelCore/Sources/PeelCore/Terminal/TerminalSettingsStoring.swift b/Packages/PeelCore/Sources/PeelCore/Terminal/TerminalSettingsStoring.swift
index 50b1ca31..b59e4d15 100644
--- a/Packages/PeelCore/Sources/PeelCore/Terminal/TerminalSettingsStoring.swift
+++ b/Packages/PeelCore/Sources/PeelCore/Terminal/TerminalSettingsStoring.swift
@@ -11,4 +11,6 @@ public protocol TerminalSettingsStoring {
func setProfiles(_ profiles: [String: [String: Any]]) -> Bool
func profileName(for role: TerminalProfileRole) -> String?
func setProfileName(_ name: String?, for role: TerminalProfileRole) -> Bool
+ /// The command Terminal opens new windows with, when Shells open with names one.
+ func shell() -> String?
}
diff --git a/Packages/PeelCore/Tests/PeelCoreTests/TerminalThemeLedgerTests.swift b/Packages/PeelCore/Tests/PeelCoreTests/TerminalThemeLedgerTests.swift
index 0c6eb3dd..43e9c616 100644
--- a/Packages/PeelCore/Tests/PeelCoreTests/TerminalThemeLedgerTests.swift
+++ b/Packages/PeelCore/Tests/PeelCoreTests/TerminalThemeLedgerTests.swift
@@ -30,6 +30,8 @@ private final class InMemoryTerminalSettings: TerminalSettingsStoring {
names[role] = name
return true
}
+
+ func shell() -> String? { nil }
}
struct TerminalThemeLedgerTests {
diff --git a/Peel/Model/GitLibrary.swift b/Peel/Model/GitLibrary.swift
index 8ea4e652..8f619cc1 100644
--- a/Peel/Model/GitLibrary.swift
+++ b/Peel/Model/GitLibrary.swift
@@ -12,9 +12,11 @@ final class GitLibrary {
var setInIncludedFiles: Set<String> = []
}
- private static let ledgerKey = "terminalGit"
+ static let ledgerKey = "terminalGit"
- private var ledger = GitLedger(stored: UserDefaults.standard.dictionary(forKey: ledgerKey) ?? [:])
+ private let home: URL
+ private let defaults: UserDefaults
+ private var ledger: GitLedger
private var git: GitConfig?
private(set) var state: State?
private var asked: [GitSetting: Bool] = [:]
@@ -22,6 +24,14 @@ final class GitLibrary {
private var waiting: [GitSetting: Int] = [:]
private var changes: Task<Void, Never>?
+ /// The home whose Git settings are read and changed, and the store the ledger is kept in; the person's own
+ /// unless a test gives its own.
+ init(home: URL = .homeDirectory, defaults: UserDefaults = .standard) {
+ self.home = home
+ self.defaults = defaults
+ ledger = GitLedger(stored: defaults.dictionary(forKey: Self.ledgerKey) ?? [:])
+ }
+
var hasSomethingOn: Bool {
GitSetting.allCases.contains(where: isOn)
}
@@ -33,7 +43,7 @@ final class GitLibrary {
}
private func read() async {
- let git = if let git { git } else { await GitConfig.find() }
+ let git = if let git { git } else { await GitConfig.find(home: home) }
let settings = await git?.settings()
var known = state?.known
if known == nil {
@@ -44,7 +54,7 @@ final class GitLibrary {
isInstalled: git != nil,
settings: settings,
known: known,
- signingKey: GitSetting.signingKey(in: settings ?? [:], home: .homeDirectory),
+ signingKey: GitSetting.signingKey(in: settings ?? [:], home: home),
setInIncludedFiles: await git?.keysSetByIncludedFiles() ?? []
)
}
@@ -81,8 +91,8 @@ final class GitLibrary {
}
}
- private static func save(_ ledger: GitLedger) {
- UserDefaults.standard.set(ledger.stored, forKey: ledgerKey)
+ private func save(_ ledger: GitLedger) {
+ defaults.set(ledger.stored, forKey: Self.ledgerKey)
}
private func ask(_ settings: [GitSetting], isOn: Bool) {
@@ -112,8 +122,8 @@ final class GitLibrary {
var refused = false
for setting in settings {
let outcome = isOn
- ? await ledger.turnOn(setting, signingKey: state?.signingKey, in: git) { Self.save($0) }
- : await ledger.turnOff(setting, in: git) { Self.save($0) }
+ ? await ledger.turnOn(setting, signingKey: state?.signingKey, in: git) { save($0) }
+ : await ledger.turnOff(setting, in: git) { save($0) }
refused = outcome == .refused || refused
}
self.ledger = ledger
diff --git a/Peel/Model/SSHLibrary.swift b/Peel/Model/SSHLibrary.swift
index 26e54adb..ac9d5f83 100644
--- a/Peel/Model/SSHLibrary.swift
+++ b/Peel/Model/SSHLibrary.swift
@@ -10,13 +10,22 @@ final class SSHLibrary {
var accepted: Set<SSHSetting>
}
- let file = SSHFile.url(in: PeelFolder.url)
- let config = URL.homeDirectory.appending(path: ".ssh/config", directoryHint: .notDirectory)
+ let file: URL
+ let config: URL
+ private let home: URL
private(set) var state: State?
private(set) var wasRefused = false
+ /// Peel's own file in `folder`, and the home whose `.ssh/config` is read: the person's own unless a test gives
+ /// its own.
+ init(folder: URL = PeelFolder.url, home: URL = .homeDirectory) {
+ file = SSHFile.url(in: folder)
+ config = home.appending(path: ".ssh/config", directoryHint: .notDirectory)
+ self.home = home
+ }
+
var lines: [String] {
- SSHFile.lines(including: file, home: .homeDirectory)
+ SSHFile.lines(including: file, home: home)
}
var hasSomethingOn: Bool {
@@ -27,7 +36,7 @@ final class SSHLibrary {
let accepted = if let state, !state.accepted.isEmpty { state.accepted } else { await SSHFile.accepted() }
state = State(
settings: SSHFile.read(file),
- isIncluded: SSHFile.isIncluded(file, from: config, home: .homeDirectory),
+ isIncluded: SSHFile.isIncluded(file, from: config, home: home),
accepted: accepted
)
}
@@ -47,7 +56,9 @@ final class SSHLibrary {
write(settings)
}
+ /// Empties Peel's file, never one it could not read: what is in that one is not known.
func turnAllOff() {
+ guard state?.settings != nil else { return }
write([])
}
diff --git a/Peel/Model/ShellLibrary.swift b/Peel/Model/ShellLibrary.swift
index 1d0172bb..5ba38823 100644
--- a/Peel/Model/ShellLibrary.swift
+++ b/Peel/Model/ShellLibrary.swift
@@ -13,13 +13,21 @@ final class ShellLibrary {
var known: Set<String>?
}
- let file = ShellFile.url(in: PeelFolder.url)
+ let file: URL
+ private let home: URL
private(set) var state: State?
private(set) var wasRefused = false
private(set) var draft = Prompt()
+ /// Peel's own file in `folder`, and the home whose startup files are read: the person's own unless a test gives
+ /// its own.
+ init(folder: URL = PeelFolder.url, home: URL = .homeDirectory) {
+ file = ShellFile.url(in: folder)
+ self.home = home
+ }
+
var line: String {
- ShellFile.line(sourcing: file, home: .homeDirectory)
+ ShellFile.line(sourcing: file, home: home)
}
var hasSomethingOn: Bool {
@@ -31,17 +39,15 @@ final class ShellLibrary {
if known == nil {
known = await ShellFile.knownToZsh()
}
- let shell = ShellSessions.inTerminal(TerminalSettings())
- let startupFile = await shell?.zshrc()
+ let shell = ShellSessions.inTerminal(TerminalSettings(), home: home)
+ let startupFile = await shell?.zshrc(home: home)
let choices = ShellFile.read(file)
state = State(
shell: shell,
startupFile: startupFile,
choices: choices,
- isSourced: startupFile.map { ShellFile.isSourced(file, from: $0, home: .homeDirectory) } ?? false,
- setsItsOwnPrompt: startupFile.map {
- ShellFile.setsItsOwnPrompt(after: file, in: $0, home: .homeDirectory)
- } ?? false,
+ isSourced: startupFile.map { ShellFile.isSourced(file, from: $0, home: home) } ?? false,
+ setsItsOwnPrompt: startupFile.map { ShellFile.setsItsOwnPrompt(after: file, in: $0, home: home) } ?? false,
known: known
)
if let prompt = choices?.prompt {
@@ -78,7 +84,9 @@ final class ShellLibrary {
write(choices)
}
+ /// Empties Peel's file, never one it could not read: what is in that one is not known.
func turnAllOff() {
+ guard state?.choices != nil else { return }
write(ShellFile.Choices())
}
diff --git a/Peel/Model/TerminalLibrary.swift b/Peel/Model/TerminalLibrary.swift
index ce13c385..c468ae78 100644
--- a/Peel/Model/TerminalLibrary.swift
+++ b/Peel/Model/TerminalLibrary.swift
@@ -11,10 +11,12 @@ final class TerminalLibrary {
case set(TerminalOption, Bool)
}
- private static let ledgerKey = "terminalThemes"
+ static let ledgerKey = "terminalThemes"
private static let patience: Duration = .seconds(10)
- private let settings = TerminalSettings()
+ private let settings: any TerminalSettingsStoring
+ private let defaults: UserDefaults
+ private let home: URL
private var ledger: TerminalThemeLedger
private(set) var themeInUse: TerminalTheme?
private(set) var profileInUse: String?
@@ -32,8 +34,17 @@ final class TerminalLibrary {
var waitingForTerminal: Action?
var terminalDidNotQuit = false
- init() {
- ledger = TerminalThemeLedger(stored: UserDefaults.standard.dictionary(forKey: Self.ledgerKey) ?? [:])
+ /// Terminal's settings, the store the ledger is kept in, and the home whose `.hushlogin` is read: the person's
+ /// own unless a test gives its own.
+ init(
+ settings: any TerminalSettingsStoring = TerminalSettings(),
+ defaults: UserDefaults = .standard,
+ home: URL = .homeDirectory
+ ) {
+ self.settings = settings
+ self.defaults = defaults
+ self.home = home
+ ledger = TerminalThemeLedger(stored: defaults.dictionary(forKey: Self.ledgerKey) ?? [:])
refresh()
}
@@ -42,8 +53,8 @@ final class TerminalLibrary {
themeInUse = ledger.theme(in: settings)
canPutBack = ledger.canPutBack
isTerminalOpen = settings.isTerminalOpen
- quietsLogin = HushLogin.isOn(in: .homeDirectory)
- shellSessions = ShellSessions.inTerminal(settings)
+ quietsLogin = HushLogin.isOn(in: home)
+ shellSessions = ShellSessions.inTerminal(settings, home: home)
options = ledger.options(in: settings)
isManaged = settings.isManaged
showsWindowSwitch = TerminalWindows.switchMatters()
@@ -59,7 +70,7 @@ final class TerminalLibrary {
case .putBack: ledger.putBack(in: settings)
case .set(let option, let isOn): ledger.set(option, to: isOn, in: settings)
}
- UserDefaults.standard.set(ledger.stored, forKey: Self.ledgerKey)
+ defaults.set(ledger.stored, forKey: Self.ledgerKey)
wasRefused = outcome == .refused
areProfilesUnreadable = outcome == .unreadable
refresh()
@@ -90,20 +101,20 @@ final class TerminalLibrary {
}
func turnOnQuietLogin() {
- quietsLogin = HushLogin.turnOn(in: .homeDirectory)
+ quietsLogin = HushLogin.turnOn(in: home)
}
func moveQuietLoginToTrash(recording record: (TrashResult, [URL: Int64]) async -> Void) async -> TrashResult {
isMovingQuietLogin = true
defer { isMovingQuietLogin = false }
- let file = HushLogin.url(in: .homeDirectory)
+ let file = HushLogin.url(in: home)
let sizes = [URL: Int64](measured: [(file, await FileSize.reclaimableSize(of: file))])
let result = await QuitGuard.shared.run {
let result = await TrashService(exclusions: ExclusionsStore.shared.exclusions).trash([file])
await record(result, sizes)
return result
}
- quietsLogin = HushLogin.isOn(in: .homeDirectory)
+ quietsLogin = HushLogin.isOn(in: home)
return result
}
diff --git a/PeelTests/TerminalLibrariesTests.swift b/PeelTests/TerminalLibrariesTests.swift
new file mode 100644
index 00000000..159a6fc9
--- /dev/null
+++ b/PeelTests/TerminalLibrariesTests.swift
@@ -0,0 +1,106 @@
+import Foundation
+@testable import Peel
+import PeelCore
+import Testing
+
+/// Terminal's settings as a test keeps them in memory, never Terminal's own.
+private final class FakeTerminalSettings: TerminalSettingsStoring {
+ var isTerminalOpen = false
+ var isManaged = false
+ var storedProfiles: [String: [String: Any]]? = [:]
+ var names: [TerminalProfileRole: String] = [:]
+ var shellSetting: String?
+
+ func profiles() -> [String: [String: Any]]? { storedProfiles }
+
+ func setProfiles(_ profiles: [String: [String: Any]]) -> Bool {
+ storedProfiles = profiles
+ return true
+ }
+
+ func profileName(for role: TerminalProfileRole) -> String? { names[role] }
+
+ func setProfileName(_ name: String?, for role: TerminalProfileRole) -> Bool {
+ names[role] = name
+ return true
+ }
+
+ func shell() -> String? { shellSetting }
+}
+
+struct TerminalLibrariesTests {
+ private func madeUpHome() throws -> URL {
+ let home = FileManager.default.temporaryDirectory.appending(
+ path: "TerminalLibrariesTests-\(UUID().uuidString)", directoryHint: .isDirectory
+ )
+ try FileManager.default.createDirectory(at: home, withIntermediateDirectories: true)
+ return home
+ }
+
+ /// A file Peel refuses to read, larger than it ever writes.
+ private func unreadableFile(at url: URL) throws -> Int {
+ try FileManager.default.createDirectory(at: url.deletingLastPathComponent(), withIntermediateDirectories: true)
+ let bytes = Data(repeating: UInt8(ascii: "#"), count: 65 * 1_024)
+ try bytes.write(to: url)
+ return bytes.count
+ }
+
+ private func size(of url: URL) throws -> Int {
+ try #require(FileManager.default.attributesOfItem(atPath: url.path(percentEncoded: false))[.size] as? Int)
+ }
+
+ @Test func turnAllOffOnTheShellTabLeavesAFileItCouldNotRead() async throws {
+ let home = try madeUpHome()
+ defer { try? FileManager.default.removeItem(at: home) }
+ let folder = home.appending(path: "Library/Application Support/Peel", directoryHint: .isDirectory)
+ let library = ShellLibrary(folder: folder, home: home)
+ let bytes = try unreadableFile(at: library.file)
+
+ await library.refresh()
+ #expect(library.state?.choices == nil)
+ library.turnAllOff()
+
+ #expect(try size(of: library.file) == bytes)
+ }
+
+ @Test func turnAllOffOnTheSSHTabLeavesAFileItCouldNotRead() async throws {
+ let home = try madeUpHome()
+ defer { try? FileManager.default.removeItem(at: home) }
+ let folder = home.appending(path: "Library/Application Support/Peel", directoryHint: .isDirectory)
+ let library = SSHLibrary(folder: folder, home: home)
+ let bytes = try unreadableFile(at: library.file)
+
+ await library.refresh()
+ #expect(library.state?.settings == nil)
+ library.turnAllOff()
+
+ #expect(try size(of: library.file) == bytes)
+ }
+
+ @Test func aGitChangeSavesTheLedgerInTheStoreItWasGiven() async throws {
+ let home = try madeUpHome()
+ defer { try? FileManager.default.removeItem(at: home) }
+ let suite = "org.example.peel-tests.\(UUID().uuidString)"
+ let defaults = try #require(UserDefaults(suiteName: suite))
+ defer { defaults.removePersistentDomain(forName: suite) }
+ let library = GitLibrary(home: home, defaults: defaults)
+ await library.refresh()
+ let state = try #require(library.state)
+ #expect(state.isInstalled)
+ let standardBefore = UserDefaults.standard.dictionary(forKey: GitLibrary.ledgerKey)
+
+ library.set(.rebaseOnPull, to: true)
+ #expect(library.isOn(.rebaseOnPull))
+ await library.refresh()
+
+ #expect(library.isOn(.rebaseOnPull))
+ let written = try #require(defaults.dictionary(forKey: GitLibrary.ledgerKey)?["written"] as? [String: String])
+ #expect(written["pull.rebase"] == "true")
+ #expect(UserDefaults.standard.dictionary(forKey: GitLibrary.ledgerKey) == nil || standardBefore != nil)
+
+ library.set(.rebaseOnPull, to: false)
+ await library.refresh()
+ #expect(!library.isOn(.rebaseOnPull))
+ #expect((defaults.dictionary(forKey: GitLibrary.ledgerKey)?["written"] as? [String: String])?.isEmpty == true)
+ }
+}