Refactor resolving environment variables logic to enhance naming

To align with clearer terminology and better reflect the action being performed within the codebase, the method previously named `shouldResolveDocumentAndSelections()` has been refactored to `resolveUserEnvironment()`. This change underscores the function's responsibility to resolve more than just document and selection variables, encompassing the broader set of user environment details. The modification affects key areas in the application, including controllers, models, and runners, ensuring consistency throughout the code.

This adjustment aims to make the code more intuitive and improve maintainability by using more descriptive names that accurately represent the underlying processes. It forms part of our continual effort to enhance code clarity and quality.

App/Sources/Core/Controllers/ApplicationTriggerController.swift

@@ -99,13 +99,13 @@ final class ApplicationTriggerController {
       commandRunner.concurrentRun(
         commands,
         checkCancellation: true,
-        resolveDocumentAndSelections: workflow.shouldResolveDocumentAndSelections()
+        resolveUserEnvironment: workflow.resolveUserEnvironment()
       )
     case .serial:
       commandRunner.serialRun(
         commands,
         checkCancellation: true,
-        resolveDocumentAndSelections: workflow.shouldResolveDocumentAndSelections()
+        resolveUserEnvironment: workflow.resolveUserEnvironment()
       )
     }
   }

App/Sources/Core/Models/Workflow.swift

