Module: RuboCop::Cop::HelperFunctions Private

Includes:
RangeHelp
Included in:
Cask::HomepageUrlStyling, Cask::UninstallMethodsOrder, DescHelper, FormulaCop, RuboCop::Cop::Homebrew::ExecShellMetacharacters, RuboCop::Cop::Homebrew::ShellCommands, HomepageHelper, NoAutobumpHelper, OnSystemConditionalsHelper, UrlHelper
Defined in:
rubocops/shared/helper_functions.rb,
rubocops/shared/helper_functions.rbi

This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.

Instance Method Summary collapse

Instance Method Details

#block_method_called_in_block?(node, method_name) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Check if a block method is called inside a block.

Parameters:

Returns:

  • (Boolean) 


378
379
380
381
382
383
384
385
386
387
 
# File 'rubocops/shared/helper_functions.rb', line 378

def block_method_called_in_block?(node, method_name)
  node.body.each_child_node do |call_node|
    next if !call_node.block_type? && !call_node.send_type?
    next if call_node.method_name != method_name

    @offensive_node = call_node
    return true
  end
  false
end

#check_precedence(first_nodes, next_nodes) ⇒ Array<(RuboCop::AST::Node, RuboCop::AST::Node)>?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Checks for precedence; returns the first pair of precedence-violating nodes.

Parameters:

Returns:



423
424
425
426
427
428
429
430
 
# File 'rubocops/shared/helper_functions.rb', line 423

def check_precedence(first_nodes, next_nodes)
  next_nodes.each do |each_next_node|
    first_nodes.each do |each_first_node|
      return [each_first_node, each_next_node] if component_precedes?(each_first_node, each_next_node)
    end
  end
  nil
end

#class_name(node) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns the class node's name, or nil if not a class node.

Parameters:

Returns:



486
487
488
489
 
# File 'rubocops/shared/helper_functions.rb', line 486

def class_name(node)
  @offensive_node = node
  node.const_name
end

#component_precedes?(first_node, next_node) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

If first node does not precede next_node, sets appropriate instance variables for reporting.

Parameters:

Returns:

  • (Boolean) 


434
435
436
437
438
439
 
# File 'rubocops/shared/helper_functions.rb', line 434

def component_precedes?(first_node, next_node)
  return false if line_number(first_node) < line_number(next_node)

  @offensive_node = first_node
  true
end

#end_column(node) ⇒ Integer

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns the ending position of the node in source code.

Parameters:

Returns:



480
481
482
 
# File 'rubocops/shared/helper_functions.rb', line 480

def end_column(node)
  node.source_range.end_pos
end

#expression_negated?(node) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Check if negation is present in the given node.

Parameters:

Returns:

  • (Boolean) 


443
444
445
446
447
448
 
# File 'rubocops/shared/helper_functions.rb', line 443

def expression_negated?(node)
  return false unless node.parent&.send_type?
  return false unless node.parent.method_name.equal?(:!)

  !!offending_node(node.parent)
end

#find_all_blocks(node, block_name, &_block) ⇒ Array<RuboCop::AST::BlockNode>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns an array of block nodes of any depth below node in AST. If a block is given then yields matching block node to the block!

Parameters:

Returns:



341
342
343
344
345
346
347
348
349
350
351
 
# File 'rubocops/shared/helper_functions.rb', line 341

def find_all_blocks(node, block_name, &_block)
  return [] if node.nil?

  blocks = node.each_descendant(:block).select { |block_node| block_name == block_node.method_name }
  return blocks unless block_given?

  blocks.each do |block_node|
    offending_node(block_node)
    yield block_node
  end
end

#find_block(node, block_name) ⇒ RuboCop::AST::BlockNode?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns a block named block_name inside node.

Parameters:

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'rubocops/shared/helper_functions.rb', line 308

def find_block(node, block_name)
  return if node.nil?

  node.each_child_node(:block) do |block_node|
    next if block_node.method_name != block_name

    @offensive_node = block_node
    return block_node
  end
  # If not found then, parent node becomes the offensive node
  @offensive_node = node.parent
  nil
end

#find_blocks(node, block_name) ⇒ Array<RuboCop::AST::BlockNode>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns an array of block nodes named block_name inside node.

Parameters:

Returns:



326
327
328
329
330
 
# File 'rubocops/shared/helper_functions.rb', line 326

