Turn custom bundler setup script into a class

Author: vinistock

exe/ruby-lsp

@@ -6,6 +6,7 @@
 # the application's bundle
 if ENV["BUNDLE_GEMFILE"].nil? && File.exist?("Gemfile.lock")
   require_relative "../lib/ruby_lsp/setup_bundler"
+  RubyLsp::SetupBundler.new(Dir.pwd).setup!
 
   # In some cases, like when the `ruby-lsp` is already a part of the bundle, we don't generate `.ruby-lsp/Gemfile`.
   # However, we still want to run the server with `bundle exec`. We need to make sure we're pointing to the right

lib/ruby_lsp/setup_bundler.rb

@@ -3,84 +3,131 @@
 
 require "bundler"
 require "fileutils"
-require "pathname"
 
 # This file is a script that will configure a custom bundle for the Ruby LSP. The custom bundle allows developers to use
 # the Ruby LSP without including the gem in their application's Gemfile while at the same time giving us access to the
 # exact locked versions of dependencies.
 
-# Do not setup a custom bundle if we're working on the Ruby LSP, since it's already included by default
-if Pathname.new(Dir.pwd).basename == "ruby-lsp"
-  warn("Ruby LSP> Skipping custom bundle setup since we're working on the Ruby LSP itself")
-  return
+module RubyLsp
+  class SetupBundler
+    extend T::Sig
+
+    sig { params(project_path: String).void }
+    def initialize(project_path)
+      @project_path = project_path
+      @dependencies = T.let(load_dependencies, T::Hash[String, T.untyped])
+    end
+
+    sig { void }
+    def setup!
+      # Do not setup a custom bundle if we're working on the Ruby LSP, since it's already included by default
+      if File.basename(@project_path) == "ruby-lsp"
+        warn("Ruby LSP> Skipping custom bundle setup since we're working on the Ruby LSP itself")
+        run_bundle_install
+        return
+      end
+
+      # Do not setup a custom bundle if both `ruby-lsp` and `debug` are already in the Gemfile
+      if @dependencies["ruby-lsp"] && @dependencies["debug"]
+        warn("Ruby LSP> Skipping custom bundle setup since both `ruby-lsp` and `debug` are already in the Gemfile")
+        run_bundle_install
+        return
+      end
+
+      # Automatically create and ignore the .ruby-lsp folder for users
+      FileUtils.mkdir(".ruby-lsp") unless Dir.exist?(".ruby-lsp")
+      File.write(".ruby-lsp/.gitignore", "*") unless File.exist?(".ruby-lsp/.gitignore")
+
+      # Write the custom `.ruby-lsp/Gemfile` if it doesn't exist or if the content doesn't match
+      content = custom_gemfile_content
+
+      unless File.exist?(".ruby-lsp/Gemfile") && File.read(".ruby-lsp/Gemfile") == content
+        File.write(".ruby-lsp/Gemfile", content)
+      end
+
+      # If .ruby-lsp/Gemfile.lock already exists and the top level Gemfile.lock hasn't been modified since it was last
+      # updated, then we're ready to boot the server
+      if File.exist?(".ruby-lsp/Gemfile.lock") &&
+          File.stat(".ruby-lsp/Gemfile.lock").mtime > File.stat("Gemfile.lock").mtime
+        warn("Ruby LSP> Skipping custom bundle setup since .ruby-lsp/Gemfile.lock already exists and is up to date")
+        run_bundle_install(".ruby-lsp/Gemfile")
+        return
+      end
+
+      FileUtils.cp("Gemfile.lock", ".ruby-lsp/Gemfile.lock")
+      run_bundle_install(".ruby-lsp/Gemfile")
+    end
+
+    private
+
+    sig { returns(String) }
+    def custom_gemfile_content
+      parts = [
+        "# This custom gemfile is automatically generated by the Ruby LSP.",
+        "# It should be automatically git ignored, but in any case: do not commit it to your repository.",
+        "",
+        "eval_gemfile(File.expand_path(\"../Gemfile\", __dir__))",
+      ]
+
+      unless @dependencies["ruby-lsp"]
+        parts << 'gem "ruby-lsp", require: false, group: :development, source: "https://rubygems.org"'
+      end
+
+      unless @dependencies["debug"]
+        parts << 'gem "debug", require: false, group: :development, platforms: :mri, source: "https://rubygems.org"'
+      end
+
+      parts.join("\n")
+    end
+
+    sig { returns(T::Hash[String, T.untyped]) }
+    def load_dependencies
+      # We need to parse the Gemfile.lock manually here. If we try to do `bundler/setup` to use something more
+      # convenient, we may end up with issues when the globally installed `ruby-lsp` version mismatches the one included
+      # in the `Gemfile`
+      dependencies = Bundler::LockfileParser.new(Bundler.read_file("Gemfile.lock")).dependencies
+
+      # When working on a gem, the `ruby-lsp` might be listed as a dependency in the gemspec. We need to make sure we
+      # check those as well or else we may get version mismatch errors
+      gemspec_path = Dir.glob("*.gemspec").first
+      if gemspec_path
+        gemspec_dependencies = Bundler.load_gemspec(gemspec_path).dependencies.to_h { |dep| [dep.name, dep] }
+        dependencies.merge!(gemspec_dependencies)
+      end
+
+      dependencies
+    end
+
+    sig { params(bundle_gemfile: T.untyped).void }
+    def run_bundle_install(bundle_gemfile = nil)
+      # If the user has a custom bundle path configured, we need to ensure that we will use the absolute and not
+      # relative version of it when running `bundle install`. This is necessary to avoid installing the gems under the
+      # `.ruby-lsp` folder, which is not the user's intention. For example, if the path is configured as `vendor`, we
+      # want to install it in the top level `vendor` and not `.ruby-lsp/vendor`
+      path = Bundler.settings["path"]
+
+      command = +""
+      # Use the absolute `BUNDLE_PATH` to prevent accidentally creating unwanted folders under `.ruby-lsp`
+      command << "BUNDLE_PATH=#{File.expand_path(path, Dir.pwd)} " if path
+      command << "BUNDLE_GEMFILE=#{bundle_gemfile} " if bundle_gemfile
+
+      if @dependencies["ruby-lsp"] && @dependencies["debug"]
+        # Install gems using the custom bundle
+        command << "bundle install "
+      else
+        # If ruby-lsp or debug are not in the Gemfile, try to update them to the latest version
+        command << "bundle update "
+        command << "ruby-lsp " unless @dependencies["ruby-lsp"]
+        command << "debug " unless @dependencies["debug"]
+      end
+
+      # Redirect stdout to stderr to prevent going into an infinite loop. The extension might confuse stdout output with
+      # responses
+      command << "1>&2"
+
+      # Add bundle update
+      warn("Ruby LSP> Running bundle install for the custom bundle. This may take a while...")
+      system(command)
+    end
+  end
 end