@@ -198,7 +198,7 @@ extension Workflow {
 }
 
 extension Workflow {
-  func shouldResolveDocumentAndSelections() -> Bool {
+  func resolveUserEnvironment() -> Bool {
     var result: Bool = false
     let keywords = UserSpace.EnvironmentKey.allCases
       .map(\.asTextVariable)

App/Sources/Core/Runners/CommandRunner.swift

@@ -5,8 +5,8 @@ import Combine
 import MachPort
 
 protocol CommandRunning {
-  func serialRun(_ commands: [Command], checkCancellation: Bool, resolveDocumentAndSelections: Bool)
-  func concurrentRun(_ commands: [Command], checkCancellation: Bool, resolveDocumentAndSelections: Bool)
+  func serialRun(_ commands: [Command], checkCancellation: Bool, resolveUserEnvironment: Bool)
+  func concurrentRun(_ commands: [Command], checkCancellation: Bool, resolveUserEnvironment: Bool)
 }
 
 final class CommandRunner: CommandRunning, @unchecked Sendable {
@@ -101,7 +101,7 @@ final class CommandRunner: CommandRunning, @unchecked Sendable {
   func serialRun(
     _ commands: [Command],
     checkCancellation: Bool,
-    resolveDocumentAndSelections: Bool
+    resolveUserEnvironment: Bool
   ) {
     serialTask?.cancel()
     serialTask = Task.detached(priority: .userInitiated) { [weak self] in
@@ -115,7 +115,7 @@ final class CommandRunner: CommandRunning, @unchecked Sendable {
         })
 
         if shouldDismissMissionControl { await missionControl.dismissIfActive() }
-        let snapshot = await UserSpace.shared.snapshot(resolvedDocumentAndSelections: resolveDocumentAndSelections)
+        let snapshot = await UserSpace.shared.snapshot(resolveUserEnvironment: resolveUserEnvironment)
         for command in commands {
           if checkCancellation { try Task.checkCancellation() }
           do {
@@ -129,10 +129,7 @@ final class CommandRunner: CommandRunning, @unchecked Sendable {
     }
   }
 
-  func concurrentRun(
-    _ commands: [Command],
-    checkCancellation: Bool,
-    resolveDocumentAndSelections: Bool
+  func concurrentRun(_ commands: [Command], checkCancellation: Bool, resolveUserEnvironment: Bool
   ) {
     concurrentTask?.cancel()
     concurrentTask = Task.detached(priority: .userInitiated) { [weak self] in
@@ -146,7 +143,7 @@ final class CommandRunner: CommandRunning, @unchecked Sendable {
 
       if shouldDismissMissionControl { await missionControl.dismissIfActive() }
 
-      let snapshot = await UserSpace.shared.snapshot(resolvedDocumentAndSelections: resolveDocumentAndSelections)
+      let snapshot = await UserSpace.shared.snapshot(resolveUserEnvironment: resolveUserEnvironment)
       for command in commands {
         do {
           if checkCancellation { try Task.checkCancellation() }

App/Sources/Core/Runners/MachPortCoordinator.swift

@@ -305,20 +305,15 @@ final class MachPortCoordinator {
       }
     }
 
-    let shouldResolveDocumentAndSelections = workflow.shouldResolveDocumentAndSelections()
+    let resolveUserEnvironment = workflow.resolveUserEnvironment()
     switch workflow.execution {
     case .concurrent:
-      commandRunner.concurrentRun(
-        commands,
-        checkCancellation: checkCancellation,
-        resolveDocumentAndSelections: shouldResolveDocumentAndSelections
+      commandRunner.concurrentRun(commands, checkCancellation: checkCancellation,
+                                  resolveUserEnvironment: resolveUserEnvironment
       )
     case .serial:
-      commandRunner.serialRun(
-        commands,
-        checkCancellation: checkCancellation,
-        resolveDocumentAndSelections: shouldResolveDocumentAndSelections
-      )
+      commandRunner.serialRun(commands, checkCancellation: checkCancellation, 
+                              resolveUserEnvironment: resolveUserEnvironment)
     }
   }
 

App/Sources/Core/UserSpace.swift

@@ -172,14 +172,14 @@ final class UserSpace: Sendable {
 #endif
 
   @MainActor
-  func snapshot(resolvedDocumentAndSelections: Bool) async -> Snapshot {
-    Benchmark.shared.start("snapshot: \(resolvedDocumentAndSelections)")
-    defer { Benchmark.shared.stop("snapshot: \(resolvedDocumentAndSelections)") }
+  func snapshot(resolveUserEnvironment: Bool) async -> Snapshot {
+    Benchmark.shared.start("snapshot: \(resolveUserEnvironment)")
+    defer { Benchmark.shared.stop("snapshot: \(resolveUserEnvironment)") }
     var selections = [String]()
     var documentPath: String?
     var selectedText: String = ""
 
-    if resolvedDocumentAndSelections,
+    if resolveUserEnvironment,
         let frontmostApplication = try? frontmostApplication() {
       if let documentPathFromAX = try? self.documentPath(for: frontmostApplication) {
         documentPath = documentPathFromAX

App/Sources/UI/Reducers/DetailCommandActionReducer.swift

@@ -21,7 +21,7 @@ final class DetailCommandActionReducer {
       let runCommand = command
       Task {
         do {
-          try await commandRunner.run(runCommand, snapshot: UserSpace.shared.snapshot(resolvedDocumentAndSelections: false))
+          try await commandRunner.run(runCommand, snapshot: UserSpace.shared.snapshot(resolveUserEnvironment: false))
         } catch let error as KeyboardCommandRunnerError {
           let alert = await NSAlert(error: error)
           await alert.runModal()
@@ -161,9 +161,7 @@ final class DetailCommandActionReducer {
             let path = (source as NSString).expandingTildeInPath
             try await commandRunner.run(
               .open(.init(path: path)),
-              snapshot: UserSpace.shared.snapshot(
-                resolvedDocumentAndSelections: false
-              )
+              snapshot: UserSpace.shared.snapshot(resolveUserEnvironment: false)
             )
           }
         case .reveal(let path):

App/Sources/UI/Reducers/DetailViewActionReducer.swift

@@ -153,9 +153,9 @@ final class DetailViewActionReducer {
         let commands = workflow.commands.filter(\.isEnabled)
         switch workflow.execution {
         case .concurrent:
-          commandRunner.concurrentRun(commands, checkCancellation: true, resolveDocumentAndSelections: true)
+          commandRunner.concurrentRun(commands, checkCancellation: true, resolveUserEnvironment: true)
         case .serial:
-          commandRunner.serialRun(commands, checkCancellation: true, resolveDocumentAndSelections: true)
+          commandRunner.serialRun(commands, checkCancellation: true, resolveUserEnvironment: true)
         }
         return .none
       }

UnitTests/Sources/Controllers/ApplicationTriggerControllerTests.swift

@@ -114,11 +114,11 @@ private final class CommandRunner: CommandRunning {
     self.serialRunHandler = serial
   }
 
-  func concurrentRun(_ commands: [Command], checkCancellation: Bool, resolveDocumentAndSelections: Bool) {
+  func concurrentRun(_ commands: [Command], checkCancellation: Bool, resolveUserEnvironment: Bool) {
     concurrentRunHandler(commands)
   }
 
-  func serialRun(_ commands: [Command], checkCancellation: Bool, resolveDocumentAndSelections: Bool) {
+  func serialRun(_ commands: [Command], checkCancellation: Bool, resolveUserEnvironment: Bool) {
     serialRunHandler(commands)
   }
 }