def find_blocks(node, block_name)
  return [] if node.nil?

  node.each_child_node(:block).select { |block_node| block_name == block_node.method_name }
end

#find_const(node, const_name, &_block) ⇒ T.anything

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Find CONSTANTs in the source. If block given, yield matching nodes.

Parameters:

Returns:

  • (T.anything) 


285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'rubocops/shared/helper_functions.rb', line 285

def find_const(node, const_name, &_block)
  return if node.nil?

  node.each_descendant(:const) do |const_node|
    next if const_node.const_name != const_name

    @offensive_node = const_node
    yield const_node if block_given?
    return true
  end
  nil
end

#find_every_func_call_by_name(node, func_name = nil) ⇒ Array<RuboCop::AST::BlockNode, RuboCop::AST::SendNode>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns array of function call nodes matching func_name in every descendant of node.

  • matches function call: foo(*args, **kwargs)
  • does not match method calls: foo.bar(*args, **kwargs)
  • returns every function call if no func_name is passed

Parameters:

Returns:



182
183
184
185
186
187
188
 
# File 'rubocops/shared/helper_functions.rb', line 182

def find_every_func_call_by_name(node, func_name = nil)
  return [] if node.nil?

  node.each_descendant(:send).select do |func_node|
    func_node.receiver.nil? && (func_name.nil? || func_name == func_node.method_name)
  end
end

#find_every_method_call_by_name(node, method_name = nil) ⇒ Array<RuboCop::AST::SendNode>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns an array of method call nodes matching method_name in every descendant of node. Returns every method call if no method_name is passed.

Parameters:

Returns:

  • (Array<RuboCop::AST::SendNode>) 


164
165
166
167
168
169
170
171
 
# File 'rubocops/shared/helper_functions.rb', line 164

def find_every_method_call_by_name(node, method_name = nil)
  return [] if node.nil?

  node.each_descendant(:send).select do |method_node|
    method_name.nil? ||
      method_name == method_node.method_name
  end
end

#find_instance_call(node, name, &_block) ⇒ T.anything

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Matches receiver part of method. Yields to a block with parent node of receiver.

Example

Match ARGV.<whatever>().

find_instance_call(node, "ARGV")

Parameters:

Returns:

  • (T.anything) 


263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'rubocops/shared/helper_functions.rb', line 263

def find_instance_call(node, name, &_block)
  node.each_descendant(:send) do |method_node|
    next if method_node.receiver.nil?
    next if method_node.receiver.const_name != name &&
            !(method_node.receiver.send_type? && method_node.receiver.method_name == name)

    @offensive_node = method_node.receiver
    return true unless block_given?

    yield method_node
  end
end

#find_instance_method_call(node, instance, method_name, &_block) ⇒ T.anything

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Matches a method with a receiver. Yields to a block with matching method node.

Examples

Match Formula.factory(name).

find_instance_method_call(node, "Formula", :factory)

Match build.head?.

find_instance_method_call(node, :build, :head?)

Parameters:

Returns:

  • (T.anything) 


233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'rubocops/shared/helper_functions.rb', line 233

def find_instance_method_call(node, instance, method_name, &_block)
  methods = find_every_method_call_by_name(node, method_name)
  methods.each do |method|
    next if method.receiver.nil?
    next if method.receiver.const_name != instance &&
            !(method.receiver.send_type? && method.receiver.method_name == instance)

    @offensive_node = method
    return true unless block_given?

    yield method
  end
end

#find_method_calls_by_name(node, method_name) ⇒ Array<RuboCop::AST::SendNode>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns an array of method call nodes matching method_name inside node with depth first order (child nodes).

Parameters:

Returns:

  • (Array<RuboCop::AST::SendNode>) 


147
148
149
150
151
152
153
154
155
156
 
# File 'rubocops/shared/helper_functions.rb', line 147

def find_method_calls_by_name(node, method_name)
  return [] if node.nil?

  nodes = node.each_child_node(:send).select { |method_node| method_name == method_node.method_name }

  # The top level node can be a method
  nodes << node if node.is_a?(RuboCop::AST::SendNode) && node.method_name == method_name

  nodes
end

#find_method_def(node, method_name = nil) ⇒ RuboCop::AST::Node?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns a method definition node with method_name. Returns first method def if method_name is nil.

Parameters:

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'rubocops/shared/helper_functions.rb', line 359

