Don't add symbol unless in a class/module

Author: natematykiewicz

lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb

@@ -21,8 +21,16 @@ class DocumentSymbol
       end
       def initialize(response_builder, dispatcher)
         @response_builder = response_builder
-
-        dispatcher.register(self, :on_call_node_enter)
+        @namespace_stack = T.let([], T::Array[String])
+
+        dispatcher.register(
+          self,
+          :on_call_node_enter,
+          :on_class_node_enter,
+          :on_class_node_leave,
+          :on_module_node_enter,
+          :on_module_node_leave,
+        )
       end
 
       sig { params(node: Prism::CallNode).void }
@@ -37,6 +45,8 @@ def on_call_node_enter(node)
           )
         end
 
+        return if @namespace_stack.empty?
+
         receiver = node.receiver
         return if receiver && !receiver.is_a?(Prism::SelfNode)
 
@@ -52,8 +62,38 @@ def on_call_node_enter(node)
         end
       end
 
+      sig { params(node: Prism::ClassNode).void }
+      def on_class_node_enter(node)
+        add_to_namespace_stack(node)
+      end
+
+      sig { params(node: Prism::ClassNode).void }
+      def on_class_node_leave(node)
+        remove_from_namespace_stack(node)
+      end
+
+      sig { params(node: Prism::ModuleNode).void }
+      def on_module_node_enter(node)
+        add_to_namespace_stack(node)
+      end
+
+      sig { params(node: Prism::ModuleNode).void }
+      def on_module_node_leave(node)
+        remove_from_namespace_stack(node)
+      end
+
       private
 
+      sig { params(node: T.any(Prism::ClassNode, Prism::ModuleNode)).void }
+      def add_to_namespace_stack(node)
+        @namespace_stack << node.constant_path.slice
+      end
+
+      sig { params(node: T.any(Prism::ClassNode, Prism::ModuleNode)).void }
+      def remove_from_namespace_stack(node)
+        @namespace_stack.delete(node.constant_path.slice)
+      end
+
       sig { params(node: Prism::CallNode, message: String).void }
       def handle_all_arg_types(node, message)
         block = node.block

test/ruby_lsp_rails/document_symbol_test.rb

@@ -168,7 +168,7 @@ class FooModel < ApplicationRecord
         assert_equal("attr_readonly :foo", response[0].children[0].name)
       end
 
-      test "correctly handles scope" do
+      test "correctly handles scope in a class" do
         response = generate_document_symbols_for_source(<<~RUBY)
           class FooModel < ApplicationRecord
             scope :bar, ->{ where(b: 2).order(:c) }
@@ -183,6 +183,37 @@ class FooModel < ApplicationRecord
         assert_equal("scope :foo", response[0].children[1].name)
       end
 
+      test "correctly handles scope in a concern" do
+        response = generate_document_symbols_for_source(<<~RUBY)
+          module Scopable
+            extend ActiveSupport::Concern
+
+            included do
+              scope :bar, ->{ where(b: 2).order(:c) }
+              scope :foo, ->{ where(a: 1).order(:b) }
+            end
+          end
+        RUBY
+
+        assert_equal(1, response.size)
+        assert_equal("Scopable", response[0].name)
+        assert_equal(2, response[0].children.size)
+        assert_equal("scope :bar", response[0].children[0].name)
+        assert_equal("scope :foo", response[0].children[1].name)
+      end
+
+      test "ignores scope in a routes file" do
+        response = generate_document_symbols_for_source(<<~RUBY)
+          Rails.application.routes.draw do
+            scope '/admin' do
+              resources :users
+            end
+          end
+        RUBY
+
+        assert_equal(0, response.size)
+      end
+
       test "correctly handles model callbacks with multiple string arguments" do
         response = generate_document_symbols_for_source(<<~RUBY)
           class FooModel < ApplicationRecord