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.

A tweak changed in macOS since Peel is never written over

Țugui Dragoș843402c53794
diff --git a/Packages/PeelCore/Sources/PeelCore/Tweaks/TweakLedger.swift b/Packages/PeelCore/Sources/PeelCore/Tweaks/TweakLedger.swift
index 0a5b5b56..e70bb0f1 100644
--- a/Packages/PeelCore/Sources/PeelCore/Tweaks/TweakLedger.swift
+++ b/Packages/PeelCore/Sources/PeelCore/Tweaks/TweakLedger.swift
@@ -21,39 +21,70 @@ public struct TweakLedger {
/// The tweaks Peel turned on and has not turned off since.
public private(set) var changedByPeel: Set<Tweak.ID>
- /// What each key held before Peel first changed it, so turning the tweak off can put it back. A key that
- /// held nothing has no entry.
+ /// What each key held before Peel changed it, so turning the tweak off can put it back. A key that held
+ /// nothing has no entry.
public private(set) var previousValues: [Tweak.ID: Any]
+ /// What Peel wrote to each key it changed. A key that holds anything else was changed outside Peel since, and
+ /// that choice is the person's: it is never written over with what was there before Peel.
+ public private(set) var writtenValues: [Tweak.ID: Any]
- public init(changedByPeel: Set<Tweak.ID> = [], previousValues: [Tweak.ID: Any] = [:]) {
+ public init(
+ changedByPeel: Set<Tweak.ID> = [], previousValues: [Tweak.ID: Any] = [:], writtenValues: [Tweak.ID: Any] = [:]
+ ) {
self.changedByPeel = changedByPeel
self.previousValues = previousValues
+ self.writtenValues = writtenValues
+ }
+
+ /// Whether `tweak`'s key still holds what Peel wrote to it.
+ public func holdsPeelsChange(_ tweak: Tweak, stored: Any?) -> Bool {
+ changedByPeel.contains(tweak.id) && Self.isSame(stored, writtenValues[tweak.id])
+ }
+
+ /// Takes what each key Peel changed holds now as what Peel wrote, for a ledger saved before Peel kept that.
+ public mutating func adoptStoredValuesAsWritten(in store: some TweakStoring) {
+ for tweak in TweakCatalog.all where changedByPeel.contains(tweak.id) && writtenValues[tweak.id] == nil {
+ writtenValues[tweak.id] = store.storedValue(of: tweak)
+ }
}
public mutating func turnOn(_ tweak: Tweak, path: String? = nil, in store: some TweakStoring) -> Outcome {
let before = store.storedValue(of: tweak)
+ let wasPeels = holdsPeelsChange(tweak, stored: before)
guard store.turnOn(tweak, path: path) else { return .refused }
+ let after = store.storedValue(of: tweak)
// A key that already held the value was not changed by Peel, so turning it off later removes the key,
// as for any setting made outside Peel.
- guard !Self.isSame(before, store.storedValue(of: tweak)) else { return .unchanged }
- // The previous value is recorded only after the write succeeds, and only the first time. After a
- // failed write, the user may still change the value. After the first write, the key holds Peel's value.
- if !changedByPeel.contains(tweak.id), let before {
+ guard !Self.isSame(before, after) else { return .unchanged }
+ // What the key held is recorded once the write succeeds, unless it was Peel's own value: after a failed
+ // write the person may still change it, and a value they chose since Peel's change is theirs to get back.
+ if !wasPeels {
previousValues[tweak.id] = before
}
changedByPeel.insert(tweak.id)
+ writtenValues[tweak.id] = after
return .changed
}
/// Turns `tweak` off. A setting Peel changed gets back what its key held before. A setting made outside
- /// Peel has its key removed, so macOS falls back to its default.
+ /// Peel has its key removed, so macOS falls back to its default. A key the person changed after Peel did is
+ /// left as it is, and Peel forgets its change.
public mutating func turnOff(_ tweak: Tweak, in store: some TweakStoring) -> Outcome {
let before = store.storedValue(of: tweak)
+ if changedByPeel.contains(tweak.id), !holdsPeelsChange(tweak, stored: before) {
+ forget(tweak)
+ return .unchanged
+ }
let restored = changedByPeel.contains(tweak.id) ? previousValues[tweak.id] : nil
guard store.restore(restored, for: tweak) else { return .refused }
+ forget(tweak)
+ return Self.isSame(before, store.storedValue(of: tweak)) ? .unchanged : .changed
+ }
+
+ private mutating func forget(_ tweak: Tweak) {
changedByPeel.remove(tweak.id)
previousValues.removeValue(forKey: tweak.id)
- return Self.isSame(before, store.storedValue(of: tweak)) ? .unchanged : .changed
+ writtenValues.removeValue(forKey: tweak.id)
}
/// The result of turning several tweaks off. `restarts` lists each restart once, however many of its
@@ -71,7 +102,7 @@ public struct TweakLedger {
guard !state.isManaged else { return false }
switch tweak.kind {
case .aSwitch: return state.isOn
- case .folder: return changedByPeel.contains(tweak.id)
+ case .folder: return holdsPeelsChange(tweak, stored: state.path)
}
}
diff --git a/Packages/PeelCore/Tests/PeelCoreTests/TweakLedgerTests.swift b/Packages/PeelCore/Tests/PeelCoreTests/TweakLedgerTests.swift
index ec7ce2e3..cc5655a4 100644
--- a/Packages/PeelCore/Tests/PeelCoreTests/TweakLedgerTests.swift
+++ b/Packages/PeelCore/Tests/PeelCoreTests/TweakLedgerTests.swift
@@ -131,7 +131,50 @@ struct TweakLedgerTests {
#expect(!ledger.isOn(aSwitch, state: TweakState(isOn: true, isManaged: true, path: nil)))
let store = FakeStore()
_ = ledger.turnOn(folder, path: "/Users/me/Peel", in: store)
- #expect(ledger.isOn(folder, state: chosenByHand))
+ #expect(ledger.isOn(folder, state: TweakState(isOn: true, isManaged: false, path: "/Users/me/Peel")))
+ #expect(!ledger.isOn(folder, state: chosenByHand), "a folder chosen since is the person's")
+ }
+
+ /// A key the person changed in macOS after Peel did holds their choice now, never written over with what was
+ /// there before Peel: the folder chosen later stays, and Peel forgets its change.
+ @Test func aChoiceMadeOutsidePeelSinceIsNeverWrittenOver() throws {
+ let folder = try #require(TweakCatalog.all.first { $0.kind == .folder })
+ let store = FakeStore()
+ store.values[folder.id] = "/Users/me/Old"
+ var ledger = TweakLedger()
+ _ = ledger.turnOn(folder, path: "/Users/me/Peel", in: store)
+ store.values[folder.id] = "/Users/me/New"
+
+ #expect(!ledger.holdsPeelsChange(folder, stored: store.values[folder.id]))
+ #expect(ledger.turnOff(folder, in: store) == .unchanged)
+ #expect(store.values[folder.id] as? String == "/Users/me/New")
+ #expect(ledger.changedByPeel.isEmpty)
+ #expect(ledger.previousValues.isEmpty)
+ }
+
+ /// Turned on again after the person changed the key in macOS, the tweak later puts back their newer value.
+ @Test func turningOnAgainRemembersTheValueChosenSince() {
+ let store = FakeStore()
+ store.values[tweak.id] = 0.5
+ var ledger = TweakLedger()
+ _ = ledger.turnOn(tweak, in: store)
+ store.values[tweak.id] = 0.7
+
+ #expect(ledger.turnOn(tweak, in: store) == .changed)
+ #expect(ledger.turnOff(tweak, in: store) == .changed)
+ #expect(store.values[tweak.id] as? Double == 0.7)
+ }
+
+ /// A ledger saved before Peel kept what it wrote takes what each key holds as Peel's, which is how it read them.
+ @Test func aLedgerFromBeforeTakesWhatIsStoredAsPeels() {
+ let store = FakeStore()
+ store.values[tweak.id] = true
+ var ledger = TweakLedger(changedByPeel: [tweak.id], previousValues: [tweak.id: 0.5])
+
+ ledger.adoptStoredValuesAsWritten(in: store)
+
+ #expect(ledger.turnOff(tweak, in: store) == .changed)
+ #expect(store.values[tweak.id] as? Double == 0.5)
}
/// A write macOS refused leaves that switch where it was, says so, and restarts nothing for it.
diff --git a/Peel/Model/TweakLibrary.swift b/Peel/Model/TweakLibrary.swift
index bcfcf243..0015d48e 100644
--- a/Peel/Model/TweakLibrary.swift
+++ b/Peel/Model/TweakLibrary.swift
@@ -8,6 +8,7 @@ final class TweakLibrary {
private static let changedKey = "tweaksChangedByPeel"
/// What each key held before Peel changed it, so a reset gives the user their own setting back.
private static let previousKey = "tweaksValuesBeforePeel"
+ private static let writtenKey = "tweaksValuesWrittenByPeel"
private static let waitingKey = "tweaksWaitingForLogOut"
private static let sessionKey = "tweaksWaitingSession"
@@ -31,19 +32,21 @@ final class TweakLibrary {
init() {
ledger = TweakLedger(
changedByPeel: Set(UserDefaults.standard.stringArray(forKey: Self.changedKey) ?? []),
- previousValues: UserDefaults.standard.dictionary(forKey: Self.previousKey) ?? [:]
+ previousValues: UserDefaults.standard.dictionary(forKey: Self.previousKey) ?? [:],
+ writtenValues: UserDefaults.standard.dictionary(forKey: Self.writtenKey) ?? [:]
)
let isThisSession = UserDefaults.standard.integer(forKey: Self.sessionKey) == Self.loginSession
waitingForLogOut = isThisSession ? Set(UserDefaults.standard.stringArray(forKey: Self.waitingKey) ?? []) : []
+ ledger.adoptStoredValuesAsWritten(in: store)
}
func isWaitingForLogOut(_ group: Tweak.Group) -> Bool {
tweaks(in: group).contains { waitingForLogOut.contains($0.id) }
}
- /// True for a setting Peel itself made, which is what it can put back.
+ /// True for a setting Peel itself made and the person has not changed since, which is what it can put back.
func isChangedByPeel(_ tweak: Tweak) -> Bool {
- ledger.changedByPeel.contains(tweak.id)
+ ledger.holdsPeelsChange(tweak, stored: store.storedValue(of: tweak))
}
func tweaks(in group: Tweak.Group) -> [Tweak] {
@@ -88,6 +91,7 @@ final class TweakLibrary {
private func save() {
UserDefaults.standard.set(Array(ledger.changedByPeel), forKey: Self.changedKey)
UserDefaults.standard.set(ledger.previousValues, forKey: Self.previousKey)
+ UserDefaults.standard.set(ledger.writtenValues, forKey: Self.writtenKey)
UserDefaults.standard.set(Array(waitingForLogOut), forKey: Self.waitingKey)
UserDefaults.standard.set(Self.loginSession, forKey: Self.sessionKey)
}