Class: RubyLsp::Ree::DefinitionHandler

Inherits:
Object
  • Object
show all
Includes:
Requests::Support::Common, ReeLocaleUtils, ReeLspUtils
Defined in:
lib/ruby_lsp/ruby_lsp_ree/handlers/definition_handler.rb

Constant Summary

Constants included from ReeLspUtils

ReeLspUtils::Entry

Instance Method Summary collapse

Methods included from ReeLocaleUtils

#find_locale_key_location, #find_locale_value, #package_locales_folder_path

Methods included from ReeLspUtils

#camelize, #find_local_file_path, #get_range_for_fn_insert, #get_ree_type, #get_uri_path, #package_name_from_spec_uri, #package_name_from_uri, #package_path_from_uri, #parameter_name, #path_from_package_folder, #signature_params_from_node, #spec_relative_file_path_from_uri, #underscore

Constructor Details

#initialize(index, uri, node_context) ⇒ DefinitionHandler

Returns a new instance of DefinitionHandler.



16
17
18
19
20
21
22
23
 
# File 'lib/ruby_lsp/ruby_lsp_ree/handlers/definition_handler.rb', line 16

def initialize(index, uri, node_context)
  @index = index
  @uri = uri
  @node_context = node_context
  @root_node = @node_context.instance_variable_get(:@nesting_nodes).first
  @finder = ReeObjectFinder.new(@index)
  @ree_context = RubyLsp::Ree::ReeContext.new(node_context)
end

Instance Method Details

#get_constant_definition_items(node) ⇒ Object 



25
26
27
28
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
 
# File 'lib/ruby_lsp/ruby_lsp_ree/handlers/definition_handler.rb', line 25

def get_constant_definition_items(node)
  result = []

  link_nodes = if @ree_context.is_link_object?
    # inside link node
    link_node = RubyLsp::Ree::ParsedLinkNodeBuilder.build_from_node(@node_context.parent, nil)
    [link_node]
  else
    parsed_doc = if @node_context.parent.is_a?(Prism::CallNode)
      RubyLsp::Ree::ParsedDocumentBuilder.build_from_uri(@uri)
    else
      RubyLsp::Ree::ParsedDocumentBuilder.build_from_ast(@node_context.parent, @uri)
    end

    parsed_doc.link_nodes
  end

  link_nodes.each do |link_node|
    if link_node.imports.include?(node.name.to_s)
      uri = ''
      if link_node.file_path_type?
        path = find_local_file_path(link_node.name)  
        next unless path

        uri = File.join(Dir.pwd, path)
      elsif link_node.import_link_type?
        class_candidates = @finder.find_classes(node.name.to_s)
        next unless class_candidates

        class_candidates = class_candidates.flatten
        package_name = link_node.link_package_name || package_name_from_uri(@uri)
        class_candidate = class_candidates.detect{ package_name_from_uri(_1.uri) == package_name }
        next unless class_candidate

        uri = class_candidate.uri.to_s
      else
        package_name = link_node.link_package_name || package_name_from_uri(@uri)

        method_candidates = @index[link_node.name]
        next if !method_candidates || method_candidates.size == 0
  
        method = method_candidates.detect{ package_name_from_uri(_1.uri) == package_name }
        next unless method

        uri = method.uri.to_s
      end

      result << Interface::Location.new(
        uri: uri,
        range: Interface::Range.new(
          start: Interface::Position.new(line: 0, character: 0),
          end: Interface::Position.new(line: 0, character: 0),
        ),
      )
    end
  end

  result
end

#get_error_code_definition_items(node) ⇒ Object 



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/ruby_lsp/ruby_lsp_ree/handlers/definition_handler.rb', line 209

def get_error_code_definition_items(node)
  locales_folder = package_locales_folder_path(@uri.path)
  return [] unless File.directory?(locales_folder)

  result = []

  key_path_entries = if @node_context.parent.arguments.arguments.size > 1
    [@node_context.parent.arguments.arguments[1].unescaped]
  else
    parsed_doc = RubyLsp::Ree::ParsedDocumentBuilder.build_from_ast(@root_node, @uri)
    file_name = File.basename(@uri.path, '.rb')

    mod = underscore(parsed_doc.module_name)
    [
      "#{mod}.errors.#{node.unescaped}",
      "#{mod}.errors.#{file_name}.#{node.unescaped}"
    ]
  end

  Dir.glob(File.join(locales_folder, '**/*.yml')).each do |locale_file|
    values = key_path_entries.map{ [_1, find_locale_value(locale_file, _1)] }
    key_path = values.select{ |val| !val[1].nil? }.last
    next unless key_path
    
    location = find_locale_key_location(locale_file, key_path[0])

    result << Interface::Location.new(
      uri: locale_file,
      range: Interface::Range.new(
        start: Interface::Position.new(line: location.line, character: location.column),
        end: Interface::Position.new(line: location.line, character: location.column),
      ),
    )
  end

  result
end

