Merge pull request #30 from wolveix/master

Implement `preserveAppOrder` user preference

Author: EthanSK

MenuBarDock/AppDelegate.swift

@@ -125,7 +125,6 @@ extension AppDelegate: AppTrackerDelegate {
 }
 
 extension AppDelegate: PreferencesViewControllerDelegate {
-
 	func maxNumRunningAppsSliderEndedChanging(_ value: Int) {
 		userPrefs.maxNumRunningApps = value
 		userPrefsWasUpdated()
@@ -180,6 +179,11 @@ extension AppDelegate: PreferencesViewControllerDelegate {
 		userPrefsWasUpdated()
 	}
 
+    func preserveAppOrderDidChange(_ value: Bool) {
+        userPrefs.preserveAppOrder = value
+        userPrefsWasUpdated()
+    }
+
 	func appOpeningMethodDidChange(_ value: AppOpeningMethod) {
 		userPrefs.defaultAppOpeningMethod = value
 		userPrefsWasUpdated()

MenuBarDock/AppTracker.swift

@@ -15,13 +15,13 @@ protocol AppTrackerDelegate: AnyObject {
 
 // tracks app activations and quits
 class AppTracker {
-
 	public weak var delegate: AppTrackerDelegate?
 
 	init() {
 		trackAppsBeingActivated()
 		trackAppsBeingQuit()
 	}
+
 	private func trackAppsBeingActivated() {
 		NSWorkspace.shared.notificationCenter.addObserver(forName: NSWorkspace.didActivateApplicationNotification, object: nil, queue: .main) { (notification) in
 			if

MenuBarDock/Base.lproj/Main.storyboard

@@ -46,6 +46,7 @@ enum Constants {
 		static let appOpeningMethods = "appOpeningMethods"
 		static let hideActiveAppFromRunningApps = "hideActiveAppFromRunningApps"
 		static let hideFinderFromRunningApps = "hideFinderFromRunningApps"
+        static let preserveAppOrder = "preserveAppOrder"
 		static let regularAppsUrls = "regularAppsUrls"
 		static let sideToShowRunningApps = "sideToShowRunningApps"
 		static let hideDuplicateApps = "hideDuplicateApps"

MenuBarDock/Constants.swift

@@ -17,7 +17,7 @@ class InfoViewController: NSViewController {
 		"Hold command ⌘ while dragging an icon to move its position in the menu bar.",
 		"If clicking on an app in the menu bar doesn't have the desired effect, try changing the app opening method for that app by right clicking it in the menu bar dock",
 		"If \(Constants.App.name) is getting slow, just restart it, and it will clear out and reset all the unused status items. This should happen very rarely if at all",
-		"If you don't want to use the \(Constants.App.runningAppsSectionTitle) feature, just set the max number of running appps to 0. If you don't want to use the \(Constants.App.regularAppsSectionTitle) feature, just remove all the apps from the list.",
+		"If you don't want to use the \(Constants.App.runningAppsSectionTitle) feature, just set the max number of running apps to 0. If you don't want to use the \(Constants.App.regularAppsSectionTitle) feature, just remove all the apps from the list.",
 		"You can add multiple versions of the same app to the \(Constants.App.regularAppsSectionTitle) list as long as they have a different path on your system.",
 		"You may notice the ordering of apps will be incorrect when you first open \(Constants.App.name). This is because it tracks what apps you open and close after opening \(Constants.App.name), so it will take a little bit of time to settle. This issue can be avoided if you simple keep 'Launch at Login' on."
 	]

MenuBarDock/InfoViewController.swift

@@ -40,7 +40,6 @@ class MenuBarItem {
 	}
 
 	func update(for app: OpenableApp, appIconSize: CGFloat, slotWidth: CGFloat) {
-
 		self.app = app
  		let imageSize = appIconSize
         let menuBarHeight: CGFloat = 22 // do not use NSApplication.shared.mainMenu?.menuBarHeight, it doesn't work on MBP 16 inch with notch, because the menu bar reports as bigger than the actual height it uses. 22 is a good fixed height.
@@ -95,14 +94,21 @@ class MenuBarItem {
 		let menu = NSMenu()
 		guard let appName = app?.name else { return }
 
-		if app?.runningApplication != nil {
-			_ = addMenuItem(
-				menu: menu,
-				title: "Quit \(appName)",
-				action: #selector(quitApp),
-				keyEquivalent: "q"
-			)
-		}
+        if let runningApplication = app?.runningApplication {
+            // only makes sense to hide and show, and activate a running app, not just any app
+            _ = addMenuItem(
+                menu: menu,
+                title: "\(runningApplication.isHidden ? "Unhide" : "Hide") \(appName)",
+                action: #selector(toggleAppHidden),
+                keyEquivalent: "h"
+            )
+            _ = addMenuItem(
+                menu: menu,
+                title: "Activate \(appName)",
+                action: #selector(activateApp),
+                keyEquivalent: "a"
+            )
+        }
 
 		_ = addMenuItem(
 			menu: menu,
@@ -111,31 +117,23 @@ class MenuBarItem {
 			keyEquivalent: "r"
 		)
 
-		if let runningApplication = app?.runningApplication {
-			// only makes sense to hide and show, and activate a running app, not just any app
-			_ = addMenuItem(
-				menu: menu,
-				title: "\(runningApplication.isHidden ? "Unhide" : "Hide") \(appName)",
-				action: #selector(toggleAppHidden),
-				keyEquivalent: "h"
-			)
-			_ = addMenuItem(
-				menu: menu,
-				title: "Activate \(appName)",
-				action: #selector(activateApp),
-				keyEquivalent: "a"
-			)
-		}
-
 		_ = addMenuItem(
 			menu: menu,
 			title: "Launch \(appName)",
 			action: #selector(launchApp),
 			keyEquivalent: "l"
 		)
 
-		// removed open new instance item because it's kinda pointless and will probably cause bugs
+        if app?.runningApplication != nil {
+            _ = addMenuItem(
+                menu: menu,
+                title: "Quit \(appName)",
+                action: #selector(quitApp),
+                keyEquivalent: "q"
+            )
+        }
 
+		// removed open new instance item because it's kinda pointless and will probably cause bugs
 		addAppOpeningMethodMenuItem(menu: menu)
 
 		menu.addItem(NSMenuItem.separator())

MenuBarDock/MenuBarItem.swift

@@ -12,7 +12,7 @@ protocol MenuBarItemsUserPrefsDataSource: AnyObject {
 	var appOpeningMethods: [String: AppOpeningMethod] { get }
 	var statusItemWidth: CGFloat { get }
 	var appIconSize: CGFloat { get }
-
+    var preserveAppOrder: Bool { get }
 }
 
 protocol MenuBarItemsDelegate: AnyObject {
@@ -78,10 +78,12 @@ class MenuBarItems {
 	}
 
 	private func hideItem(item: MenuBarItem) {
-
 		item.statusItem.length = 0
+
 		if #available(OSX 10.12, *) {
-			// item.statusItem.isVisible = false // this prevents the item from remembering its position. Thanks Apple.
+            if userPrefsDataSource.preserveAppOrder == false {
+                item.statusItem.isVisible = false // this prevents the item from remembering its position. Thanks Apple.
+            }
 		}
 	}
 

MenuBarDock/MenuBarItems.swift

@@ -140,6 +140,13 @@ class OpenableApp {
 
 	private func launchApp() {
 		print("Launching app: ", name)
+
+        // workaround needed to open Steam, otherwise it opens the app path in Finder
+        if bundleId == "com.valvesoftware.steam" {
+            NSWorkspace.shared.launchApplication(withBundleIdentifier: "com.valvesoftware.steam", options: [], additionalEventParamDescriptor: nil, launchIdentifier: nil)
+            return
+        }
+
 		if #available(OSX 10.15, *) {
 			let config = NSWorkspace.OpenConfiguration()
 			config.activates = true

MenuBarDock/OpenableApp.swift

@@ -21,6 +21,7 @@ protocol PreferencesViewControllerDelegate: AnyObject {
 	func aboutWasPressed()
 	func hideFinderDidChange(_ value: Bool)
 	func hideActiveAppDidChange(_ value: Bool)
+    func preserveAppOrderDidChange(_ value: Bool)
 	func appOpeningMethodDidChange(_ value: AppOpeningMethod)
 	func regularAppsUrlsWereAdded(_ value: [URL])
 	func regularAppsUrlsWereRemoved(_ removedIndexes: IndexSet)
@@ -40,14 +41,14 @@ protocol PreferencesViewControllerUserPrefsDataSource: AnyObject {
 	var defaultAppOpeningMethod: AppOpeningMethod { get }
 	var hideFinderFromRunningApps: Bool { get }
 	var hideActiveAppFromRunningApps: Bool { get }
+    var preserveAppOrder: Bool { get }
 	var regularAppsUrls: [URL] { get }
 	var sideToShowRunningApps: SideToShowRunningApps { get }
 	var hideDuplicateApps: Bool { get }
 	var duplicateAppsPriority: DuplicateAppsPriority { get }
 }
 
-class PreferencesViewController: NSViewController { // this should do onthing
-
+class PreferencesViewController: NSViewController { // this should do nothing
 	weak var delegate: PreferencesViewControllerDelegate?
 	weak var userPrefsDataSource: PreferencesViewControllerUserPrefsDataSource!
 
@@ -67,6 +68,7 @@ class PreferencesViewController: NSViewController { // this should do onthing
 
 	@IBOutlet weak var hideActiveAppFromRunningAppsButton: NSButton!
 	@IBOutlet weak var hideFinderFromRunningAppsButton: NSButton!
+    @IBOutlet weak var preserveAppOrderButton: NSButton!
 
 	@IBOutlet weak var sideToShowRunningAppsControl: NSSegmentedControl!
 
@@ -114,6 +116,8 @@ class PreferencesViewController: NSViewController { // this should do onthing
 
 		hideFinderFromRunningAppsButton.state = userPrefsDataSource.hideFinderFromRunningApps ? .on : .off
 
+        preserveAppOrderButton.state = userPrefsDataSource.preserveAppOrder ? .on : .off
+
 		switch userPrefsDataSource.runningAppsSortingMethod {
 		case .mostRecentOnRight:
 			mostRecentRightRadioButton.state = .on
@@ -240,9 +244,13 @@ class PreferencesViewController: NSViewController { // this should do onthing
 	}
 
 	@IBAction func hideFinderFromRunningAppsPressed(_ sender: NSButton) {
-		delegate?.hideFinderDidChange(sender.state == .on	)
+		delegate?.hideFinderDidChange(sender.state == .on)
 	}
 
+    @IBAction func preserveAppOrderPressed(_ sender: NSButton) {
+        delegate?.preserveAppOrderDidChange(sender.state == .on)
+    }
+
 	@IBAction func addOrRemovePressed(_ sender: NSSegmentedControl) {
 		switch sender.selectedSegment {
 		case 0:

MenuBarDock/PreferencesViewController.swift

@@ -18,6 +18,7 @@ enum UserPrefsDefaultValues {
 	static let appOpeningMethods: [String: AppOpeningMethod] = [:] // openableApp id is the key
 	static let hideActiveAppFromRunningApps = true
 	static let hideFinderFromRunningApps = false
+    static let preserveAppOrder = true
 	static let regularAppsUrls: [URL] = []
 	static let sideToShowRunningApps: SideToShowRunningApps = .right
 	static let hideDuplicateApps = true
@@ -34,6 +35,7 @@ class UserPrefs {
 	var appOpeningMethods = UserPrefsDefaultValues.appOpeningMethods
 	var hideActiveAppFromRunningApps = UserPrefsDefaultValues.hideActiveAppFromRunningApps
 	var hideFinderFromRunningApps = UserPrefsDefaultValues.hideFinderFromRunningApps
+    var preserveAppOrder = UserPrefsDefaultValues.preserveAppOrder
 	var regularAppsUrls = UserPrefsDefaultValues.regularAppsUrls
 	var sideToShowRunningApps = UserPrefsDefaultValues.sideToShowRunningApps
 	var hideDuplicateApps = UserPrefsDefaultValues.hideDuplicateApps
@@ -47,6 +49,7 @@ class UserPrefs {
 		defaultAppOpeningMethod = UserPrefsDefaultValues.defaultAppOpeningMethod
 		hideActiveAppFromRunningApps = UserPrefsDefaultValues.hideActiveAppFromRunningApps
 		hideFinderFromRunningApps = UserPrefsDefaultValues.hideFinderFromRunningApps
+        preserveAppOrder = UserPrefsDefaultValues.preserveAppOrder
 		// don't reset regularAppsUrls, it's not right
 		sideToShowRunningApps = UserPrefsDefaultValues.sideToShowRunningApps
 		hideDuplicateApps = UserPrefsDefaultValues.hideDuplicateApps
@@ -70,6 +73,7 @@ class UserPrefs {
 		})), forKey: Constants.UserPrefs.appOpeningMethods)
 		UserDefaults.standard.set(hideActiveAppFromRunningApps, forKey: Constants.UserPrefs.hideActiveAppFromRunningApps)
 		UserDefaults.standard.set(hideFinderFromRunningApps, forKey: Constants.UserPrefs.hideFinderFromRunningApps)
+        UserDefaults.standard.set(preserveAppOrder, forKey: Constants.UserPrefs.preserveAppOrder)
 		UserDefaults.standard.set(regularAppsUrls.map { $0.absoluteString }, forKey: Constants.UserPrefs.regularAppsUrls)
 		UserDefaults.standard.set(sideToShowRunningApps.rawValue, forKey: Constants.UserPrefs.sideToShowRunningApps)
 		UserDefaults.standard.set(hideDuplicateApps, forKey: Constants.UserPrefs.hideDuplicateApps)
@@ -112,6 +116,9 @@ class UserPrefs {
 		if let hideFinderFromRunningApps = UserDefaults.standard.object(forKey: Constants.UserPrefs.hideFinderFromRunningApps) as? Bool {
 			self.hideFinderFromRunningApps = hideFinderFromRunningApps
 		}
+        if let preserveAppOrder = UserDefaults.standard.object(forKey: Constants.UserPrefs.preserveAppOrder) as? Bool {
+            self.preserveAppOrder = preserveAppOrder
+        }
 
 		if let regularAppsUrlsStrs = UserDefaults.standard.object(forKey: Constants.UserPrefs.regularAppsUrls) as? [String] {
 			var res: [URL] = []