def find_method_def(node, method_name = nil)
  return if node.nil?

  node.each_child_node(:def) do |def_node|
    def_method_name = method_name(def_node)
    next if method_name != def_method_name && method_name.present?

    @offensive_node = def_node
    return def_node
  end
  return if node.parent.nil?

  # If not found then, parent node becomes the offensive node
  @offensive_node = node.parent
  nil
end

#find_method_with_args(node, method_name, *args, &_block) ⇒ Array<RuboCop::AST::SendNode>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Given a method_name and arguments, yields to a block with matching method passed as a parameter to the block.

Parameters:

Returns:

  • (Array<RuboCop::AST::SendNode>) 


200
201
202
203
204
205
206
207
208
 
# File 'rubocops/shared/helper_functions.rb', line 200

def find_method_with_args(node, method_name, *args, &_block)
  methods = find_every_method_call_by_name(node, method_name)
  methods.each do |method|
    next unless parameters_passed?(method, args)
    return [] unless block_given?

    yield method
  end
end

#find_node_method_by_name(node, method_name) ⇒ RuboCop::AST::Node?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns method_node matching method_name.

Parameters:

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'rubocops/shared/helper_functions.rb', line 121

def find_node_method_by_name(node, method_name)
  return if node.nil?

  node.each_child_node(:send) do |method_node|
    next if method_node.method_name != method_name

    @offensive_node = method_node
    return method_node
  end
  # If not found then, parent node becomes the offensive node
  @offensive_node = node.parent
  nil
end

#find_strings(node) ⇒ Array<RuboCop::AST::Node>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns all string nodes among the descendants of given node.

Parameters:

Returns:



112
113
114
115
116
117
 
# File 'rubocops/shared/helper_functions.rb', line 112

def find_strings(node)
  return [] if node.nil?
  return [node] if node.str_type?

  node.each_descendant(:str).to_a
end

#format_component(component_node) ⇒ Symbol?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns printable component name.

Parameters:

Returns:



499
500
501
502
503
504
505
 
# File 'rubocops/shared/helper_functions.rb', line 499

def format_component(component_node)
  if component_node.is_a?(RuboCop::AST::SendNode) || component_node.is_a?(RuboCop::AST::BlockNode)
    component_node.method_name
  elsif component_node.def_type?
    method_name(component_node)
  end
end

#line_number(node) ⇒ Integer

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns the line number of the node.

Parameters:

Returns:



60
61
62
 
# File 'rubocops/shared/helper_functions.rb', line 60

def line_number(node)
  node.loc.line
end

#line_start_column(node) ⇒ Integer

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns the begin position of the node's line in source code.

Parameters:

Returns:



48
49
50
 
# File 'rubocops/shared/helper_functions.rb', line 48

def line_start_column(node)
  node.source_range.source_buffer.line_range(node.loc.line).begin_pos
end

#method_called?(node, method_name) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Check if method_name is called among the direct children nodes in the given node. Check if the node itself is the method.

Parameters:

Returns:

  • (Boolean) 


392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'rubocops/shared/helper_functions.rb', line 392

def method_called?(node, method_name)
  if node.is_a?(RuboCop::AST::SendNode) && node.method_name == method_name
    offending_node(node)
    return true
  end
  node.each_child_node(:send) do |call_node|
    next if call_node.method_name != method_name

    offending_node(call_node)
    return true
  end
  false
end

#method_called_ever?(node, method_name) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Check if method_name is called among every descendant node of given node.

Parameters:

Returns:

  • (Boolean) 


408
409
410
411
412
413
414
415
416
 
# File 'rubocops/shared/helper_functions.rb', line 408

def method_called_ever?(node, method_name)
  node.each_descendant(:send) do |call_node|
    next if call_node.method_name != method_name

    @offensive_node = call_node
    return true
  end
  false
end

#method_name(node) ⇒ Symbol?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns the method name for a def node.

Parameters:

Returns:



493
494
495
 
# File 'rubocops/shared/helper_functions.rb', line 493

def method_name(node)
  node.children[0] if node.def_type?
end

#node_equals?(node, var) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

To compare node with appropriate Ruby variable.

Parameters:

Returns:

  • (Boolean) 


300
301
302
 
# File 'rubocops/shared/helper_functions.rb', line 300

def node_equals?(node, var)
  node == Parser::CurrentRuby.parse(var.inspect)
end

#offending_node(node = nil) ⇒ RuboCop::AST::Node?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Gets/sets the given node as the offending node when required in custom cops.

