Defer to Bundler to get gemfile and lockfile names (#1139)

Author: vinistock

lib/ruby_lsp/requests/code_lens.rb

@@ -24,7 +24,23 @@ class CodeLens < ExtensibleListener
 
       ResponseType = type_member { { fixed: T::Array[Interface::CodeLens] } }
 
-      BASE_COMMAND = T.let((File.exist?("Gemfile.lock") ? "bundle exec ruby" : "ruby") + " -Itest ", String)
+      BASE_COMMAND = T.let(
+        begin
+          Bundler.with_original_env { Bundler.default_lockfile }
+          "bundle exec ruby"
+        rescue Bundler::GemfileNotFound
+          "ruby"
+        end + " -Itest ",
+        String,
+      )
+      GEMFILE_NAME = T.let(
+        begin
+          Bundler.with_original_env { Bundler.default_gemfile.basename.to_s }
+        rescue Bundler::GemfileNotFound
+          "Gemfile"
+        end,
+        String,
+      )
       ACCESS_MODIFIERS = T.let([:public, :private, :protected], T::Array[Symbol])
       SUPPORTED_TEST_LIBRARIES = T.let(["minitest", "test-unit"], T::Array[String])
 
@@ -111,7 +127,7 @@ def on_call_node_enter(node)
           return
         end
 
-        if @path&.include?("Gemfile") && name == :gem && arguments
+        if @path&.include?(GEMFILE_NAME) && name == :gem && arguments
           first_argument = arguments.arguments.first
           return unless first_argument.is_a?(Prism::StringNode)
 

lib/ruby_lsp/setup_bundler.rb

@@ -25,13 +25,6 @@ def initialize(project_path, branch: nil)
       @project_path = project_path
       @branch = branch
 
-      # Custom bundle paths
-      @custom_dir = T.let(Pathname.new(".ruby-lsp").expand_path(Dir.pwd), Pathname)
-      @custom_gemfile = T.let(@custom_dir + "Gemfile", Pathname)
-      @custom_lockfile = T.let(@custom_dir + "Gemfile.lock", Pathname)
-      @lockfile_hash_path = T.let(@custom_dir + "main_lockfile_hash", Pathname)
-      @last_updated_path = T.let(@custom_dir + "last_updated", Pathname)
-
       # Regular bundle paths
       @gemfile = T.let(
         begin
@@ -43,6 +36,15 @@ def initialize(project_path, branch: nil)
       )
       @lockfile = T.let(@gemfile ? Bundler.default_lockfile : nil, T.nilable(Pathname))
 
+      @gemfile_name = T.let(@gemfile&.basename&.to_s || "Gemfile", String)
+
+      # Custom bundle paths
+      @custom_dir = T.let(Pathname.new(".ruby-lsp").expand_path(Dir.pwd), Pathname)
+      @custom_gemfile = T.let(@custom_dir + @gemfile_name, Pathname)
+      @custom_lockfile = T.let(@custom_dir + (@lockfile&.basename || "Gemfile.lock"), Pathname)
+      @lockfile_hash_path = T.let(@custom_dir + "main_lockfile_hash", Pathname)
+      @last_updated_path = T.let(@custom_dir + "last_updated", Pathname)
+
       @dependencies = T.let(load_dependencies, T::Hash[String, T.untyped])
     end
 
@@ -118,7 +120,7 @@ def write_custom_gemfile
       # If there's a top level Gemfile, we want to evaluate from the custom bundle. We get the source from the top level
       # Gemfile, so if there isn't one we need to add a default source
       if @gemfile&.exist?
-        parts << "eval_gemfile(File.expand_path(\"../Gemfile\", __dir__))"
+        parts << "eval_gemfile(File.expand_path(\"../#{@gemfile_name}\", __dir__))"
       else
         parts.unshift('source "https://rubygems.org"')
       end

test/setup_bundler_test.rb

@@ -290,6 +290,31 @@ def test_returns_bundle_app_config_if_there_is_local_config
     FileUtils.rm_r(File.join(Dir.pwd, ".bundle")) unless ENV["CI"]
   end
 
+  def test_custom_bundle_uses_alternative_gemfiles
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        File.write(File.join(dir, "gems.rb"), <<~GEMFILE)
+          source "https://rubygems.org"
+          gem "rdoc"
+        GEMFILE
+
+        Bundler.with_unbundled_env do
+          capture_subprocess_io do
+            system("bundle install")
+            run_script
+          end
+        end
+
+        assert_path_exists(".ruby-lsp")
+        assert_path_exists(".ruby-lsp/gems.rb")
+        assert_path_exists(".ruby-lsp/gems.locked")
+        assert_match("debug", File.read(".ruby-lsp/gems.rb"))
+        assert_match("ruby-lsp", File.read(".ruby-lsp/gems.rb"))
+        assert_match("eval_gemfile(File.expand_path(\"../gems.rb\", __dir__))", File.read(".ruby-lsp/gems.rb"))
+      end
+    end
+  end
+
   private
 
   # This method runs the script and then immediately unloads it. This allows us to make assertions against the effects