Persist and restore multiple rulers

Free Ruler/AppDelegate.swift

@@ -79,6 +79,9 @@ class AppDelegate: NSObject, NSApplicationDelegate {
                 settingsController.close()
             }
         }
+        manager.onStateChanged = { [weak self] _ in
+            self?.saveRulerSetState()
+        }
         return manager
     }()
 
@@ -185,6 +188,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
         configureUpdater()
 #endif
 
+        restoreSavedRulers()
         showRulers()
     }
 
@@ -400,6 +404,55 @@ class AppDelegate: NSObject, NSApplicationDelegate {
         updateMouseTickTimer()
     }
 
+    func restoreSavedRulers() {
+        if let restoredState = prefs.loadRulerSetState() {
+            rulerManager.restore(
+                restoredState.rulers,
+                activeRulerID: restoredState.activeRulerID
+            )
+            return
+        }
+
+        if let migratedState = migratedLegacyRulerState() {
+            rulerManager.restore([migratedState], activeRulerID: migratedState.id)
+        }
+    }
+
+    private func saveRulerSetState() {
+        prefs.saveRulerSetState(
+            rulers: rulerManager.states,
+            activeRulerID: rulerManager.activeRulerID
+        )
+    }
+
+    private func migratedLegacyRulerState() -> RulerInstanceState? {
+        let defaults = UserDefaults.standard
+        let horizontalAutosaveName = "horizontal-ruler"
+        let verticalAutosaveName = "vertical-ruler"
+        let hasLegacyAutosave = defaults.object(forKey: "NSWindow Frame \(horizontalAutosaveName)") != nil
+            || defaults.object(forKey: "NSWindow Frame \(verticalAutosaveName)") != nil
+        guard hasLegacyAutosave else { return nil }
+
+        let settings = RulerSettings(defaults: prefs)
+        let horizontalWindow = RulerWindow(
+            ruler: Ruler(.horizontal, name: horizontalAutosaveName)
+        )
+        let verticalWindow = RulerWindow(
+            ruler: Ruler(.vertical, name: verticalAutosaveName)
+        )
+        _ = horizontalWindow.setFrameUsingName(NSWindow.FrameAutosaveName(horizontalAutosaveName))
+        _ = verticalWindow.setFrameUsingName(NSWindow.FrameAutosaveName(verticalAutosaveName))
+
+        return RulerInstanceState(
+            settings: settings,
+            layout: RulerLayoutState(
+                horizontalFrame: horizontalWindow.frame,
+                verticalFrame: verticalWindow.frame,
+                zeroCorner: settings.zeroCorner
+            )
+        )
+    }
+
     func toggleRuler(orientation: Orientation) {
         if !rulerManager.hasRulers && rulers.isEmpty {
             createRulersIfNeeded()
@@ -791,12 +844,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
 
     @IBAction func resetRulerPositions(_ sender: Any) {
         if let controller = rulerManager.activeController {
-            controller.state.settings.zeroCorner = Prefs.defaultZeroCorner
-            controller.state.layout = RulerLayoutState.defaults(
-                zeroCorner: Prefs.defaultZeroCorner
-            )
-            controller.state.visibility = RulerWingVisibility()
-            controller.show()
+            controller.resetPosition()
             updateDisplay()
             updateMouseTickTimer()
             return
@@ -1046,6 +1094,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
 
     func applicationWillTerminate(_ aNotification: Notification) {
         closeRulerColorPanel()
+        saveRulerSetState()
         prefs.save()
     }
 

Free Ruler/GroupedRulerWindow.swift

@@ -1292,6 +1292,16 @@ final class GroupedRulerController: NSWindowController, NSWindowDelegate, Notifi
         notifyStateChanged()
     }
 
+    func resetPosition() {
+        state.settings.zeroCorner = Prefs.defaultZeroCorner
+        state.layout = RulerLayoutState.defaults(
+            zeroCorner: Prefs.defaultZeroCorner
+        )
+        state.visibility = RulerWingVisibility()
+        show()
+        notifyStateChanged()
+    }
+
     func drawMouseTick(at mouseLoc: NSPoint) {
         if groupedWindow.isRuleVisible(.horizontal) {
             groupedWindow.horizontalRule.drawMouseTick(at: mouseLoc)
@@ -1612,6 +1622,7 @@ final class RulerManager {
     private(set) var controllers: [GroupedRulerController] = []
     private(set) var activeRulerID: UUID?
     var onActiveControllerChanged: ((GroupedRulerController?) -> Void)?
+    var onStateChanged: ((RulerManager) -> Void)?
 
     init(
         initialStates: [RulerInstanceState] = [],
@@ -1668,7 +1679,7 @@ final class RulerManager {
         return controller
     }
 
-    func restore(_ states: [RulerInstanceState]) {
+    func restore(_ states: [RulerInstanceState], activeRulerID restoredActiveRulerID: UUID? = nil) {
         for controller in controllers {
             controller.hide()
         }
@@ -1680,6 +1691,13 @@ final class RulerManager {
         for state in states where state.hasVisibleWing {
             addRuler(state: state)
         }
+
+        if let restoredActiveRulerID = restoredActiveRulerID,
+           let restoredActiveController = controller(id: restoredActiveRulerID) {
+            markActive(restoredActiveController)
+        }
+
+        notifyStateChanged()
     }
 
     func showAll() {
@@ -1708,13 +1726,16 @@ final class RulerManager {
             activeRulerID = controllers.last?.state.id
             onActiveControllerChanged?(activeController)
         }
+
+        notifyStateChanged()
     }
 
     func markActive(_ controller: GroupedRulerController) {
         guard controllers.contains(where: { $0 === controller }) else { return }
 
         activeRulerID = controller.state.id
         onActiveControllerChanged?(controller)
+        notifyStateChanged()
     }
 
     func controller(containing window: NSWindow?) -> GroupedRulerController? {
@@ -1723,6 +1744,10 @@ final class RulerManager {
         return controllers.first { $0.groupedWindow === window }
     }
 
+    func controller(id: UUID) -> GroupedRulerController? {
+        return controllers.first { $0.state.id == id }
+    }
+
     private func configure(_ controller: GroupedRulerController) {
         controller.onBecameActive = { [weak self, weak controller] _ in
             guard let controller = controller else { return }
@@ -1733,8 +1758,13 @@ final class RulerManager {
                   self?.activeRulerID == controller.state.id else { return }
 
             self?.activeRulerID = controller.state.id
+            self?.notifyStateChanged()
         }
     }
+
+    private func notifyStateChanged() {
+        onStateChanged?(self)
+    }
 }
 #endif
 

Free Ruler/Prefs.swift

@@ -129,6 +129,8 @@ class Prefs: NSObject {
 }
 
 extension Prefs {
+    static let rulerSetStateKey = "rulerSetState"
+
     static var defaultZeroCorner: ZeroCorner {
         return .topLeft
     }
@@ -189,4 +191,38 @@ extension Prefs {
             from: data
         )
     }
+
+    func saveRulerSetState(rulers: [RulerInstanceState], activeRulerID: UUID?) {
+        let visibleRulers = rulers.filter(\.hasVisibleWing)
+        guard !visibleRulers.isEmpty else {
+            clearRulerSetState()
+            return
+        }
+
+        let activeRulerIDToSave = activeRulerID.flatMap { activeRulerID in
+            visibleRulers.contains { $0.id == activeRulerID } ? activeRulerID : nil
+        }
+        let state = StoredRulerSetState(
+            rulers: visibleRulers,
+            activeRulerID: activeRulerIDToSave
+        )
+
+        guard let data = try? JSONEncoder().encode(state) else { return }
+
+        UserDefaults.standard.set(data, forKey: Self.rulerSetStateKey)
+    }
+
+    func loadRulerSetState() -> StoredRulerSetState? {
+        guard let data = UserDefaults.standard.data(forKey: Self.rulerSetStateKey),
+              let state = try? JSONDecoder().decode(StoredRulerSetState.self, from: data),
+              state.schemaVersion == StoredRulerSetState.currentSchemaVersion else {
+            return nil
+        }
+
+        return state.sanitizedForRestore()
+    }
+
+    func clearRulerSetState() {
+        UserDefaults.standard.removeObject(forKey: Self.rulerSetStateKey)
+    }
 }

Free Ruler/Ruler.swift

@@ -377,6 +377,39 @@ struct RulerInstanceState: Identifiable, Equatable, Codable {
     }
 }
 
+struct StoredRulerSetState: Equatable, Codable {
+    static let currentSchemaVersion = 1
+
+    var schemaVersion: Int
+    var rulers: [RulerInstanceState]
+    var activeRulerID: UUID?
+
+    init(
+        schemaVersion: Int = StoredRulerSetState.currentSchemaVersion,
+        rulers: [RulerInstanceState],
+        activeRulerID: UUID?
+    ) {
+        self.schemaVersion = schemaVersion
+        self.rulers = rulers
+        self.activeRulerID = activeRulerID
+    }
+
+    func sanitizedForRestore() -> StoredRulerSetState? {
+        let visibleRulers = rulers.filter(\.hasVisibleWing)
+        guard !visibleRulers.isEmpty else { return nil }
+
+        let restoredActiveRulerID = activeRulerID.flatMap { activeRulerID in
+            visibleRulers.contains { $0.id == activeRulerID } ? activeRulerID : nil
+        }
+
+        return StoredRulerSetState(
+            schemaVersion: schemaVersion,
+            rulers: visibleRulers,
+            activeRulerID: restoredActiveRulerID
+        )
+    }
+}
+
 struct RulerCornerPlacement: Equatable {
     let xSide: RulerHorizontalSide
     let ySide: RulerVerticalSide

Free Ruler/UITestSupport+App.swift

@@ -12,6 +12,7 @@ extension UITestSupport {
             "rulerColor",
             "unit",
             "zeroCorner",
+            Prefs.rulerSetStateKey,
             "NSWindow Frame horizontal-ruler",
             "NSWindow Frame vertical-ruler",
             "NSWindow Frame preferencesWindow",