Module: RubyLsp::Ree::ReeLspUtils

Included in:
CompletionHandler, CompletionItemsMapper, ConstAdditionalTextEditsCreator, DefinitionHandler, HoverHandler, HoverListener, ImportPackagesFormatter, MethodAdditionalTextEditsCreator, MissingErrorDefinitionsFormatter, MissingErrorLocalesFormatter, MissingImportsFormatter, ParsedBaseDocument, ParsedClassDocument, ParsedDaoDocument, ParsedDocumentBuilder, ParsedEntityDocument, ParsedRouteDocument, ParsedRspecDocument, ReeDslParser, ReeFormatter, ReeIndexingEnhancement, ReeObjectFinder, RubyLsp::Ree::ReeObjectFinder::ReeObjectDecorator, ReeRenameHandler, ReeSourceEditor, ReeTemplateApplicator, SyncDaoColumnsFormatter, UnusedLinksFormatter
Defined in:
lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb

Constant Summary collapse

Entry = 
RubyIndexer::Entry

Instance Method Summary collapse

Instance Method Details

#camelize(string, uppercase_first_letter = true) ⇒ Object

copied from ree string_utils



204
205
206
207
208
209
210
211
212
 
# File 'lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb', line 204

def camelize(string, uppercase_first_letter = true)
  if uppercase_first_letter
    string = string.sub(/^[a-z\d]*/) { |match| match.capitalize }
  else
    string = string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { |match| match.downcase }
  end
  
  string.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub("/", "::")
end

#find_local_file_path(file_path) ⇒ Object 



10
11
12
13
 
# File 'lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb', line 10

def find_local_file_path(file_path)
  file_name = file_path + ".rb"
  Dir[File.join('**', file_name)].first
end

#get_range_for_fn_insert(parsed_doc, link_text) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb', line 66

def get_range_for_fn_insert(parsed_doc, link_text)
  fn_line = nil
  position = nil

  if parsed_doc.links_container_node
    links_container_node = parsed_doc.links_container_node
    fn_line = links_container_node.location.start_line

    position = if parsed_doc.links_container_block_node
      parsed_doc.links_container_block_node.opening_loc.end_column + 1
    else
      links_container_node.arguments.location.end_column + 1
    end
  elsif parsed_doc.includes_link_dsl?
    if parsed_doc.link_nodes.size > 0
      fn_line = parsed_doc.link_nodes.last.location.start_line
      position = parsed_doc.link_nodes.last.location.end_column + 1
    else
      fn_line = parsed_doc.class_includes.last.location.start_line
      position = parsed_doc.class_includes.last.location.end_column + 1
    end
  elsif parsed_doc.allows_root_links?
    root_node_location = parsed_doc.root_node_line_location
   
    fn_line = root_node_location.start_line
    position = root_node_location.end_column + 1
  else
    return nil
  end

  Interface::Range.new(
    start: Interface::Position.new(line: fn_line - 1, character: position),
    end: Interface::Position.new(line: fn_line - 1, character: position + link_text.size),
  )
end

#get_ree_type(ree_object) ⇒ Object 



59
60
61
62
63
64
 
# File 'lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb', line 59

def get_ree_type(ree_object)
  type_comment = ree_object.comments.to_s.lines[1]
  return unless type_comment

  type_comment.split(' ').last
end

#get_uri_path(uri) ⇒ Object 



6
7
8
 
# File 'lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb', line 6

def get_uri_path(uri)
  URI.decode_www_form_component(URI.parse(uri.to_s).path)
end

#package_name_from_spec_uri(uri) ⇒ Object 



24
25
26
27
28
29
30
31
 
# File 'lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb', line 24

def package_name_from_spec_uri(uri)
  uri_parts = uri.to_s.split('/')
  
  spec_folder_index = uri_parts.find_index('spec')
  return unless spec_folder_index

  uri_parts[spec_folder_index + 1]
end

#package_name_from_uri(uri) ⇒ Object 



15
16
17
18
19
20
21
22
 
# File 'lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb', line 15

def package_name_from_uri(uri)
  uri_parts = uri.to_s.split('/')
  
  package_folder_index = uri_parts.find_index('package')
  return unless package_folder_index

  uri_parts[package_folder_index + 1]
end

#package_path_from_uri(uri) ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb', line 33

def package_path_from_uri(uri)
  uri_parts = uri.to_s.split('/')
  
  package_folder_index = uri_parts.find_index('package')
  return unless package_folder_index

  uri_parts.take(package_folder_index).join('/')
