Support AS::TestCase document symbol

Author: st0012

lib/ruby_lsp/ruby_lsp_rails/addon.rb

@@ -6,6 +6,7 @@
 require_relative "runner_client"
 require_relative "hover"
 require_relative "code_lens"
+require_relative "document_symbol"
 
 module RubyLsp
   module Rails
@@ -49,6 +50,16 @@ def create_hover_listener(response_builder, nesting, index, dispatcher)
         Hover.new(client, response_builder, nesting, index, dispatcher)
       end
 
+      sig do
+        override.params(
+          response_builder: ResponseBuilders::DocumentSymbol,
+          dispatcher: Prism::Dispatcher,
+        ).returns(Object)
+      end
+      def create_document_symbol_listener(response_builder, dispatcher)
+        DocumentSymbol.new(response_builder, dispatcher)
+      end
+
       sig { override.returns(String) }
       def name
         "Ruby LSP Rails"

lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb

@@ -0,0 +1,61 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Rails
+    # ![Document Symbol demo](../../document_symbol.gif)
+    #
+    # The [document symbol](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_documentSymbol)
+    # request allows users to navigate between ActiveSupport test cases with VS Code's "Go to Symbol" feature.
+    class DocumentSymbol
+      extend T::Sig
+      include Requests::Support::Common
+
+      sig do
+        params(
+          response_builder: ResponseBuilders::DocumentSymbol,
+          dispatcher: Prism::Dispatcher,
+        ).void
+      end
+      def initialize(response_builder, dispatcher)
+        @_response = T.let(nil, NilClass)
+        @response_builder = response_builder
+
+        dispatcher.register(self, :on_call_node_enter)
+      end
+
+      sig { params(node: Prism::CallNode).void }
+      def on_call_node_enter(node)
+        message_value = node.message
+        return unless message_value == "test" || message_value == "it"
+
+        return unless node.arguments
+
+        arguments = node.arguments&.arguments
+        return unless arguments&.any?
+
+        first_argument = arguments.first
+
+        content = case first_argument
+        when Prism::InterpolatedStringNode
+          parts = first_argument.parts
+
+          if parts.all? { |part| part.is_a?(Prism::StringNode) }
+            T.cast(parts, T::Array[Prism::StringNode]).map(&:content).join
+          end
+        when Prism::StringNode
+          first_argument.content
+        end
+
+        return unless content && !content.empty?
+
+        @response_builder.last.children << RubyLsp::Interface::DocumentSymbol.new(
+          name: content,
+          kind: LanguageServer::Protocol::Constant::SymbolKind::METHOD,
+          selection_range: range_from_node(node),
+          range: range_from_node(node),
+        )
+      end
+    end
+  end
+end