-
-# We need to parse the Gemfile.lock manually here. If we try to do `bundler/setup` to use something more convenient, we
-# may end up with issues when the globally installed `ruby-lsp` version mismatches the one included in the `Gemfile`
-dependencies = Bundler::LockfileParser.new(Bundler.read_file("Gemfile.lock")).dependencies
-
-# When working on a gem, the `ruby-lsp` might be listed as a dependency in the gemspec. We need to make sure we check
-# those as well or else we may get version mismatch errors
-gemspec_path = Dir.glob("*.gemspec").first
-if gemspec_path
-  gemspec_dependencies = Bundler.load_gemspec(gemspec_path).dependencies.to_h { |dep| [dep.name, dep] }
-  dependencies.merge!(gemspec_dependencies)
-end
-
-# Do not setup a custom bundle if both `ruby-lsp` and `debug` are already in the Gemfile
-if dependencies["ruby-lsp"] && dependencies["debug"]
-  warn("Ruby LSP> Skipping custom bundle setup since both `ruby-lsp` and `debug` are already in the Gemfile")
-  return
-end
-
-# Automatically create and ignore the .ruby-lsp folder for users
-FileUtils.mkdir(".ruby-lsp") unless Dir.exist?(".ruby-lsp")
-File.write(".ruby-lsp/.gitignore", "*") unless File.exist?(".ruby-lsp/.gitignore")
-
-parts = [
-  "# This custom gemfile is automatically generated by the Ruby LSP.",
-  "# It should be automatically git ignored, but in any case: do not commit it to your repository.",
-  "",
-  "eval_gemfile(File.expand_path(\"../Gemfile\", __dir__))",
-]
-
-unless dependencies["ruby-lsp"]
-  parts << 'gem "ruby-lsp", require: false, group: :development, source: "https://rubygems.org"'
-end
-
-unless dependencies["debug"]
-  parts << 'gem "debug", require: false, group: :development, platforms: :mri, source: "https://rubygems.org"'
-end
-
-gemfile_content = parts.join("\n")
-
-unless File.exist?(".ruby-lsp/Gemfile") && File.read(".ruby-lsp/Gemfile") == gemfile_content
-  File.write(".ruby-lsp/Gemfile", gemfile_content)
-end
-
-# If .ruby-lsp/Gemfile.lock already exists and the top level Gemfile.lock hasn't been modified since it was last
-# updated, then we're ready to boot the server
-if File.exist?(".ruby-lsp/Gemfile.lock") && File.stat(".ruby-lsp/Gemfile.lock").mtime > File.stat("Gemfile.lock").mtime
-  warn("Ruby LSP> Skipping custom bundle setup since .ruby-lsp/Gemfile.lock already exists and is up to date")
-  return
-end
-
-FileUtils.cp("Gemfile.lock", ".ruby-lsp/Gemfile.lock")
-
-# If the user has a custom bundle path configured, we need to ensure that we will use the absolute and not relative
-# version of it when running bundle install. This is necessary to avoid installing the gems under the `.ruby-lsp`
-# folder, which is not the user's intention. For example, if path is configured as `vendor`, we want to install it in
-# the top level `vendor` and not `.ruby-lsp/vendor`
-path = Bundler.settings["path"]
-
-command = +""
-# Use the absolute `BUNDLE_PATH` to prevent accidentally creating unwanted folders under `.ruby-lsp`
-command << "BUNDLE_PATH=#{File.expand_path(path, Dir.pwd)} " if path
-# Install gems using the custom bundle
-command << "BUNDLE_GEMFILE=.ruby-lsp/Gemfile bundle install "
-# Redirect stdout to stderr to prevent going into an infinite loop. The extension might confuse stdout output with
-# responses
-command << "1>&2"
-
-warn("Ruby LSP> Running bundle install for the custom bundle. This may take a while...")
-system(command)

