Use unformatted descriptions as test example labels (#642)

Author: vinistock

lib/ruby_lsp/ruby_lsp_rails/rails_test_style.rb

@@ -67,9 +67,11 @@ def initialize(response_builder, global_state, dispatcher, uri)
       def on_class_node_enter(node)
         with_test_ancestor_tracking(node) do |name, ancestors|
           if declarative_minitest?(ancestors, name)
+            label = constant_name(node.constant_path) || name_with_dynamic_reference(node.constant_path)
+
             test_item = Requests::Support::TestItem.new(
               name,
-              name,
+              label,
               @uri,
               range_from_node(node),
               framework: :rails,
@@ -119,7 +121,7 @@ def on_call_node_enter(node)
         # Rails uses at runtime, ensuring proper test discovery and execution.
         rails_normalized_name = "test_#{test_name.gsub(/\s+/, "_")}"
 
-        add_test_item(node, rails_normalized_name)
+        add_test_item(node, rails_normalized_name, test_name)
       end
 
       #: (Prism::DefNode node) -> void
@@ -129,7 +131,7 @@ def on_def_node_enter(node)
         name = node.name.to_s
         return unless name.start_with?("test_")
 
-        add_test_item(node, name)
+        add_test_item(node, name, name)
       end
 
       private
@@ -145,14 +147,14 @@ def declarative_minitest?(attached_ancestors, fully_qualified_name)
         false
       end
 
-      #: (Prism::Node node, String test_name) -> void
-      def add_test_item(node, test_name)
+      #: (Prism::Node, String, String) -> void
+      def add_test_item(node, test_id, label)
         parent = @parent_stack.last
         return unless parent.is_a?(Requests::Support::TestItem)
 
         example_item = Requests::Support::TestItem.new(
-          "#{parent.id}##{test_name}",
-          test_name,
+          "#{parent.id}##{test_id}",
+          label,
           @uri,
           range_from_node(node),
           framework: :rails,

test/ruby_lsp_rails/rails_test_style_test.rb

@@ -22,12 +22,12 @@ class SampleTest < ActiveSupport::TestCase
         with_active_support_declarative_tests(source) do |items|
           assert_equal(1, items.length)
           test_class = items.first
-          assert_equal("SampleTest", test_class[:label])
+          assert_equal("SampleTest", test_class[:id])
           assert_equal(2, test_class[:children].length)
 
-          test_labels = test_class[:children].map { |i| i[:label] }
-          assert_includes(test_labels, "test_first_test")
-          assert_includes(test_labels, "test_second_test")
+          test_labels = test_class[:children].map { |i| i[:id] }
+          assert_includes(test_labels, "SampleTest#test_first_test")
+          assert_includes(test_labels, "SampleTest#test_second_test")
           assert_all_items_tagged_with(items, :rails)
         end
       end
@@ -48,11 +48,11 @@ class EmptyTest < ActiveSupport::TestCase
         with_active_support_declarative_tests(source) do |items|
           assert_equal(1, items.length)
           test_class = items.first
-          assert_equal("EmptyTest", test_class[:label])
+          assert_equal("EmptyTest", test_class[:id])
           assert_equal(2, test_class[:children].length)
 
-          test_labels = test_class[:children].map { |i| i[:label] }
-          assert_includes(test_labels, "test_<empty_test_name>")
+          test_labels = test_class[:children].map { |i| i[:id] }
+          assert_includes(test_labels, "EmptyTest#test_<empty_test_name>")
           assert_all_items_tagged_with(items, :rails)
         end
       end
@@ -123,12 +123,12 @@ class SpecialCharsTest < ActiveSupport::TestCase
         with_active_support_declarative_tests(source) do |items|
           assert_equal(1, items.length)
           test_class = items.first
-          assert_equal("SpecialCharsTest", test_class[:label])
+          assert_equal("SpecialCharsTest", test_class[:id])
           assert_equal(2, test_class[:children].length)
 
-          test_labels = test_class[:children].map { |i| i[:label] }
-          assert_includes(test_labels, "test_spaces_and_punctuation!")
-          assert_includes(test_labels, "test_unicode:_你好")
+          test_labels = test_class[:children].map { |i| i[:id] }
+          assert_includes(test_labels, "SpecialCharsTest#test_spaces_and_punctuation!")
+          assert_includes(test_labels, "SpecialCharsTest#test_unicode:_你好")
           assert_all_items_tagged_with(items, :rails)
         end
       end
@@ -234,11 +234,11 @@ class SpecialCharsTest < ActiveSupport::TestCase
         with_active_support_declarative_tests(source) do |items|
           assert_equal(1, items.length)
           test_class = items.first
-          assert_equal("SampleTest", test_class[:label])
+          assert_equal("SampleTest", test_class[:id])
           assert_equal(1, test_class[:children].length)
 
           assert_equal(["SampleTest#test_hello_\"oh_noes\""], test_class[:children].map { |i| i[:id] })
-          assert_equal(["test_hello_\"oh_noes\""], test_class[:children].map { |i| i[:label] })
+          assert_equal(["hello \"oh noes\""], test_class[:children].map { |i| i[:label] })
           assert_all_items_tagged_with(items, :rails)
         end
       end
@@ -305,7 +305,7 @@ class AnotherGroupTest < ActiveSupport::TestCase
           assert_equal(["SampleTest"], items.map { |i| i[:id] })
           assert_equal(
             ["SampleTest::InnerTest", "SampleTest::AnotherGroupTest"],
-            items.dig(0, :children).map { |i| i[:label] },
+            items.dig(0, :children).map { |i| i[:id] },
           )
           assert_equal(
             ["SampleTest::InnerTest#test_first"],
@@ -337,6 +337,24 @@ class SampleTest < ActiveSupport::TestCase
         end
       end
 
+      test "labels include only unformatted descriptions" do
+        source = <<~RUBY
+          class SampleTest < ActiveSupport::TestCase
+            class InnerGroup < ActiveSupport::TestCase
+              test "first test" do
+                assert true
+              end
+            end
+          end
+        RUBY
+
+        with_active_support_declarative_tests(source) do |items|
+          assert_equal(["SampleTest"], items.map { |i| i[:label] })
+          assert_equal(["InnerGroup"], items.dig(0, :children).map { |i| i[:label] })
+          assert_equal(["first test"], items.dig(0, :children, 0, :children).map { |i| i[:label] })
+        end
+      end
+
       private
 
       def with_active_support_declarative_tests(source, file: "/fake.rb", &block)