Register all test discovery listener events in one go (#3582)

Author: vinistock

lib/ruby_lsp/listeners/spec_style.rb

@@ -19,21 +19,20 @@ class DescribeGroup < Group; end
 
       #: (ResponseBuilders::TestCollection, GlobalState, Prism::Dispatcher, URI::Generic) -> void
       def initialize(response_builder, global_state, dispatcher, uri)
-        super
+        super(response_builder, global_state, uri)
 
         @spec_group_id_stack = [] #: Array[Group?]
 
-        dispatcher.register(
-          self,
-          # Common handlers registered in parent class
+        register_events(
+          dispatcher,
           :on_class_node_enter,
-          :on_call_node_enter, # e.g. `describe` or `it`
+          :on_call_node_enter,
           :on_call_node_leave,
         )
       end
 
       #: (Prism::ClassNode) -> void
-      def on_class_node_enter(node)
+      def on_class_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         with_test_ancestor_tracking(node) do |name, ancestors|
           @spec_group_id_stack << (ancestors.include?("Minitest::Spec") ? ClassGroup.new(name) : nil)
         end
@@ -58,7 +57,7 @@ def on_module_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerM
       end
 
       #: (Prism::CallNode) -> void
-      def on_call_node_enter(node)
+      def on_call_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         return unless in_spec_context?
 
         case node.name
@@ -70,7 +69,7 @@ def on_call_node_enter(node)
       end
 
       #: (Prism::CallNode) -> void
-      def on_call_node_leave(node)
+      def on_call_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         return unless node.name == :describe && !node.receiver
 
         current_group = @spec_group_id_stack.last

lib/ruby_lsp/listeners/test_discovery.rb

@@ -9,24 +9,17 @@ class TestDiscovery
 
       DYNAMIC_REFERENCE_MARKER = "<dynamic_reference>"
 
-      #: (ResponseBuilders::TestCollection response_builder, GlobalState global_state, Prism::Dispatcher dispatcher, URI::Generic uri) -> void
-      def initialize(response_builder, global_state, dispatcher, uri)
+      #: (ResponseBuilders::TestCollection response_builder, GlobalState global_state, URI::Generic uri) -> void
+      def initialize(response_builder, global_state, uri)
         @response_builder = response_builder
         @uri = uri
         @index = global_state.index #: RubyIndexer::Index
         @visibility_stack = [:public] #: Array[Symbol]
         @nesting = [] #: Array[String]
-
-        dispatcher.register(
-          self,
-          :on_class_node_leave,
-          :on_module_node_enter,
-          :on_module_node_leave,
-        )
       end
 
       #: (Prism::ModuleNode node) -> void
-      def on_module_node_enter(node)
+      def on_module_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         @visibility_stack << :public
 
         name = constant_name(node.constant_path)
@@ -36,19 +29,31 @@ def on_module_node_enter(node)
       end
 
       #: (Prism::ModuleNode node) -> void
-      def on_module_node_leave(node)
+      def on_module_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         @visibility_stack.pop
         @nesting.pop
       end
 
       #: (Prism::ClassNode node) -> void
-      def on_class_node_leave(node)
+      def on_class_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         @visibility_stack.pop
         @nesting.pop
       end
 
       private
 
+      #: (Prism::Dispatcher, *Symbol) -> void
+      def register_events(dispatcher, *events)
+        unique_events = events.dup.push(
+          :on_class_node_leave,
+          :on_module_node_enter,
+          :on_module_node_leave,
+        )
+
+        unique_events.uniq!
+        dispatcher.register(self, *unique_events)
+      end
+
       #: (String? name) -> String
       def calc_fully_qualified_name(name)
         RubyIndexer::Index.actual_nesting(@nesting, name).join("::")

lib/ruby_lsp/listeners/test_style.rb

@@ -153,14 +153,13 @@ def handle_test_unit_groups(file_path, groups_and_examples)
 
       #: (ResponseBuilders::TestCollection, GlobalState, Prism::Dispatcher, URI::Generic) -> void
       def initialize(response_builder, global_state, dispatcher, uri)
-        super
+        super(response_builder, global_state, uri)
 
         @framework = :minitest #: Symbol
         @parent_stack = [@response_builder] #: Array[(Requests::Support::TestItem | ResponseBuilders::TestCollection)?]
 
-        dispatcher.register(
-          self,
-          # Common handlers registered in parent class
+        register_events(
+          dispatcher,
           :on_class_node_enter,
           :on_def_node_enter,
           :on_call_node_enter,
@@ -169,7 +168,7 @@ def initialize(response_builder, global_state, dispatcher, uri)
       end
 
       #: (Prism::ClassNode node) -> void
-      def on_class_node_enter(node)
+      def on_class_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         with_test_ancestor_tracking(node) do |name, ancestors|
           @framework = :test_unit if ancestors.include?("Test::Unit::TestCase")
 
@@ -210,7 +209,7 @@ def on_module_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerM
       end
 
       #: (Prism::DefNode node) -> void
-      def on_def_node_enter(node)
+      def on_def_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         return if @visibility_stack.last != :public
 
         name = node.name.to_s
@@ -232,15 +231,15 @@ def on_def_node_enter(node)
       end
 
       #: (Prism::CallNode node) -> void
-      def on_call_node_enter(node)
+      def on_call_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         name = node.name
         return unless ACCESS_MODIFIERS.include?(name)
 
         @visibility_stack << name
       end
 
       #: (Prism::CallNode node) -> void
-      def on_call_node_leave(node)
+      def on_call_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         name = node.name
         return unless ACCESS_MODIFIERS.include?(name)
         return unless node.arguments&.arguments