Extract helper function to create URIs from paths and use it across the codebase

Author: rafaelfranca

vscode/src/common.ts

@@ -144,3 +144,9 @@ export function featureEnabled(feature: keyof typeof FEATURE_FLAGS): boolean {
   // If that number is below the percentage, then the feature is enabled for this user
   return hashNum < percentage;
 }
+
+// Helper to create a URI from a file path and optional path segments
+// Usage: pathToUri("/", "opt", "bin") instead of vscode.Uri.joinPath(vscode.Uri.file("/"), "opt", "bin")
+export function pathToUri(basePath: string, ...segments: string[]): vscode.Uri {
+  return vscode.Uri.joinPath(vscode.Uri.file(basePath), ...segments);
+}

vscode/src/ruby/asdf.ts

@@ -5,17 +5,15 @@ import * as vscode from "vscode";
 
 import { VersionManager, ActivationResult } from "./versionManager";
 import { WorkspaceChannel } from "../workspaceChannel";
+import { pathToUri } from "../common";
 
 // A tool to manage multiple runtime versions with a single CLI tool
 //
 // Learn more: https://github.com/asdf-vm/asdf
 export class Asdf extends VersionManager {
   private static getPossibleExecutablePaths(): vscode.Uri[] {
     // These directories are where we can find the ASDF executable for v0.16 and above
-    return [
-      vscode.Uri.joinPath(vscode.Uri.file("/"), "opt", "homebrew", "bin"),
-      vscode.Uri.joinPath(vscode.Uri.file("/"), "usr", "local", "bin"),
-    ];
+    return [pathToUri("/", "opt", "homebrew", "bin"), pathToUri("/", "usr", "local", "bin")];
   }
 
   private static getPossibleScriptPaths(): vscode.Uri[] {
@@ -28,10 +26,10 @@ export class Asdf extends VersionManager {
     // 3. Homebrew M series
     // 4. Homebrew Intel series
     return [
-      vscode.Uri.joinPath(vscode.Uri.file(os.homedir()), ".asdf", scriptName),
-      vscode.Uri.joinPath(vscode.Uri.file("/"), "opt", "asdf-vm", scriptName),
-      vscode.Uri.joinPath(vscode.Uri.file("/"), "opt", "homebrew", "opt", "asdf", "libexec", scriptName),
-      vscode.Uri.joinPath(vscode.Uri.file("/"), "usr", "local", "opt", "asdf", "libexec", scriptName),
+      pathToUri(os.homedir(), ".asdf", scriptName),
+      pathToUri("/", "opt", "asdf-vm", scriptName),
+      pathToUri("/", "opt", "homebrew", "opt", "asdf", "libexec", scriptName),
+      pathToUri("/", "usr", "local", "opt", "asdf", "libexec", scriptName),
     ];
   }
 

vscode/src/ruby/chruby.ts

@@ -4,6 +4,7 @@ import path from "path";
 import * as vscode from "vscode";
 
 import { WorkspaceChannel } from "../workspaceChannel";
+import { pathToUri } from "../common";
 
 import { ActivationResult, VersionManager, ACTIVATION_SEPARATOR } from "./versionManager";
 
@@ -26,10 +27,7 @@ export class Chruby extends VersionManager {
   }
 
   // Only public so that we can point to a different directory in tests
-  public rubyInstallationUris = [
-    vscode.Uri.joinPath(vscode.Uri.file(os.homedir()), ".rubies"),
-    vscode.Uri.joinPath(vscode.Uri.file("/"), "opt", "rubies"),
-  ];
+  public rubyInstallationUris = [pathToUri(os.homedir(), ".rubies"), pathToUri("/", "opt", "rubies")];
 
   constructor(
     workspaceFolder: vscode.WorkspaceFolder,

vscode/src/ruby/mise.ts

@@ -4,6 +4,7 @@ import * as vscode from "vscode";
 
 import { VersionManager, ActivationResult } from "./versionManager";
 import { WorkspaceChannel } from "../workspaceChannel";
+import { pathToUri } from "../common";
 
 // Mise (mise en place) is a manager for dev tools, environment variables and tasks
 //
@@ -16,9 +17,9 @@ export class Mise extends VersionManager {
   // 3. Installation from `apt install mise`
   private static getPossiblePaths(): vscode.Uri[] {
     return [
-      vscode.Uri.joinPath(vscode.Uri.file(os.homedir()), ".local", "bin", "mise"),
-      vscode.Uri.joinPath(vscode.Uri.file("/"), "opt", "homebrew", "bin", "mise"),
-      vscode.Uri.joinPath(vscode.Uri.file("/"), "usr", "bin", "mise"),
+      pathToUri(os.homedir(), ".local", "bin", "mise"),
+      pathToUri("/", "opt", "homebrew", "bin", "mise"),
+      pathToUri("/", "usr", "bin", "mise"),
     ];
   }
 

vscode/src/ruby/rubyInstaller.ts

@@ -3,6 +3,7 @@ import os from "os";
 import * as vscode from "vscode";
 
 import { Chruby } from "./chruby";
+import { pathToUri } from "../common";
 
 interface RubyVersion {
   engine?: string;
@@ -35,8 +36,8 @@ export class RubyInstaller extends Chruby {
     const [major, minor, _patch] = rubyVersion.version.split(".").map(Number);
 
     const possibleInstallationUris = [
-      vscode.Uri.joinPath(vscode.Uri.file("C:"), `Ruby${major}${minor}-${os.arch()}`),
-      vscode.Uri.joinPath(vscode.Uri.file(os.homedir()), `Ruby${major}${minor}-${os.arch()}`),
+      pathToUri("C:", `Ruby${major}${minor}-${os.arch()}`),
+      pathToUri(os.homedir(), `Ruby${major}${minor}-${os.arch()}`),
     ];
 
     for (const installationUri of possibleInstallationUris) {

vscode/src/ruby/rvm.ts

@@ -4,6 +4,7 @@ import * as vscode from "vscode";
 
 import { ActivationResult, VersionManager } from "./versionManager";
 import { WorkspaceChannel } from "../workspaceChannel";
+import { pathToUri } from "../common";
 
 // Ruby enVironment Manager. It manages Ruby application environments and enables switching between them.
 // Learn more:
@@ -38,9 +39,9 @@ export class Rvm extends VersionManager {
 
   async findRvmInstallation(): Promise<vscode.Uri> {
     const possiblePaths = [
-      vscode.Uri.joinPath(vscode.Uri.file(os.homedir()), ".rvm", "bin", "rvm-auto-ruby"),
-      vscode.Uri.joinPath(vscode.Uri.file("/"), "usr", "local", "rvm", "bin", "rvm-auto-ruby"),
-      vscode.Uri.joinPath(vscode.Uri.file("/"), "usr", "share", "rvm", "bin", "rvm-auto-ruby"),
+      pathToUri(os.homedir(), ".rvm", "bin", "rvm-auto-ruby"),
+      pathToUri("/", "usr", "local", "rvm", "bin", "rvm-auto-ruby"),
+      pathToUri("/", "usr", "share", "rvm", "bin", "rvm-auto-ruby"),
     ];
 
     for (const uri of possiblePaths) {

vscode/src/test/suite/debugger.test.ts

@@ -10,7 +10,7 @@ import { Debugger } from "../../debugger";
 import { Ruby, ManagerIdentifier } from "../../ruby";
 import { Workspace } from "../../workspace";
 import { WorkspaceChannel } from "../../workspaceChannel";
-import { LOG_CHANNEL, asyncExec } from "../../common";
+import { LOG_CHANNEL, asyncExec, pathToUri } from "../../common";
 import { RUBY_VERSION } from "../rubyVersion";
 
 import { FAKE_TELEMETRY } from "./fakeTelemetry";
@@ -156,7 +156,7 @@ suite("Debugger", () => {
       {
         parallel: "1",
         ...ruby.env,
-        BUNDLE_GEMFILE: vscode.Uri.joinPath(vscode.Uri.file(tmpPath), ".ruby-lsp", "Gemfile").fsPath,
+        BUNDLE_GEMFILE: pathToUri(tmpPath, ".ruby-lsp", "Gemfile").fsPath,
       },
       configs.env,
     );

vscode/src/test/suite/ruby/mise.test.ts

@@ -53,7 +53,7 @@ suite("Mise", () => {
     });
     const findStub = sandbox
       .stub(mise, "findMiseUri")
-      .resolves(vscode.Uri.joinPath(vscode.Uri.file(os.homedir()), ".local", "bin", "mise"));
+      .resolves(common.pathToUri(os.homedir(), ".local", "bin", "mise"));
 
     const { env, version, yjit } = await mise.activate();
 

vscode/src/test/suite/ruby/rvm.test.ts

@@ -46,7 +46,7 @@ suite("RVM", () => {
 
     const installationPathStub = sandbox
       .stub(rvm, "findRvmInstallation")
-      .resolves(vscode.Uri.joinPath(vscode.Uri.file(os.homedir()), ".rvm", "bin", "rvm-auto-ruby"));
+      .resolves(common.pathToUri(os.homedir(), ".rvm", "bin", "rvm-auto-ruby"));
 
     const envStub = ["3.0.0", "/path/to/gems", "true", `ANY${VALUE_SEPARATOR}true`].join(FIELD_SEPARATOR);