Make Rails app detection based on Rails::Application superclass (#2218)

* Make Rails app detection based on Rails::Application superclass

This change makes the Rails app detection based on the superclass of the
main class being `Rails::Application`. This is a more reliable way to
detect Rails apps than looking for the presence of the `rails` gem in
the Gemfile. Application can require some of the Rails components
without requiring the `rails` gem itself.

co-authored-by: Earlopain <[email protected]>

* Apply earl's suggestion

* Create files instead of stubbing

* Update lib/ruby_lsp/setup_bundler.rb

Co-authored-by: Alexandre Terrasa <[email protected]>

* Use fixture for test

* Update test/setup_bundler_test.rb

Co-authored-by: Vinicius Stock <[email protected]>

---------

Co-authored-by: Earlopain <[email protected]>
Co-authored-by: Andy Waite <[email protected]>
Co-authored-by: Andy Waite <[email protected]>
Co-authored-by: Alexandre Terrasa <[email protected]>
Co-authored-by: Vinicius Stock <[email protected]>

Author: 5 people

lib/ruby_lsp/setup_bundler.rb

@@ -50,6 +50,7 @@ def initialize(project_path, **options)
       @last_updated_path = T.let(@custom_dir + "last_updated", Pathname)
 
       @dependencies = T.let(load_dependencies, T::Hash[String, T.untyped])
+      @rails_app = T.let(rails_app?, T::Boolean)
       @retry = T.let(false, T::Boolean)
     end
 
@@ -62,7 +63,7 @@ def setup!
       # Do not set up a custom bundle if LSP dependencies are already in the Gemfile
       if @dependencies["ruby-lsp"] &&
           @dependencies["debug"] &&
-          (@dependencies["rails"] ? @dependencies["ruby-lsp-rails"] : true)
+          (@rails_app ? @dependencies["ruby-lsp-rails"] : true)
         $stderr.puts(
           "Ruby LSP> Skipping custom bundle setup since LSP dependencies are already in #{@gemfile}",
         )
@@ -148,7 +149,7 @@ def write_custom_gemfile
         parts << 'gem "debug", require: false, group: :development, platforms: :mri'
       end
 
-      if @dependencies["rails"] && !@dependencies["ruby-lsp-rails"]
+      if @rails_app && !@dependencies["ruby-lsp-rails"]
         parts << 'gem "ruby-lsp-rails", require: false, group: :development'
       end
 
@@ -209,7 +210,7 @@ def run_bundle_install(bundle_gemfile = @gemfile)
         command << " && bundle update "
         command << "ruby-lsp " unless @dependencies["ruby-lsp"]
         command << "debug " unless @dependencies["debug"]
-        command << "ruby-lsp-rails " if @dependencies["rails"] && !@dependencies["ruby-lsp-rails"]
+        command << "ruby-lsp-rails " if @rails_app && !@dependencies["ruby-lsp-rails"]
         command << "--pre" if @experimental
         command.delete_suffix!(" ")
         command << ")"
@@ -244,7 +245,7 @@ def run_bundle_install(bundle_gemfile = @gemfile)
     def should_bundle_update?
       # If `ruby-lsp`, `ruby-lsp-rails` and `debug` are in the Gemfile, then we shouldn't try to upgrade them or else it
       # will produce version control changes
-      if @dependencies["rails"]
+      if @rails_app
         return false if @dependencies.values_at("ruby-lsp", "ruby-lsp-rails", "debug").all?
 
         # If the custom lockfile doesn't include `ruby-lsp`, `ruby-lsp-rails` or `debug`, we need to run bundle install
@@ -280,5 +281,15 @@ def correct_relative_remote_paths
 
       @custom_lockfile.write(content)
     end
+
+    # Detects if the project is a Rails app by looking if the superclass of the main class is `Rails::Application`
+    sig { returns(T::Boolean) }
+    def rails_app?
+      config = Pathname.new("config/application.rb").expand_path
+      application_contents = config.read if config.exist?
+      return false unless application_contents
+
+      /class .* < (::)?Rails::Application/.match?(application_contents)
+    end
   end
 end

test/fixtures/rails_application.rb

@@ -0,0 +1,4 @@
+module MyApp
+  class Application < Rails::Application
+  end
+end

test/setup_bundler_test.rb

@@ -79,6 +79,9 @@ def test_creates_custom_bundle_for_a_rails_app
       bundle_env(".ruby-lsp/Gemfile"),
       "(bundle check || bundle install) 1>&2",
     ).returns(true)
+
+    FileUtils.mkdir("config")
+    FileUtils.cp("test/fixtures/rails_application.rb", "config/application.rb")
     Bundler::LockfileParser.any_instance.expects(:dependencies).returns({ "rails" => true }).at_least_once
     run_script
 
@@ -91,6 +94,7 @@ def test_creates_custom_bundle_for_a_rails_app
     assert_match("ruby-lsp-rails", File.read(".ruby-lsp/Gemfile"))
   ensure
     FileUtils.rm_r(".ruby-lsp") if Dir.exist?(".ruby-lsp")
+    FileUtils.rm_r("config") if Dir.exist?("config")
   end
 
   def test_changing_lockfile_causes_custom_bundle_to_be_rebuilt
@@ -480,6 +484,8 @@ def test_ensures_lockfile_remotes_are_relative_to_default_gemfile
 
   def test_ruby_lsp_rails_is_automatically_included_in_rails_apps
     Dir.mktmpdir do |dir|
+      FileUtils.mkdir("#{dir}/config")
+      FileUtils.cp("test/fixtures/rails_application.rb", "#{dir}/config/application.rb")
       Dir.chdir(dir) do
         File.write(File.join(dir, "Gemfile"), <<~GEMFILE)
           source "https://rubygems.org"