Handle US_ASCII encoding when parsing rails application config

Shopify · Aug 20, 2024 · 26bdc81 · 26bdc81
1 parent 88b85b8
commit 26bdc81
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 10 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -29,9 +29,14 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
         ruby: ["3.1", "3.2", "3.3"]
+        rubyopt: [""]
+        include:
+          - os: ubuntu-latest
+            ruby: "3.3"
+            rubyopt: "--encoding US-ASCII"
     runs-on: ${{ matrix.os }}
     timeout-minutes: 30
-    name: Ruby ${{ matrix.ruby }} on ${{ matrix.os }}
+    name: Ruby ${{ matrix.ruby }} on ${{ matrix.os }} ${{ matrix.rubyopt }}
     steps:
       - uses: actions/checkout@v4
         with:
@@ -45,6 +50,8 @@ jobs:
           cache-version: 1
 
       - name: Run tests
+        env:
+          RUBYOPT: ${{ matrix.rubyopt }}
         run: bundle exec rake
 
       - name: Run index troubleshooting tool

diff --git a/lib/ruby_lsp/setup_bundler.rb b/lib/ruby_lsp/setup_bundler.rb
@@ -289,6 +289,7 @@ def rails_app?
       application_contents = config.read if config.exist?
       return false unless application_contents
 
+      application_contents = application_contents.encode(Encoding::UTF_8, Encoding::UTF_8, invalid: :replace)
       /class .* < (::)?Rails::Application/.match?(application_contents)
     end
   end

diff --git a/test/fixtures/rails_application_utf8_comment.rb b/test/fixtures/rails_application_utf8_comment.rb
@@ -0,0 +1,5 @@
+module MyApp
+  class Application < Rails::Application
+    # あ
+  end
+end
diff --git a/test/requests/support/expectations_test_runner.rb b/test/requests/support/expectations_test_runner.rb
@@ -45,15 +45,25 @@ def default_args
         end
 
         if expectation_path && File.file?(expectation_path)
-          class_eval(<<~RB, __FILE__, __LINE__ + 1)
-            def test_#{expectation_suffix}__#{test_name}
-              @_path = "#{path}"
-              source = File.read(@_path)
-              expected = File.read("#{expectation_path}")
-              initialize_params(expected)
-              assert_expectations(source, expected)
-            end
-          RB
+          # We run tests on CI with US_ASCII encoding, which would differ in expectations
+          # for UTF8 characters. Just skip these.
+          if expectation_path.include?("multibyte") && Encoding.default_external == Encoding::UTF_8
+            class_eval(<<~RB, __FILE__, __LINE__ + 1)
+              def test_#{expectation_suffix}__#{test_name}
+                @_path = "#{path}"
+                source = File.read(@_path)
+                expected = File.read("#{expectation_path}")
+                initialize_params(expected)
+                assert_expectations(source, expected)
+              end
+            RB
+          else
+            class_eval(<<~RB, __FILE__, __LINE__ + 1)
+              def test_#{expectation_suffix}__#{test_name}
+                skip "Running with non-utf8 encoding"
+              end
+            RB
+          end
         else
           class_eval(<<~RB, __FILE__, __LINE__ + 1)
             def test_#{expectation_suffix}__#{test_name}__does_not_raise

diff --git a/test/setup_bundler_test.rb b/test/setup_bundler_test.rb
@@ -513,6 +513,37 @@ def test_ruby_lsp_rails_is_automatically_included_in_rails_apps
     end
   end
 
+  def test_ruby_lsp_rails_is_automatically_included_in_rails_apps_utf8
+    Dir.mktmpdir do |dir|
+      FileUtils.mkdir("#{dir}/config")
+      FileUtils.cp("test/fixtures/rails_application_utf8_comment.rb", "#{dir}/config/application.rb")
+      Dir.chdir(dir) do
+        File.write(File.join(dir, "Gemfile"), <<~GEMFILE)
+          source "https://rubygems.org"
+          gem "rails"
+        GEMFILE
+
+        capture_subprocess_io do
+          Bundler.with_unbundled_env do
+            # Run bundle install to generate the lockfile
+            system("bundle install")
+          end
+        end
+
+        Object.any_instance.expects(:system).with(
+          bundle_env(".ruby-lsp/Gemfile"),
+          "(bundle check || bundle install) 1>&2",
+        ).returns(true)
+        Bundler.with_unbundled_env do
+          run_script
+        end
+
+        assert_path_exists(".ruby-lsp/Gemfile")
+        assert_match('gem "ruby-lsp-rails"', File.read(".ruby-lsp/Gemfile"))
+      end
+    end
+  end
+
   def test_recovers_from_stale_lockfiles
     Dir.mktmpdir do |dir|
       custom_dir = File.join(dir, ".ruby-lsp")