Fix minitest spec code lens load path (#2706)

* Set load path based on test/spec directory Some codebases (particularly those using minitest/spec) have tests in the `spec` directory instead of the `test` directory. This commit adds support for detecting these paths and adjusting the load path accordingly. I opted to not include any directory by default. If the path contains `test` or `spec`, the appropriate directory is added to the load path. If the path doesn't contain either, then it seems unlikely that the `test` directory should be added to the load path. * Use File.fnmatch? to select test directory Co-authored-by: Vinicius Stock <[email protected]> --------- Co-authored-by: Vinicius Stock <[email protected]>
Shopify · Nov 26, 2024 · 30f8547 · 30f8547
1 parent 23d8048
commit 30f8547
Show file tree

Hide file tree

Showing 8 changed files with 212 additions and 170 deletions.
diff --git a/lib/ruby_lsp/listeners/code_lens.rb b/lib/ruby_lsp/listeners/code_lens.rb
@@ -15,7 +15,7 @@ class CodeLens
           "bundle exec ruby"
         rescue Bundler::GemfileNotFound
           "ruby"
-        end + " -Itest ",
+        end,
         String,
       )
       ACCESS_MODIFIERS = T.let([:public, :private, :protected], T::Array[Symbol])
@@ -229,7 +229,11 @@ def add_test_code_lens(node, name:, command:, kind:, id: name)
         ).returns(String)
       end
       def generate_test_command(group_stack: [], spec_name: nil, method_name: nil)
-        command = BASE_COMMAND + T.must(@path)
+        path = T.must(@path)
+        command = BASE_COMMAND
+        command += " -Itest" if File.fnmatch?("**/test/**/*", path, File::FNM_PATHNAME)
+        command += " -Ispec" if File.fnmatch?("**/spec/**/*", path, File::FNM_PATHNAME)
+        command += " #{path}"
 
         case @global_state.test_library
         when "minitest"

diff --git a/project-words b/project-words
@@ -32,6 +32,7 @@ hostedtoolcache
 importmap
 indexables
 ipairs
+Ispec
 Itest
 ivar
 Jaro

diff --git a/test/expectations/code_lens/minitest_nested_classes_and_modules.exp.json b/test/expectations/code_lens/minitest_nested_classes_and_modules.exp.json
diff --git a/test/expectations/code_lens/minitest_spec_tests.exp.json b/test/expectations/code_lens/minitest_spec_tests.exp.json
diff --git a/test/expectations/code_lens/minitest_tests.exp.json b/test/expectations/code_lens/minitest_tests.exp.json
@@ -17,7 +17,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name \"/^Test(#|::)/\"",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name \"/^Test(#|::)/\"",
           {
             "start_line": 0,
             "start_column": 0,
@@ -51,7 +51,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name \"/^Test(#|::)/\"",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name \"/^Test(#|::)/\"",
           {
             "start_line": 0,
             "start_column": 0,
@@ -85,7 +85,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name \"/^Test(#|::)/\"",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name \"/^Test(#|::)/\"",
           {
             "start_line": 0,
             "start_column": 0,
@@ -119,7 +119,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_public",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_public",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_public",
           {
             "start_line": 5,
             "start_column": 2,
@@ -152,7 +152,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_public",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_public",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_public",
           {
             "start_line": 5,
             "start_column": 2,
@@ -185,7 +185,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_public",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_public",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_public",
           {
             "start_line": 5,
             "start_column": 2,
@@ -218,7 +218,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_public_command",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_public_command",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_public_command",
           {
             "start_line": 9,
             "start_column": 9,
@@ -251,7 +251,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_public_command",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_public_command",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_public_command",
           {
             "start_line": 9,
             "start_column": 9,
@@ -284,7 +284,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_public_command",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_public_command",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_public_command",
           {
             "start_line": 9,
             "start_column": 9,
@@ -317,7 +317,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_another_public",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_another_public",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_another_public",
           {
             "start_line": 11,
             "start_column": 9,
@@ -350,7 +350,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_another_public",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_another_public",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_another_public",
           {
             "start_line": 11,
             "start_column": 9,
@@ -383,7 +383,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_another_public",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_another_public",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_another_public",
           {
             "start_line": 11,
             "start_column": 9,
@@ -416,7 +416,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_public_vcall",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_public_vcall",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_public_vcall",
           {
             "start_line": 17,
             "start_column": 2,
@@ -449,7 +449,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_public_vcall",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_public_vcall",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_public_vcall",
           {
             "start_line": 17,
             "start_column": 2,
@@ -482,7 +482,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_public_vcall",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_public_vcall",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_public_vcall",
           {
             "start_line": 17,
             "start_column": 2,
@@ -515,7 +515,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_with_q?",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_with_q\\?",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_with_q\\?",
           {
             "start_line": 19,
             "start_column": 2,
@@ -548,7 +548,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_with_q?",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_with_q\\?",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_with_q\\?",
           {
             "start_line": 19,
             "start_column": 2,
@@ -581,7 +581,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "Test#test_with_q?",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name Test#test_with_q\\?",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name Test#test_with_q\\?",
           {
             "start_line": 19,
             "start_column": 2,
@@ -614,7 +614,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "AnotherTest",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name \"/^AnotherTest(#|::)/\"",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name \"/^AnotherTest(#|::)/\"",
           {
             "start_line": 24,
             "start_column": 0,
@@ -648,7 +648,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "AnotherTest",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name \"/^AnotherTest(#|::)/\"",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name \"/^AnotherTest(#|::)/\"",
           {
             "start_line": 24,
             "start_column": 0,
@@ -682,7 +682,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "AnotherTest",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name \"/^AnotherTest(#|::)/\"",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name \"/^AnotherTest(#|::)/\"",
           {
             "start_line": 24,
             "start_column": 0,
@@ -716,7 +716,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "AnotherTest#test_public",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name AnotherTest#test_public",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name AnotherTest#test_public",
           {
             "start_line": 25,
             "start_column": 2,
@@ -749,7 +749,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "AnotherTest#test_public",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name AnotherTest#test_public",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name AnotherTest#test_public",
           {
             "start_line": 25,
             "start_column": 2,
@@ -782,7 +782,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "AnotherTest#test_public",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name AnotherTest#test_public",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name AnotherTest#test_public",
           {
             "start_line": 25,
             "start_column": 2,
@@ -815,7 +815,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "AnotherTest#test_public_2",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name AnotherTest#test_public_2",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name AnotherTest#test_public_2",
           {
             "start_line": 31,
             "start_column": 2,
@@ -848,7 +848,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "AnotherTest#test_public_2",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name AnotherTest#test_public_2",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name AnotherTest#test_public_2",
           {
             "start_line": 31,
             "start_column": 2,
@@ -881,7 +881,7 @@
         "arguments": [
           "/fixtures/minitest_tests.rb",
           "AnotherTest#test_public_2",
-          "bundle exec ruby -Itest /fixtures/minitest_tests.rb --name AnotherTest#test_public_2",
+          "bundle exec ruby /fixtures/minitest_tests.rb --name AnotherTest#test_public_2",
           {
             "start_line": 31,
             "start_column": 2,