Pass customBundleGemfile from Ruby to VersionManager

Instead of having both Ruby and VersionManager independently read,
expand, and resolve the bundleGemfile setting, Ruby now passes the
resolved value down to VersionManager through the constructor.

Author: rafaelfranca

vscode/src/common.ts

@@ -88,12 +88,6 @@ export const FEATURE_FLAGS = {
 
 type FeatureFlagConfigurationKey = keyof typeof FEATURE_FLAGS | "all";
 
-// Expands VS Code predefined variables (e.g., `${workspaceFolder}`) in a configuration string, since VS Code does not
-// automatically expand variables in extension settings retrieved via `getConfiguration()`
-export function expandPath(value: string, workspaceFolder: vscode.WorkspaceFolder): string {
-  return value.replace(/\$\{workspaceFolder\}/g, workspaceFolder.uri.fsPath);
-}
-
 // Creates a debounced version of a function with the specified delay. If the function is invoked before the delay runs
 // out, then the previous invocation of the function gets cancelled and a new one is scheduled.
 //

vscode/src/ruby.ts

@@ -3,7 +3,7 @@ import os from "os";
 
 import * as vscode from "vscode";
 
-import { asyncExec, expandPath, RubyInterface } from "./common";
+import { asyncExec, RubyInterface } from "./common";
 import { WorkspaceChannel } from "./workspaceChannel";
 import { Shadowenv, UntrustedWorkspaceError } from "./ruby/shadowenv";
 import { Chruby } from "./ruby/chruby";
@@ -84,12 +84,10 @@ export class Ruby implements RubyInterface {
     this.telemetry = telemetry;
 
     const rawBundleGemfile: string = vscode.workspace.getConfiguration("rubyLsp").get("bundleGemfile")!;
-    const customBundleGemfile = expandPath(rawBundleGemfile, this.workspaceFolder);
+    const customBundleGemfile = rawBundleGemfile.replace(/\$\{workspaceFolder\}/g, this.workspaceFolder.uri.fsPath);
 
     if (customBundleGemfile.length > 0) {
-      this.customBundleGemfile = path.isAbsolute(customBundleGemfile)
-        ? customBundleGemfile
-        : path.resolve(path.join(this.workspaceFolder.uri.fsPath, customBundleGemfile));
+      this.customBundleGemfile = path.resolve(this.workspaceFolder.uri.fsPath, customBundleGemfile);
     }
   }
 
@@ -140,6 +138,7 @@ export class Ruby implements RubyInterface {
           this.context,
           this.manuallySelectRuby.bind(this),
           workspaceRubyPath,
+          this.customBundleGemfile,
         ),
       );
     } else {
@@ -174,6 +173,7 @@ export class Ruby implements RubyInterface {
               this.context,
               this.manuallySelectRuby.bind(this),
               globalRubyPath,
+              this.customBundleGemfile,
             ),
           );
         } else {
@@ -297,56 +297,54 @@ export class Ruby implements RubyInterface {
   }
 
   private async runManagerActivation() {
+    const manuallySelectRuby = this.manuallySelectRuby.bind(this);
+    const args = [
+      this.workspaceFolder,
+      this.outputChannel,
+      this.context,
+      manuallySelectRuby,
+      this.customBundleGemfile,
+    ] as const;
+
     switch (this.versionManager.identifier) {
       case ManagerIdentifier.Asdf:
-        await this.runActivation(
-          new Asdf(this.workspaceFolder, this.outputChannel, this.context, this.manuallySelectRuby.bind(this)),
-        );
+        await this.runActivation(new Asdf(...args));
         break;
       case ManagerIdentifier.Chruby:
-        await this.runActivation(
-          new Chruby(this.workspaceFolder, this.outputChannel, this.context, this.manuallySelectRuby.bind(this)),
-        );
+        await this.runActivation(new Chruby(...args));
         break;
       case ManagerIdentifier.Rbenv:
-        await this.runActivation(
-          new Rbenv(this.workspaceFolder, this.outputChannel, this.context, this.manuallySelectRuby.bind(this)),
-        );
+        await this.runActivation(new Rbenv(...args));
         break;
       case ManagerIdentifier.Rvm:
-        await this.runActivation(
-          new Rvm(this.workspaceFolder, this.outputChannel, this.context, this.manuallySelectRuby.bind(this)),
-        );
+        await this.runActivation(new Rvm(...args));
         break;
       case ManagerIdentifier.Mise:
-        await this.runActivation(
-          new Mise(this.workspaceFolder, this.outputChannel, this.context, this.manuallySelectRuby.bind(this)),
-        );
+        await this.runActivation(new Mise(...args));
         break;
       case ManagerIdentifier.Rv:
-        await this.runActivation(
-          new Rv(this.workspaceFolder, this.outputChannel, this.context, this.manuallySelectRuby.bind(this)),
-        );
+        await this.runActivation(new Rv(...args));
         break;
       case ManagerIdentifier.RubyInstaller:
-        await this.runActivation(
-          new RubyInstaller(this.workspaceFolder, this.outputChannel, this.context, this.manuallySelectRuby.bind(this)),
-        );
+        await this.runActivation(new RubyInstaller(...args));
         break;
       case ManagerIdentifier.Custom:
-        await this.runActivation(
-          new Custom(this.workspaceFolder, this.outputChannel, this.context, this.manuallySelectRuby.bind(this)),
-        );
+        await this.runActivation(new Custom(...args));
         break;
       case ManagerIdentifier.None:
         await this.runActivation(
-          new None(this.workspaceFolder, this.outputChannel, this.context, this.manuallySelectRuby.bind(this)),
+          new None(
+            this.workspaceFolder,
+            this.outputChannel,
+            this.context,
+            manuallySelectRuby,
+            undefined,
+            this.customBundleGemfile,
+          ),
         );
         break;
       default:
-        await this.runActivation(
-          new Shadowenv(this.workspaceFolder, this.outputChannel, this.context, this.manuallySelectRuby.bind(this)),
-        );
+        await this.runActivation(new Shadowenv(...args));
         break;
     }
   }

vscode/src/ruby/chruby.ts

@@ -28,8 +28,9 @@ export class Chruby extends VersionManager {
     outputChannel: WorkspaceChannel,
     context: vscode.ExtensionContext,
     manuallySelectRuby: () => Promise<void>,
+    customBundleGemfile?: string,
   ) {
-    super(workspaceFolder, outputChannel, context, manuallySelectRuby);
+    super(workspaceFolder, outputChannel, context, manuallySelectRuby, customBundleGemfile);
 
     const configuredRubies = vscode.workspace
       .getConfiguration("rubyLsp")

vscode/src/ruby/none.ts

@@ -21,8 +21,9 @@ export class None extends VersionManager {
     context: vscode.ExtensionContext,
     manuallySelectRuby: () => Promise<void>,
     rubyPath?: string,
+    customBundleGemfile?: string,
   ) {
-    super(workspaceFolder, outputChannel, context, manuallySelectRuby);
+    super(workspaceFolder, outputChannel, context, manuallySelectRuby, customBundleGemfile);
     this.rubyPath = rubyPath ?? "ruby";
   }
 

vscode/src/ruby/versionManager.ts

@@ -4,7 +4,7 @@ import os from "os";
 import * as vscode from "vscode";
 
 import { WorkspaceChannel } from "../workspaceChannel";
-import { asyncExec, expandPath } from "../common";
+import { asyncExec } from "../common";
 
 export interface ActivationResult {
   env: NodeJS.ProcessEnv;
@@ -31,19 +31,13 @@ export abstract class VersionManager {
     outputChannel: WorkspaceChannel,
     context: vscode.ExtensionContext,
     manuallySelectRuby: () => Promise<void>,
+    customBundleGemfile?: string,
   ) {
     this.workspaceFolder = workspaceFolder;
     this.outputChannel = outputChannel;
     this.context = context;
     this.manuallySelectRuby = manuallySelectRuby;
-    const rawBundleGemfile: string = vscode.workspace.getConfiguration("rubyLsp").get("bundleGemfile")!;
-    const customBundleGemfile = expandPath(rawBundleGemfile, this.workspaceFolder);
-
-    if (customBundleGemfile.length > 0) {
-      this.customBundleGemfile = path.isAbsolute(customBundleGemfile)
-        ? customBundleGemfile
-        : path.resolve(path.join(this.workspaceFolder.uri.fsPath, customBundleGemfile));
-    }
+    this.customBundleGemfile = customBundleGemfile;
 
     this.bundleUri = this.customBundleGemfile
       ? vscode.Uri.file(path.dirname(this.customBundleGemfile))

vscode/src/test/suite/common.test.ts

@@ -3,37 +3,7 @@ import * as assert from "assert";
 import * as vscode from "vscode";
 import sinon from "sinon";
 
-import { expandPath, featureEnabled, FEATURE_FLAGS } from "../../common";
-
-suite("expandPath", () => {
-  const workspaceFolder: vscode.WorkspaceFolder = {
-    uri: vscode.Uri.file("/home/user/project"),
-    name: "project",
-    index: 0,
-  };
-
-  // eslint-disable-next-line no-template-curly-in-string
-  test("replaces ${workspaceFolder} with the workspace folder path", () => {
-    // eslint-disable-next-line no-template-curly-in-string
-    const result = expandPath("${workspaceFolder}/Gemfile", workspaceFolder);
-    assert.strictEqual(result, "/home/user/project/Gemfile");
-  });
-
-  // eslint-disable-next-line no-template-curly-in-string
-  test("replaces multiple occurrences of ${workspaceFolder}", () => {
-    // eslint-disable-next-line no-template-curly-in-string
-    const result = expandPath("${workspaceFolder}/a:${workspaceFolder}/b", workspaceFolder);
-    assert.strictEqual(result, "/home/user/project/a:/home/user/project/b");
-  });
-
-  test("returns the string unchanged when there is no variable", () => {
-    assert.strictEqual(expandPath("Gemfile", workspaceFolder), "Gemfile");
-  });
-
-  test("returns empty string unchanged", () => {
-    assert.strictEqual(expandPath("", workspaceFolder), "");
-  });
-});
+import { featureEnabled, FEATURE_FLAGS } from "../../common";
 
 suite("featureEnabled", () => {
   let sandbox: sinon.SinonSandbox;

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

@@ -172,6 +172,50 @@ suite("Ruby environment activation", () => {
     assert.strictEqual(context.workspaceState.get(`rubyLsp.workspaceRubyPath.${workspaceFolder.name}`), undefined);
   });
 
+  // eslint-disable-next-line no-template-curly-in-string
+  test("Expands ${workspaceFolder} in bundleGemfile setting", async () => {
+    const tmpPath = fs.mkdtempSync(path.join(os.tmpdir(), "ruby-lsp-test-"));
+    const gemfilePath = path.resolve(tmpPath, "Gemfile");
+    fs.writeFileSync(gemfilePath, "");
+
+    const tmpWorkspaceFolder: vscode.WorkspaceFolder = {
+      uri: vscode.Uri.file(tmpPath),
+      name: path.basename(tmpPath),
+      index: 0,
+    };
+
+    sandbox.stub(vscode.workspace, "getConfiguration").returns({
+      get: (name: string) => {
+        if (name === "rubyVersionManager") {
+          return { identifier: ManagerIdentifier.None };
+        } else if (name === "bundleGemfile") {
+          // eslint-disable-next-line no-template-curly-in-string
+          return "${workspaceFolder}/Gemfile";
+        }
+
+        return undefined;
+      },
+    } as unknown as vscode.WorkspaceConfiguration);
+
+    const envStub = [
+      "3.3.5",
+      "~/.gem/ruby/3.3.5,/opt/rubies/3.3.5/lib/ruby/gems/3.3.0",
+      "true",
+      `ANY${VALUE_SEPARATOR}true`,
+    ].join(FIELD_SEPARATOR);
+
+    sandbox.stub(common, "asyncExec").resolves({
+      stdout: "",
+      stderr: `${ACTIVATION_SEPARATOR}${envStub}${ACTIVATION_SEPARATOR}`,
+    });
+
+    const ruby = new Ruby(context, tmpWorkspaceFolder, outputChannel, FAKE_TELEMETRY);
+    await ruby.activateRuby();
+
+    assert.strictEqual(ruby.env.BUNDLE_GEMFILE, gemfilePath);
+    fs.rmSync(tmpPath, { recursive: true, force: true });
+  });
+
   test("Raises an error if the configured bundleGemfile does not exist", async () => {
     const tmpPath = fs.mkdtempSync(path.join(os.tmpdir(), "ruby-lsp-test-"));
     const tmpWorkspaceFolder: vscode.WorkspaceFolder = {