Fix: Window Actions (#1627)

ibrahimcetin · web-flow · commit c4f114c1b5b6 · 2024-03-17T11:32:14.000-05:00
* - Fix #1625 - Refactor the code to be consistent - Remove unnecessary code * Use SceneID enum instead of hard-coded settings
diff --git a/CodeEdit/AppDelegate.swift b/CodeEdit/AppDelegate.swift
@@ -12,6 +12,9 @@ import CodeEditSymbols
 final class AppDelegate: NSObject, NSApplicationDelegate, ObservableObject {
     private let updater = SoftwareUpdater()
 
+    @Environment(\.openWindow)
+    private var openWindow
+
     func applicationDidFinishLaunching(_ notification: Notification) {
         enableWindowSizeSaveOnQuit()
         Settings.shared.preferences.general.appAppearance.applyAppearance()
@@ -79,7 +82,7 @@ final class AppDelegate: NSObject, NSApplicationDelegate, ObservableObject {
         switch behavior {
         case .welcome:
             if !tryFocusWindow(id: .welcome) {
-                NSApp.openWindow(.welcome)
+                openWindow(sceneID: .welcome)
             }
         case .openPanel:
             CodeEditDocumentController.shared.openDocument(self)
@@ -141,11 +144,11 @@ final class AppDelegate: NSObject, NSApplicationDelegate, ObservableObject {
     // MARK: - Open windows
 
     @IBAction private func openWelcome(_ sender: Any) {
-        NSApp.openWindow(.welcome)
+        openWindow(sceneID: .welcome)
     }
 
     @IBAction private func openAbout(_ sender: Any) {
-        NSApp.openWindow(.about)
+        openWindow(sceneID: .about)
     }
 
     @IBAction func openFeedback(_ sender: Any) {
diff --git a/CodeEdit/CodeEditApp.swift b/CodeEdit/CodeEditApp.swift
@@ -37,7 +37,7 @@ struct CodeEditApp: App {
             NSDocumentGroup(for: WorkspaceDocument.self) { workspace in
                 WindowSplitView(workspace: workspace)
             } defaultAction: {
-                openWindow(id: SceneID.welcome.rawValue)
+                openWindow(sceneID: .welcome)
             }
             .register(.document(WorkspaceDocument.self)) // Required to make transition modifier work
             .transition(.documentWindow)
diff --git a/CodeEdit/Features/Documents/Controllers/CodeEditDocumentController.swift b/CodeEdit/Features/Documents/Controllers/CodeEditDocumentController.swift
@@ -6,8 +6,12 @@
 //
 
 import Cocoa
+import SwiftUI
 
 final class CodeEditDocumentController: NSDocumentController {
+    @Environment(\.openWindow)
+    private var openWindow
+
     lazy var fileManager: FileManager = {
         FileManager.default
     }()
@@ -81,7 +85,7 @@ final class CodeEditDocumentController: NSDocumentController {
             switch Settings[\.general].reopenWindowAfterClose {
             case .showWelcomeWindow:
                 // Opens the welcome window
-                NSApp.openWindow(.welcome)
+                openWindow(sceneID: .welcome)
             case .quit:
                 // Quits CodeEdit
                 NSApplication.shared.terminate(nil)
diff --git a/CodeEdit/Features/Settings/SettingsWindow.swift b/CodeEdit/Features/Settings/SettingsWindow.swift
@@ -11,11 +11,11 @@ struct SettingsWindow: Scene {
     private let updater = SoftwareUpdater()
 
     var body: some Scene {
-        Window("Settings", id: "settings") {
+        Window("Settings", id: SceneID.settings.rawValue) {
             SettingsView(updater: updater)
                 .frame(minWidth: 715, maxWidth: 715)
                 .task {
-                    let window = NSApp.windows.first { $0.identifier?.rawValue == "settings" }!
+                    let window = NSApp.windows.first { $0.identifier?.rawValue == SceneID.settings.rawValue }!
                     window.titlebarAppearsTransparent = true
                 }
         }
diff --git a/CodeEdit/Features/Settings/Views/View+ConstrainHeightToWindow.swift b/CodeEdit/Features/Settings/Views/View+ConstrainHeightToWindow.swift
@@ -9,7 +9,7 @@ import SwiftUI
 
 extension NSWindow {
     var isSettingsWindow: Bool {
-        self.identifier?.rawValue == "settings"
+        self.identifier?.rawValue == SceneID.settings.rawValue
     }
 }
 
diff --git a/CodeEdit/Features/Settings/Views/View+HideSidebarToggle.swift b/CodeEdit/Features/Settings/Views/View+HideSidebarToggle.swift
@@ -17,7 +17,7 @@ struct HideSidebarToggleViewModifier: ViewModifier {
     func body(content: Content) -> some View {
         content
             .task {
-                let window = NSApp.windows.first { $0.identifier?.rawValue == "settings" }!
+                let window = NSApp.windows.first { $0.identifier?.rawValue == SceneID.settings.rawValue }!
                 let sidebaritem = "com.apple.SwiftUI.navigationSplitView.toggleSidebar"
                 let index = window.toolbar?.items.firstIndex { $0.itemIdentifier.rawValue == sidebaritem }
                 if let index {
diff --git a/CodeEdit/Features/Welcome/Views/WelcomeWindow.swift b/CodeEdit/Features/Welcome/Views/WelcomeWindow.swift
@@ -46,7 +46,7 @@ struct WelcomeWindow: Scene {
                     dismiss()
                     CodeEditDocumentController.shared.openDocument(
                         onCompletion: { _, _ in opened() },
-                        onCancel: { openWindow(id: SceneID.welcome.rawValue) }
+                        onCancel: { openWindow(sceneID: .welcome) }
                     )
                 }
             } newDocument: {
diff --git a/CodeEdit/Features/WindowCommands/ExtensionCommands.swift b/CodeEdit/Features/WindowCommands/ExtensionCommands.swift
@@ -17,7 +17,7 @@ struct ExtensionCommands: Commands {
     var body: some Commands {
         CommandMenu("Extensions") {
             Button("Open Extensions Window") {
-                openWindow(id: SceneID.extensions.rawValue)
+                openWindow(sceneID: .extensions)
             }
         }
     }
diff --git a/CodeEdit/Features/WindowCommands/MainCommands.swift b/CodeEdit/Features/WindowCommands/MainCommands.swift
@@ -15,7 +15,7 @@ struct MainCommands: Commands {
     var body: some Commands {
         CommandGroup(replacing: .appInfo) {
             Button("About CodeEdit") {
-                openWindow(id: SceneID.about.rawValue)
+                openWindow(sceneID: .about)
             }
 
             Button("Check for updates...") {
@@ -25,7 +25,7 @@ struct MainCommands: Commands {
 
         CommandGroup(replacing: .appSettings) {
             Button("Settings...") {
-                openWindow(id: "settings")
+                openWindow(sceneID: .settings)
             }
             .keyboardShortcut(",")
         }
diff --git a/CodeEdit/Features/WindowCommands/Utils/CommandsFixes.swift b/CodeEdit/Features/WindowCommands/Utils/CommandsFixes.swift
@@ -12,11 +12,6 @@ extension EventModifiers {
 }
 
 extension NSMenuItem {
-
-    /// Helper variable to allow opening SwiftUI windows from anywhere in the app.
-    /// Don't use this, unless you know what you're doing.
-    static var openWindowAction: (() -> (SceneID?, (any Codable & Hashable)?))?
-
     @objc
     fileprivate func fixAlternate(_ newValue: NSEvent.ModifierFlags) {
 
diff --git a/CodeEdit/Features/WindowCommands/WindowCommands.swift b/CodeEdit/Features/WindowCommands/WindowCommands.swift
@@ -8,47 +8,25 @@
 import SwiftUI
 
 struct WindowCommands: Commands {
-
     @Environment(\.openWindow)
     var openWindow
 
     var body: some Commands {
         CommandGroup(replacing: .singleWindowList) {
             Button("Welcome to CodeEdit") {
-                NSApp.openWindow(.welcome)
+                openWindow(sceneID: .welcome)
             }
             .keyboardShortcut("1", modifiers: [.shift, .command])
 
             Button("About CodeEdit") {
-                NSApp.openWindow(.about)
+                openWindow(sceneID: .about)
             }
             .keyboardShortcut("2", modifiers: [.shift, .command])
 
             Button("Manage Extensions") {
-                NSApp.openWindow(.extensions)
+                openWindow(sceneID: .extensions)
             }
             .keyboardShortcut("3", modifiers: [.shift, .command])
         }
-
-        CommandGroup(after: .windowArrangement) {
-            // This command is used to open SwiftUI windows from AppKit.
-            // It should not be used by the user.
-            // This menu item will be hidden (see WindowCommands/Utils/CommandsFixes.swift)
-            Button("OpenWindowAction") {
-                guard let result = NSMenuItem.openWindowAction?() else {
-                    return
-                }
-                switch result {
-                case (.some(let id), .none):
-                    openWindow(id: id.rawValue)
-                case (.none, .some(let data)):
-                    openWindow(value: data)
-                case let (.some(id), .some(data)):
-                    openWindow(id: id.rawValue, value: data)
-                default:
-                    break
-                }
-            }
-        }
     }
 }
diff --git a/CodeEdit/SceneID.swift b/CodeEdit/SceneID.swift
@@ -11,4 +11,5 @@ enum SceneID: String, CaseIterable {
     case welcome
     case about
     case extensions
+    case settings
 }
diff --git a/CodeEdit/Utils/Extensions/NSApplication/NSApp+openWindow.swift b/CodeEdit/Utils/Extensions/NSApplication/NSApp+openWindow.swift
@@ -6,30 +6,15 @@
 //
 
 import AppKit
+import SwiftUI
 
-extension NSApplication {
-    func openWindow(_ id: SceneID) {
-        NSMenuItem.openWindowAction = { (id, nil) }
-        openWindowPerform()
-    }
-
-    func openWindow(_ id: SceneID, value: any Codable & Hashable) {
-        NSMenuItem.openWindowAction = { (id, value) }
-        openWindowPerform()
-    }
-
-    func openWindow(value: any Codable & Hashable) {
-        NSMenuItem.openWindowAction = { (nil, value) }
-        openWindowPerform()
-    }
-
-    private func openWindowPerform() {
-        let item = NSApp.windowsMenu?.items.first { $0.title == "OpenWindowAction" }
-        if let item, let action = item.action {
-            NSApp.sendAction(action, to: item.representedObject, from: nil)
-        }
+extension OpenWindowAction {
+    func callAsFunction(sceneID: SceneID) {
+        callAsFunction(id: sceneID.rawValue)
     }
+}
 
+extension NSApplication {
     func closeWindow(_ id: SceneID) {
         windows.first { $0.identifier?.rawValue == id.rawValue }?.close()
     }

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ struct CodeEditApp: App {`
`37`	`37`	`NSDocumentGroup(for: WorkspaceDocument.self) { workspace in`
`38`	`38`	`WindowSplitView(workspace: workspace)`
`39`	`39`	`} defaultAction: {`
`40`		`- openWindow(id: SceneID.welcome.rawValue)`
	`40`	`+ openWindow(sceneID: .welcome)`
`41`	`41`	`}`
`42`	`42`	`.register(.document(WorkspaceDocument.self)) // Required to make transition modifier work`
`43`	`43`	`.transition(.documentWindow)`
Original file line number	Diff line number	Diff line change
`@@ -11,11 +11,11 @@ struct SettingsWindow: Scene {`
`11`	`11`	`private let updater = SoftwareUpdater()`
`12`	`12`
`13`	`13`	`var body: some Scene {`
`14`		`- Window("Settings", id: "settings") {`
	`14`	`+ Window("Settings", id: SceneID.settings.rawValue) {`
`15`	`15`	`SettingsView(updater: updater)`
`16`	`16`	`.frame(minWidth: 715, maxWidth: 715)`
`17`	`17`	`.task {`
`18`		`- let window = NSApp.windows.first { $0.identifier?.rawValue == "settings" }!`
	`18`	`+ let window = NSApp.windows.first { $0.identifier?.rawValue == SceneID.settings.rawValue }!`
`19`	`19`	`window.titlebarAppearsTransparent = true`
`20`	`20`	`}`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import SwiftUI`
`9`	`9`
`10`	`10`	`extension NSWindow {`
`11`	`11`	`var isSettingsWindow: Bool {`
`12`		`- self.identifier?.rawValue == "settings"`
	`12`	`+ self.identifier?.rawValue == SceneID.settings.rawValue`
`13`	`13`	`}`
`14`	`14`	`}`
`15`	`15`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ struct WelcomeWindow: Scene {`
`46`	`46`	`dismiss()`
`47`	`47`	`CodeEditDocumentController.shared.openDocument(`
`48`	`48`	`onCompletion: { _, _ in opened() },`
`49`		`- onCancel: { openWindow(id: SceneID.welcome.rawValue) }`
	`49`	`+ onCancel: { openWindow(sceneID: .welcome) }`
`50`	`50`	`)`
`51`	`51`	`}`
`52`	`52`	`} newDocument: {`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ struct ExtensionCommands: Commands {`
`17`	`17`	`var body: some Commands {`
`18`	`18`	`CommandMenu("Extensions") {`
`19`	`19`	`Button("Open Extensions Window") {`
`20`		`- openWindow(id: SceneID.extensions.rawValue)`
	`20`	`+ openWindow(sceneID: .extensions)`
`21`	`21`	`}`
`22`	`22`	`}`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ struct MainCommands: Commands {`
`15`	`15`	`var body: some Commands {`
`16`	`16`	`CommandGroup(replacing: .appInfo) {`
`17`	`17`	`Button("About CodeEdit") {`
`18`		`- openWindow(id: SceneID.about.rawValue)`
	`18`	`+ openWindow(sceneID: .about)`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`Button("Check for updates...") {`
`@@ -25,7 +25,7 @@ struct MainCommands: Commands {`
`25`	`25`
`26`	`26`	`CommandGroup(replacing: .appSettings) {`
`27`	`27`	`Button("Settings...") {`
`28`		`- openWindow(id: "settings")`
	`28`	`+ openWindow(sceneID: .settings)`
`29`	`29`	`}`
`30`	`30`	`.keyboardShortcut(",")`
`31`	`31`	`}`