Class: RubyLsp::Rake::Hover

Inherits:
Object
  • Object
show all
Includes:
Requests::Support::Common
Defined in:
lib/ruby_lsp/ruby_lsp_rake/hover.rb

Instance Method Summary collapse

Constructor Details

#initialize(response_builder, node_context, dispatcher, index) ⇒ Hover

: (ResponseBuilders::Hover response_builder, NodeContext node_context, Prism::Dispatcher dispatcher, RubyIndexer::Index index) -> void



11
12
13
14
15
16
 
# File 'lib/ruby_lsp/ruby_lsp_rake/hover.rb', line 11

def initialize(response_builder, node_context, dispatcher, index)
  @response_builder = response_builder
  @node_context = node_context
  dispatcher.register(self, :on_string_node_enter, :on_symbol_node_enter)
  @index = index
end

Instance Method Details

#handle_prerequisite(node) ⇒ Object

: ((Prism::StringNode | Prism::SymbolNode) node) -> void



29
30
31
32
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/ruby_lsp/ruby_lsp_rake/hover.rb', line 29

def handle_prerequisite(node) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
  call_node_name = @node_context.call_node&.name
  return unless call_node_name == :task

  name = case node
         when Prism::StringNode
           node.content
         when Prism::SymbolNode
           node.value
         end

  arg = @node_context.call_node&.arguments&.arguments&.first
  case arg
  when Prism::KeywordHashNode
    kh = arg.child_nodes.first
    case kh
    when Prism::AssocNode
      v = kh.value
      case v
      when Prism::StringNode
        return unless name == v.content
      when Prism::SymbolNode
        return unless name == v.value
      when Prism::ArrayNode
        return unless v.elements.find do |n|
          name == case n # rubocop:disable Metrics/BlockNesting
                  when Prism::StringNode
                    n.content
                  when Prism::SymbolNode
                    n.value
                  end
        end
      end
    end
  else
    return
  end

  task_name = "task:#{name}"
  return unless @index.indexed? task_name

  # refer to: https://github.com/Shopify/ruby-lsp/blob/896617a0c5f7a22ebe12912a481bf1b59db14c12/lib/ruby_lsp/requests/support/common.rb#L83
  content = +""
  entries = @index[task_name]
  links = entries&.map do |entry|
    loc = entry.location
    uri = URI::Generic.from_path(
      path: entry.file_path,
      fragment: "L#{loc.start_line},#{loc.start_column + 1}-#{loc.end_line},#{loc.end_column + 1}"
    )
    content << "\n\n#{entry.comments}" unless entry.comments.empty?
    "[#{entry.file_name}](#{uri})"
  end
  @response_builder.push("```\nrake #{name}\n```", category: :title)
  @response_builder.push("Definitions: #{links&.join(" | ")}", category: :links)
  @response_builder.push(content, category: :documentation)
end

#on_string_node_enter(node) ⇒ Object

: (Prism::StringNode node) -> void



19
20
21
 
# File 'lib/ruby_lsp/ruby_lsp_rake/hover.rb', line 19

def on_string_node_enter(node)
  handle_prerequisite(node)
end

#on_symbol_node_enter(node) ⇒ Object

: (Prism::SymbolNode node) -> void



24
25
26
 
# File 'lib/ruby_lsp/ruby_lsp_rake/hover.rb', line 24

def on_symbol_node_enter(node)
  handle_prerequisite(node)
end