#get_error_locales_definition_items(node) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/ruby_lsp/ruby_lsp_ree/handlers/definition_handler.rb', line 186

def get_error_locales_definition_items(node)
  locales_folder = package_locales_folder_path(@uri.path)

  return [] unless File.directory?(locales_folder)

  result = []
  key_path = node.unescaped

  Dir.glob(File.join(locales_folder, '**/*.yml')).each do |locale_file|
    location = find_locale_key_location(locale_file, key_path)

    result << Interface::Location.new(
      uri: locale_file,
      range: Interface::Range.new(
        start: Interface::Position.new(line: location.line, character: location.column),
        end: Interface::Position.new(line: location.line, character: location.column),
      ),
    )
  end

  result
end

#get_linked_filepath_definition_items(node) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/ruby_lsp/ruby_lsp_ree/handlers/definition_handler.rb', line 171

def get_linked_filepath_definition_items(node)
  result = []
  local_path = find_local_file_path(node.unescaped)

  return [] unless local_path

  result << Interface::Location.new(
    uri: File.join(Dir.pwd, local_path),
    range: Interface::Range.new(
      start: Interface::Position.new(line: 0, character: 0),
      end: Interface::Position.new(line: 0, character: 0),
    ),
  )
end

#get_linked_object_definition_items(node) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/ruby_lsp/ruby_lsp_ree/handlers/definition_handler.rb', line 114

def get_linked_object_definition_items(node)
  result = []
  parent_node = @node_context.parent

  link_node = RubyLsp::Ree::ParsedLinkNodeBuilder.build_from_node(parent_node, package_name_from_uri(@uri))
  package_name = link_node.link_package_name

  object_name = if link_node.multi_object_link? && node.is_a?(Prism::SymbolNode) && link_node.has_linked_object?(node.unescaped)
    node.unescaped
  else
    link_node.name
  end

  method_candidates = @index[object_name]
  return [] if !method_candidates || method_candidates.size == 0
  
  method = method_candidates.detect{ package_name_from_uri(_1.uri) == package_name }
  return [] unless method

  result << Interface::Location.new(
    uri: method.uri.to_s,
    range: Interface::Range.new(
      start: Interface::Position.new(line: 0, character: 0),
      end: Interface::Position.new(line: 0, character: 0),
    ),
  )

  result
end

#get_package_definition_items(node) ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/ruby_lsp/ruby_lsp_ree/handlers/definition_handler.rb', line 247

def get_package_definition_items(node)
  package_name = node.unescaped

  parent_node = @node_context.parent
  link_node = RubyLsp::Ree::ParsedLinkNodeBuilder.build_from_node(parent_node, package_name_from_uri(@uri))

  object_uri = find_object_uri_for_package(link_node, package_name).to_s
  return [] unless object_uri

  package_path = package_path_from_uri(object_uri.to_s)
  package_main_file_path = File.join(package_path, 'package', "#{package_name}.rb")

  [
    Interface::Location.new(
      uri: package_main_file_path,
      range: Interface::Range.new(
        start: Interface::Position.new(line: 0, character: 0),
        end: Interface::Position.new(line: 0, character: 0),
      ),
    )
  ]
end

#get_ree_objects_definition_items(node) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/ruby_lsp/ruby_lsp_ree/handlers/definition_handler.rb', line 85

def get_ree_objects_definition_items(node)
  message = node.message
  result = []
  
  parsed_doc = RubyLsp::Ree::ParsedDocumentBuilder.build_from_ast(@root_node, @uri)
  link_node = parsed_doc.find_link_by_usage_name(message)

  definition_item = if link_node
    @finder.find_object_for_package(link_node.name, link_node.link_package_name)
  else
    @finder.find_object(message)
  end

  return [] unless definition_item

  definition_uri = definition_item.uri.to_s
  return [] unless definition_uri

  result << Interface::Location.new(
    uri: definition_uri,
    range: Interface::Range.new(
      start: Interface::Position.new(line: 0, character: 0),
      end: Interface::Position.new(line: 0, character: 0),
    ),
  )

  result
end

#get_routes_definition_items(node) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/ruby_lsp/ruby_lsp_ree/handlers/definition_handler.rb', line 144

def get_routes_definition_items(node)
  parsed_doc = RubyLsp::Ree::ParsedDocumentBuilder.build_from_ast(@root_node, @uri, :route)

  return [] unless parsed_doc.includes_routes_dsl?

  parent_node = @node_context.parent

  package_name = if parsed_doc.has_route_option?(:from)
    parsed_doc.route_option_value(:from)
  else
    package_name_from_uri(@uri)
  end 

  ree_object = @finder.find_object_for_package(node.unescaped, package_name)
  return [] unless ree_object

  [
    Interface::Location.new(
      uri: ree_object.uri.to_s,
      range: Interface::Range.new(
        start: Interface::Position.new(line: 0, character: 0),
        end: Interface::Position.new(line: 0, character: 0),
      ),
    )
  ]
end