Class: RubyLsp::Rails::DocumentSymbol

Inherits:
Object
  • Object
show all
Includes:
Requests::Support::Common, ActiveSupportTestCaseHelper
Defined in:
lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb

Overview

![Document Symbol demo](../../document_symbol.gif)

The [document symbol](microsoft.github.io/language-server-protocol/specification#textDocument_documentSymbol) request allows users to navigate between associations, validations, callbacks and ActiveSupport test cases with VS Code’s “Go to Symbol” feature.

Instance Method Summary collapse

Methods included from ActiveSupportTestCaseHelper

#extract_test_case_name

Constructor Details

#initialize(response_builder, dispatcher) ⇒ DocumentSymbol

: (ResponseBuilders::DocumentSymbol response_builder, Prism::Dispatcher dispatcher) -> void



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb', line 16

def initialize(response_builder, dispatcher)
  @response_builder = response_builder
  @namespace_stack = [] #: Array[String]
  @inside_schema = false #: bool

  dispatcher.register(
    self,
    :on_call_node_enter,
    :on_call_node_leave,
    :on_class_node_enter,
    :on_class_node_leave,
    :on_module_node_enter,
    :on_module_node_leave,
  )
end

Instance Method Details

#on_call_node_enter(node) ⇒ Object

: (Prism::CallNode node) -> void



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb', line 33

def on_call_node_enter(node)
  message = node.message
  return unless message

  @inside_schema = true if node_is_schema_define?(node)

  handle_schema_table(node)

  return if @namespace_stack.empty?

  content = extract_test_case_name(node)

  if content
    append_document_symbol(
      name: content,
      selection_range: range_from_node(node),
      range: range_from_node(node),
    )
  end

  receiver = node.receiver
  return if receiver && !receiver.is_a?(Prism::SelfNode)

  case message
  when *Support::Callbacks::ALL, "validate"
    handle_all_arg_types(node, message)
  when "validates", "validates!", "validates_each", "belongs_to", "has_one", "has_many",
    "has_and_belongs_to_many", "attr_readonly", "scope"
    handle_symbol_and_string_arg_types(node, message)
  when "validates_with"
    handle_class_arg_types(node, message)
  end
end

#on_call_node_leave(node) ⇒ Object

: (Prism::CallNode node) -> void



68
69
70
 
# File 'lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb', line 68

def on_call_node_leave(node)
  @inside_schema = false if node_is_schema_define?(node)
end

#on_class_node_enter(node) ⇒ Object

: (Prism::ClassNode node) -> void



73
74
75
 
# File 'lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb', line 73

def on_class_node_enter(node)
  add_to_namespace_stack(node)
end

#on_class_node_leave(node) ⇒ Object

: (Prism::ClassNode node) -> void



78
79
80
 
# File 'lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb', line 78

def on_class_node_leave(node)
  remove_from_namespace_stack(node)
end

#on_module_node_enter(node) ⇒ Object

: (Prism::ModuleNode node) -> void



83
84
85
 
# File 'lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb', line 83

def on_module_node_enter(node)
  add_to_namespace_stack(node)
end

#on_module_node_leave(node) ⇒ Object

: (Prism::ModuleNode node) -> void



88
89
90
 
# File 'lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb', line 88

def on_module_node_leave(node)
  remove_from_namespace_stack(node)
end