Merge pull request #45 from Shopify/vs/find_correct_project_root_when_using_custom_bundle

Find the correct project root when using custom bundle

Author: vinistock

bin/rails

@@ -5,7 +5,6 @@
 # installed from the root of your application.
 
 ENGINE_ROOT = File.expand_path("..", __dir__)
-ENGINE_PATH = File.expand_path("../lib/ruby_lsp_rails/engine", __dir__)
 APP_PATH = File.expand_path("../test/dummy/config/application", __dir__)
 
 # Set up gems listed in the Gemfile.

lib/ruby_lsp/ruby_lsp_rails/rails_client.rb

@@ -22,6 +22,11 @@ class NeedsRestartError < StandardError; end
       sig { void }
       def initialize
         project_root = Pathname.new(ENV["BUNDLE_GEMFILE"]).dirname
+
+        if project_root.basename.to_s == ".ruby-lsp"
+          project_root = project_root.join("../")
+        end
+
         dummy_path = File.join(project_root, "test", "dummy")
         @root = T.let(Dir.exist?(dummy_path) ? dummy_path : project_root.to_s, String)
         app_uri_path = "#{@root}/tmp/app_uri.txt"

test/dummy/db/schema.rb

@@ -1,6 +1,3 @@
-# typed: true
-# frozen_string_literal: true
-
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
@@ -15,10 +12,11 @@
 
 ActiveRecord::Schema[7.0].define(version: 2023_03_30_202955) do
   create_table "users", force: :cascade do |t|
-    t.string("first_name")
-    t.string("last_name")
-    t.integer("age")
-    t.datetime("created_at", null: false)
-    t.datetime("updated_at", null: false)
+    t.string "first_name"
+    t.string "last_name"
+    t.integer "age"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
+
 end

test/lib/rails_client_test.rb

@@ -38,6 +38,21 @@ class RailsClientTest < ActiveSupport::TestCase
       ensure
         File.write(T.must(app_uri_path), "http://localhost:3000")
       end
+
+      test "instantiation finds the right directory when bundle gemfile points to .ruby-lsp" do
+        previous_bundle_gemfile = ENV["BUNDLE_GEMFILE"]
+        project_root = Pathname.new(previous_bundle_gemfile).dirname
+
+        # If the RailsClient singleton was initialized in a different test successfully, then there would be no chance
+        # for this assertion to pass. We need to reset the singleton instance in order to force `initialize` to be
+        # executed again
+        Singleton.send(:__init__, RailsClient)
+
+        ENV["BUNDLE_GEMFILE"] = "#{project_root}/.ruby-lsp/Gemfile"
+        assert_equal("#{project_root}/test/dummy", RailsClient.instance.root)
+      ensure
+        ENV["BUNDLE_GEMFILE"] = previous_bundle_gemfile
+      end
     end
   end
 end