Parameters:

Returns:



137
138
139
140
141
 
# File 'rubocops/shared/helper_functions.rb', line 137

def offending_node(node = nil)
  return @offensive_node if node.nil?

  @offensive_node = node
end

#parameters(method_node) ⇒ Array<RuboCop::AST::Node>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns the array of arguments of the method_node.

Parameters:

Returns:



452
453
454
455
456
457
458
 
# File 'rubocops/shared/helper_functions.rb', line 452

def parameters(method_node)
  if method_node.is_a?(RuboCop::AST::SendNode) || method_node.is_a?(RuboCop::AST::BlockNode)
    method_node.arguments
  else
    []
  end
end

#parameters_passed?(method_node, params) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns true if the given parameters are present in method call and sets the method call as the offending node. Params can be string, symbol, array, hash, matching regex.

Parameters:

Returns:

  • (Boolean) 


464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'rubocops/shared/helper_functions.rb', line 464

def parameters_passed?(method_node, params)
  method_params = parameters(method_node)
  @offensive_node = method_node
  params.all? do |given_param|
    method_params.any? do |method_param|
      if given_param.instance_of?(Regexp)
        regex_match_group(method_param, given_param)
      else
        node_equals?(method_param, given_param)
      end
    end
  end
end

#problem(msg, &block) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • msg (String)
  • block (T.proc.params(corrector: RuboCop::Cop::Corrector).void, nil) 


106
107
108
 
# File 'rubocops/shared/helper_functions.rb', line 106

def problem(msg, &block)
  add_offense(@offensive_node, message: msg, &block)
end

#regex_match_group(node, pattern) ⇒ MatchData?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Checks for regex match of pattern in the node and sets the appropriate instance variables to report the match.

Parameters:

Returns:

  • (MatchData, nil) 


20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'rubocops/shared/helper_functions.rb', line 20

def regex_match_group(node, pattern)
  string_repr = string_content(node).encode("UTF-8", invalid: :replace)
  match_object = string_repr.match(pattern)
  return unless match_object

  node_begin_pos = start_column(node)
  line_begin_pos = line_start_column(node)
  @column = T.let(
    if node_begin_pos == line_begin_pos
      node_begin_pos + match_object.begin(0) - line_begin_pos
    else
      node_begin_pos + match_object.begin(0) - line_begin_pos + 1
    end,
    T.nilable(Integer),
  )
  @length = T.let(match_object.to_s.length, T.nilable(Integer))
  @line_no = T.let(line_number(node), T.nilable(Integer))
  @source_buf = T.let(source_buffer(node), T.nilable(Parser::Source::Buffer))
  @offensive_node = T.let(node, T.nilable(RuboCop::AST::Node))
  @offensive_source_range = T.let(
    source_range(@source_buf, @line_no, @column, @length),
    T.nilable(Parser::Source::Range),
  )
  match_object
end

#source_buffer(node) ⇒ Parser::Source::Buffer

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Source buffer is required as an argument to report style violations.

Parameters:

Returns:



66
67
68
 
# File 'rubocops/shared/helper_functions.rb', line 66

def source_buffer(node)
  node.source_range.source_buffer
end

#start_column(node) ⇒ Integer

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns the begin position of the node in source code.

Parameters:

Returns:



54
55
56
 
# File 'rubocops/shared/helper_functions.rb', line 54

def start_column(node)
  node.source_range.begin_pos
end

#string_content(node, strip_dynamic: false) ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns the string representation if node is of type str(plain) or dstr(interpolated) or const.

Parameters:

Returns:



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
101
102
103
 
# File 'rubocops/shared/helper_functions.rb', line 72

def string_content(node, strip_dynamic: false)
  case node.type
  when :str
    node.str_content
  when :dstr
    content = ""
    node.each_child_node(:str, :begin) do |child|
      content += if child.begin_type?
        strip_dynamic ? "" : child.source
      else
        child.str_content
      end
    end
    content
  when :send
    send_node = T.cast(node, RuboCop::AST::SendNode)
    if send_node.method?(:+) && (send_node.receiver.str_type? || send_node.receiver.dstr_type?)
      content = string_content(node.receiver)
      arg = send_node.arguments.first
      content += string_content(arg) if arg
      content
    else
      ""
    end
  when :const
    node.const_name
  when :sym
    node.children.first.to_s
  else
    ""
  end
end