end

#parameter_name(node) ⇒ Object

params(node: Prism::Node).returns(Symbol) copied from ruby-lsp DeclarationListener#parameter_name



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb', line 168

def parameter_name(node)
  case node
  when Prism::RequiredParameterNode, Prism::OptionalParameterNode,
    Prism::RequiredKeywordParameterNode, Prism::OptionalKeywordParameterNode,
    Prism::RestParameterNode, Prism::KeywordRestParameterNode
    node.name
  when Prism::MultiTargetNode
    names = node.lefts.map { |parameter_node| parameter_name(parameter_node) }

    rest = node.rest
    if rest.is_a?(Prism::SplatNode)
      name = rest.expression&.slice
      names << (rest.operator == "*" ? "*#{name}".to_sym : name&.to_sym)
    end

    names << nil if rest.is_a?(Prism::ImplicitRestNode)

    names.concat(node.rights.map { |parameter_node| parameter_name(parameter_node) })

    names_with_commas = names.join(", ")
    :"(#{names_with_commas})"
  end
end

#path_from_package_folder(uri) ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb', line 42

def path_from_package_folder(uri)
  uri_parts = uri.to_s.chomp(File.extname(uri.to_s)).split('/')

  package_folder_index = uri_parts.index('package')
  return unless package_folder_index

  uri_parts.drop(package_folder_index+1).join('/')
end

#signature_params_from_node(parameters_node) ⇒ Object

params(parameters_node: Prism::ParametersNode).returns(Array) copied from ruby-lsp DeclarationListener#list_params



105
106
107
108
109
110
111
112
113
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb', line 105

def signature_params_from_node(parameters_node)
  return [] unless parameters_node
  
  parameters = []
  
  parameters_node.requireds.each do |required|
    name = parameter_name(required)
    next unless name
  
    parameters << Entry::RequiredParameter.new(name: name)
  end
  
  parameters_node.optionals.each do |optional|
    name = parameter_name(optional)
    next unless name
  
    parameters << Entry::OptionalParameter.new(name: name)
  end
  
  rest = parameters_node.rest
  
  if rest.is_a?(Prism::RestParameterNode)
    rest_name = rest.name || Entry::RestParameter::DEFAULT_NAME
    parameters << Entry::RestParameter.new(name: rest_name)
  end
  
  parameters_node.keywords.each do |keyword|
    name = parameter_name(keyword)
    next unless name
  
    case keyword
    when Prism::RequiredKeywordParameterNode
      parameters << Entry::KeywordParameter.new(name: name)
    when Prism::OptionalKeywordParameterNode
      parameters << Entry::OptionalKeywordParameter.new(name: name)
    end
  end
  
  keyword_rest = parameters_node.keyword_rest
  
  case keyword_rest
  when Prism::KeywordRestParameterNode
    keyword_rest_name = parameter_name(keyword_rest) || Entry::KeywordRestParameter::DEFAULT_NAME
    parameters << Entry::KeywordRestParameter.new(name: keyword_rest_name)
  when Prism::ForwardingParameterNode
    parameters << Entry::ForwardingParameter.new
  end
  
  parameters_node.posts.each do |post|
    name = parameter_name(post)
    next unless name
  
    parameters << Entry::RequiredParameter.new(name: name)
  end
  
  block = parameters_node.block
  parameters << Entry::BlockParameter.new(name: block.name || Entry::BlockParameter::DEFAULT_NAME) if block
  
  parameters
end

#spec_relative_file_path_from_uri(uri) ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb', line 51

def spec_relative_file_path_from_uri(uri)
  uri_parts = uri.path.split('/')
  spec_folder_index = uri_parts.index('spec')
  return unless spec_folder_index

  uri_parts[spec_folder_index+1..-1].join('/').chomp('.rb')
end

#underscore(camel_cased_word) ⇒ Object

copied from ree string_utils



193
194
195
196
197
198
199
200
201
 
# File 'lib/ruby_lsp/ruby_lsp_ree/utils/ree_lsp_utils.rb', line 193

def underscore(camel_cased_word)
  return camel_cased_word unless /[A-Z-]|::/.match?(camel_cased_word)
  word = camel_cased_word.to_s.gsub("::".freeze, "/".freeze)
  word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2'.freeze)
  word.gsub!(/([a-z\d])([A-Z])/, '\1_\2'.freeze)
  word.tr!("-".freeze, "_".freeze)
  word.downcase!
  word
end