Prefix framework tags with framework: (#3340)

Author: vinistock

lib/ruby_lsp/listeners/spec_style.rb

@@ -71,7 +71,7 @@ def handle_describe(node)
             description,
             @uri,
             range_from_node(node),
-            tags: [:minitest],
+            framework: :minitest,
           )
           @response_builder.add(test_item)
         else
@@ -103,7 +103,7 @@ def add_to_parent_test_group(description, node)
           description,
           @uri,
           range_from_node(node),
-          tags: [:minitest],
+          framework: :minitest,
         )
         parent_test_group.add(test_item)
       end

lib/ruby_lsp/listeners/test_style.rb

@@ -40,7 +40,7 @@ def resolve_test_commands(items)
               unless children.any? && children.all? { |child| child[:tags].include?("test_group") }
                 aggregated_tests[path][item[:label]] = { tags: tags, examples: [] }
               end
-            elsif tags.include?("minitest") || tags.include?("test_unit")
+            elsif tags.include?("framework:minitest") || tags.include?("framework:test_unit")
               class_name, method_name = item[:id].split("#")
               aggregated_tests[path][class_name][:examples] << method_name
               aggregated_tests[path][class_name][:tags].merge(tags)
@@ -55,7 +55,7 @@ def resolve_test_commands(items)
             # Separate groups into Minitest and Test Unit. You can have both frameworks in the same file, but you cannot
             # have a group belongs to both at the same time
             minitest_groups, test_unit_groups = groups_and_examples.partition do |_, info|
-              info[:tags].include?("minitest")
+              info[:tags].include?("framework:minitest")
             end
 
             if minitest_groups.any?
@@ -141,7 +141,7 @@ def handle_test_unit_groups(file_path, groups_and_examples)
       def initialize(response_builder, global_state, dispatcher, uri)
         super
 
-        @framework_tag = T.let(:minitest, Symbol)
+        @framework = T.let(:minitest, Symbol)
 
         dispatcher.register(
           self,
@@ -156,15 +156,15 @@ def initialize(response_builder, global_state, dispatcher, uri)
       #: (Prism::ClassNode node) -> void
       def on_class_node_enter(node)
         with_test_ancestor_tracking(node) do |name, ancestors|
-          @framework_tag = :test_unit if ancestors.include?("Test::Unit::TestCase")
+          @framework = :test_unit if ancestors.include?("Test::Unit::TestCase")
 
-          if @framework_tag == :test_unit || non_declarative_minitest?(ancestors, name)
+          if @framework == :test_unit || non_declarative_minitest?(ancestors, name)
             @response_builder.add(Requests::Support::TestItem.new(
               name,
               name,
               @uri,
               range_from_node(node),
-              tags: [@framework_tag],
+              framework: @framework,
             ))
           end
         end
@@ -190,7 +190,7 @@ def on_def_node_enter(node)
           name,
           @uri,
           range_from_node(node),
-          tags: [@framework_tag],
+          framework: @framework,
         ))
       end
 

lib/ruby_lsp/requests/support/test_item.rb

@@ -13,14 +13,14 @@ class TestItem
         #: String
         attr_reader :id, :label
 
-        #: (String id, String label, URI::Generic uri, Interface::Range range, Array[Symbol] tags) -> void
-        def initialize(id, label, uri, range, tags: [])
+        #: (String id, String label, URI::Generic uri, Interface::Range range, Symbol framework) -> void
+        def initialize(id, label, uri, range, framework:)
           @id = id
           @label = label
           @uri = uri
           @range = range
-          @tags = tags
-          @children = T.let({}, T::Hash[String, TestItem])
+          @tags = ["framework:#{framework}"] #: Array[String]
+          @children = {} #: Hash[String, TestItem]
         end
 
         #: (TestItem item) -> void
@@ -38,11 +38,6 @@ def children
           @children.values
         end
 
-        #: (Symbol) -> bool
-        def tag?(tag)
-          @tags.include?(tag)
-        end
-
         #: -> Hash[Symbol, untyped]
         def to_hash
           {

test/requests/discover_tests_test.rb

@@ -375,7 +375,7 @@ def on_class_node_enter(node)
                   class_name,
                   @uri,
                   range_from_node(node),
-                  tags: [:custom_addon],
+                  framework: :custom_addon,
                 )
 
                 @response_builder.add(@current_class)
@@ -396,7 +396,7 @@ def on_call_node_enter(node)
                 test_name,
                 @uri,
                 range_from_node(node),
-                tags: [:custom_addon],
+                framework: :custom_addon,
               ))
             end
           end
@@ -418,7 +418,7 @@ def version
 
     def assert_all_items_tagged_with(items, tag)
       items.each do |item|
-        assert_includes(item[:tags], tag)
+        assert_includes(item[:tags], "framework:#{tag}")
         children = item[:children]
         assert_all_items_tagged_with(children, tag) unless children.empty?
       end

test/requests/resolve_test_commands_test.rb

@@ -15,8 +15,8 @@ def setup
 
     def test_allows_building_hierarchy_of_tests
       builder = ResponseBuilders::TestCollection.new
-      test_item = Requests::Support::TestItem.new("my-id", "Test label", @uri, @range)
-      nested_item = Requests::Support::TestItem.new("nested-id", "Nested label", @uri, @range)
+      test_item = Requests::Support::TestItem.new("my-id", "Test label", @uri, @range, framework: :minitest)
+      nested_item = Requests::Support::TestItem.new("nested-id", "Nested label", @uri, @range, framework: :minitest)
 
       builder.add(test_item)
       test_item.add(nested_item)
@@ -30,16 +30,28 @@ def test_allows_building_hierarchy_of_tests
 
     def test_overrides_if_trying_to_add_item_with_same_id
       builder = ResponseBuilders::TestCollection.new
-      test_item = Requests::Support::TestItem.new("my-id", "Test label", @uri, @range)
-      nested_item = Requests::Support::TestItem.new("nested-id", "Nested label", @uri, @range)
+      test_item = Requests::Support::TestItem.new("my-id", "Test label", @uri, @range, framework: :minitest)
+      nested_item = Requests::Support::TestItem.new("nested-id", "Nested label", @uri, @range, framework: :minitest)
 
       builder.add(test_item)
       test_item.add(nested_item)
 
-      builder.add(Requests::Support::TestItem.new("my-id", "Other title, but same ID", @uri, @range))
+      builder.add(Requests::Support::TestItem.new(
+        "my-id",
+        "Other title, but same ID",
+        @uri,
+        @range,
+        framework: :minitest,
+      ))
       assert_equal("Other title, but same ID", T.must(builder["my-id"]).label)
 
-      test_item.add(Requests::Support::TestItem.new("nested-id", "Other title, but same ID", @uri, @range))
+      test_item.add(Requests::Support::TestItem.new(
+        "nested-id",
+        "Other title, but same ID",
+        @uri,
+        @range,
+        framework: :minitest,
+      ))
       assert_equal("Other title, but same ID", T.must(test_item["nested-id"]).label)
     end