test/setup_bundler_test.rb

@@ -2,21 +2,24 @@
 # frozen_string_literal: true
 
 require "test_helper"
+require "ruby_lsp/setup_bundler"
 
 class SetupBundlerTest < Minitest::Test
   def test_does_nothing_when_running_in_the_ruby_lsp
-    run_script
+    Object.any_instance.expects(:system).with(bundle_install_command(update: false))
+    run_script("/some/path/ruby-lsp")
     refute_path_exists(".ruby-lsp")
   end
 
   def test_does_nothing_if_both_ruby_lsp_and_debug_are_in_the_bundle
+    Object.any_instance.expects(:system).with(bundle_install_command(update: false))
     Bundler::LockfileParser.any_instance.expects(:dependencies).returns({ "ruby-lsp" => true, "debug" => true })
     run_script
     refute_path_exists(".ruby-lsp")
   end
 
   def test_creates_custom_bundle
-    Object.any_instance.expects(:system).with(bundle_install_command)
+    Object.any_instance.expects(:system).with(bundle_install_command(".ruby-lsp/Gemfile"))
     Bundler::LockfileParser.any_instance.expects(:dependencies).returns({})
     run_script
 
@@ -30,7 +33,7 @@ def test_creates_custom_bundle
   end
 
   def test_copies_gemfile_lock_when_modified
-    Object.any_instance.expects(:system).with(bundle_install_command)
+    Object.any_instance.expects(:system).with(bundle_install_command(".ruby-lsp/Gemfile"))
     Bundler::LockfileParser.any_instance.expects(:dependencies).returns({})
     FileUtils.mkdir(".ruby-lsp")
     FileUtils.touch(".ruby-lsp/Gemfile.lock")
@@ -45,9 +48,20 @@ def test_copies_gemfile_lock_when_modified
     FileUtils.rm_r(".ruby-lsp")
   end
 
+  def test_does_not_copy_gemfile_lock_when_not_modified
+    Object.any_instance.expects(:system).with(bundle_install_command(".ruby-lsp/Gemfile"))
+    Bundler::LockfileParser.any_instance.expects(:dependencies).returns({})
+    FileUtils.mkdir(".ruby-lsp")
+    FileUtils.cp("Gemfile.lock", ".ruby-lsp/Gemfile.lock")
+
+    run_script
+  ensure
+    FileUtils.rm_r(".ruby-lsp")
+  end
+
   def test_uses_absolute_bundle_path_for_bundle_install
     Bundler.settings.set_global("path", "vendor/bundle")
-    Object.any_instance.expects(:system).with(bundle_install_command)
+    Object.any_instance.expects(:system).with(bundle_install_command(".ruby-lsp/Gemfile"))
     Bundler::LockfileParser.any_instance.expects(:dependencies).returns({})
     run_script
   ensure
@@ -60,19 +74,21 @@ def test_uses_absolute_bundle_path_for_bundle_install
 
   # This method runs the script and then immediately unloads it. This allows us to make assertions against the effects
   # of running the script multiple times
-  def run_script
-    path = File.expand_path("../lib/ruby_lsp/setup_bundler.rb", __dir__)
-    require path
-  ensure
-    $LOADED_FEATURES.delete(path)
+  def run_script(path = "/fake/project/path")
+    RubyLsp::SetupBundler.new(path).setup!
   end
 
-  def bundle_install_command
+  def bundle_install_command(bundle_gemfile = nil, update: true)
     path = Bundler.settings["path"]
 
     command = +""
     command << "BUNDLE_PATH=#{File.expand_path(path, Dir.pwd)} " if path
-    command << "BUNDLE_GEMFILE=.ruby-lsp/Gemfile bundle install "
+    command << "BUNDLE_GEMFILE=#{bundle_gemfile} " if bundle_gemfile
+    command << if update
+      "bundle update ruby-lsp debug "
+    else
+      "bundle install "
+    end
     command << "1>&2"
   end
 end