Class: RuboCop::AST::SendNode

Inherits:
Node
  • Object
show all
Includes:
ParameterizedNode
Defined in:
lib/rubocop/ast/node/send_node.rb

Overview

A node extension for ‘send` nodes. This will be used in place of a plain node when the builder constructs the AST, making its methods available to all `send` nodes within RuboCop.

Constant Summary collapse

ENUMERATOR_METHODS = 
%i[collect collect_concat detect downto each
find find_all find_index inject loop map!
map reduce reject reject! reverse_each select
select! times upto].freeze

Constants inherited from Node

Node::BASIC_LITERALS, Node::COMPARISON_OPERATORS, Node::COMPOSITE_LITERALS, Node::FALSEY_LITERALS, Node::IMMUTABLE_LITERALS, Node::KEYWORDS, Node::LITERALS, Node::MUTABLE_LITERALS, Node::OPERATOR_KEYWORDS, Node::REFERENCES, Node::SPECIAL_KEYWORDS, Node::TRUTHY_LITERALS, Node::VARIABLES

Instance Method Summary collapse

Methods included from ParameterizedNode

#arguments?, #block_argument?, #block_literal?, #block_node, #first_argument, #last_argument, #parenthesized?, #splat_argument?

Methods inherited from Node

#ancestors, #argument?, #asgn_method_call?, #basic_literal?, #binary_operation?, #chained?, #child_nodes, #complete!, #complete?, #const_name, def_matcher, #defined_module, #defined_module_name, #descendants, #each_ancestor, #each_child_node, #each_descendant, #each_node, #falsey_literal?, #immutable_literal?, #initialize, #keyword?, #keyword_bang?, #keyword_not?, #literal?, #multiline?, #mutable_literal?, #numeric_type?, #operator_keyword?, #parent, #parent_module_name, #pure?, #reference?, #sibling_index, #single_line?, #source, #source_range, #special_keyword?, #truthy_literal?, #unary_operation?, #updated, #value_used?, #variable?

Methods included from Sexp

#s

Constructor Details

This class inherits a constructor from RuboCop::AST::Node

Instance Method Details

#arguments ⇒ Array<Node>

An array containing the arguments of the method invocation.

Returns:

  • (Array<Node>) —

    the arguments of the method invocation or ‘nil`



33
34
35
 
# File 'lib/rubocop/ast/node/send_node.rb', line 33

def arguments
  node_parts[2..-1]
end

#assignment_method? ⇒ Boolean

Checks whether the invoked method is an assignment method.

Returns:

  • (Boolean) —

    whether the invoked method is an assignment.



89
90
91
 
# File 'lib/rubocop/ast/node/send_node.rb', line 89

def assignment_method?
  !comparison_method? && method_name.to_s.end_with?('=')
end

#bang_method? ⇒ Boolean

Checks whether the invoked method is a bang method.

Returns:

  • (Boolean) —

    whether the invoked method is a bang method



146
147
148
 
# File 'lib/rubocop/ast/node/send_node.rb', line 146

def bang_method?
  method_name.to_s.end_with?('!')
end

#camel_case_method? ⇒ Boolean

Checks whether the invoked method is a camel case method, e.g. ‘Integer()`.

Returns:

  • (Boolean) —

    whether the invoked method is a camel case method



154
155
156
 
# File 'lib/rubocop/ast/node/send_node.rb', line 154

def camel_case_method?
  method_name.to_s =~ /\A[A-Z]/
end

#command?(name) ⇒ Boolean

Checks whether the method name matches the argument and has an implicit receiver.

Parameters:

  • name (Symbol, String) —

    the method name to check for

Returns:

  • (Boolean) —

    whether the method name matches the argument



61
62
63
 
# File 'lib/rubocop/ast/node/send_node.rb', line 61

def command?(name)
  !receiver && method?(name)
end

#comparison_method? ⇒ Boolean

Checks whether the invoked method is a comparison method.

Returns:

  • (Boolean) —

    whether the involed method is a comparison



82
83
84
 
# File 'lib/rubocop/ast/node/send_node.rb', line 82

def comparison_method?
  COMPARISON_OPERATORS.include?(method_name)
end

#dot? ⇒ Boolean

Checks whether the method call uses a dot to connect the receiver and the method name.

This is useful for comparison operators, which can be called either with or without a dot, i.e. ‘foo == bar` or `foo.== bar`.

Returns:

  • (Boolean) —

    whether the method was called with a connecting dot



108
109
110
 
# File 'lib/rubocop/ast/node/send_node.rb', line 108

def dot?
  loc.dot && loc.dot.is?('.')
end

#double_colon? ⇒ Boolean

Checks whether the method call uses a double colon to connect the receiver and the method name.

Returns:

  • (Boolean) —

    whether the method was called with a connecting dot



116
117
118
 
# File 'lib/rubocop/ast/node/send_node.rb', line 116

def double_colon?
  loc.dot && loc.dot.is?('::')
end

#enumerator_method? ⇒ Boolean

Checks whether the invoked method is an enumerator method.

Returns:

  • (Boolean) —

    whether the invoked method is an enumerator.



96
97
98
99
 
# File 'lib/rubocop/ast/node/send_node.rb', line 96

def enumerator_method?
  ENUMERATOR_METHODS.include?(method_name) ||
    method_name.to_s.start_with?('each_')
end

#implicit_call? ⇒ Boolean

Checks whether the method call is of the implicit form of ‘#call`, e.g. `foo.(bar)`.

Returns:

  • (Boolean) —

    whether the method is an implicit form of ‘#call`



132
133
134
 
# File 'lib/rubocop/ast/node/send_node.rb', line 132

def implicit_call?
  method_name == :call && !loc.selector
end

#macro? ⇒ Boolean

Note:

This does not include DSLs that use nested blocks, like RSpec

Checks whether the method is a macro method. A macro method is defined as a method that sits in a class- or module body and has an implicit receiver.

Returns:

  • (Boolean) —

    whether the method is a macro method



52
53
54
 
# File 'lib/rubocop/ast/node/send_node.rb', line 52

def macro?
  !receiver && macro_scope?
end

#method?(name) ⇒ Boolean

Checks whether the method name matches the argument.

Parameters:

  • name (Symbol, String) —

    the method name to check for

Returns:

  • (Boolean) —

    whether the method name matches the argument



41
42
43
 
# File 'lib/rubocop/ast/node/send_node.rb', line 41

def method?(name)
  method_name == name.to_sym
end

#method_name ⇒ Symbol

The name of the invoked method called as a string.

Returns:

  • (Symbol) —

    the name of the invoked method



26
27
28
 
# File 'lib/rubocop/ast/node/send_node.rb', line 26

def method_name
  node_parts[1]
end

#node_parts ⇒ Array

Custom destructuring method. This can be used to normalize destructuring for different variations of the node.

Returns:

  • (Array) —

    the different parts of the ‘send` node



162
163
164
 
# File 'lib/rubocop/ast/node/send_node.rb', line 162

def node_parts
  to_a
end

#operator_method? ⇒ Boolean

Checks whether the invoked method is an operator method.

Returns:

  • (Boolean) —

    whether the invoked method is an operator



75
76
77
 
# File 'lib/rubocop/ast/node/send_node.rb', line 75

def operator_method?
  RuboCop::Cop::Util::OPERATOR_METHODS.include?(method_name)
end

#predicate_method? ⇒ Boolean

Checks whether the invoked method is a predicate method.

Returns:

  • (Boolean) —

    whether the invoked method is a predicate method



139
140
141
 
# File 'lib/rubocop/ast/node/send_node.rb', line 139

def predicate_method?
  method_name.to_s.end_with?('?')
end

#receiver ⇒ Node?

The receiving node of the method invocation.

Returns:

  • (Node, nil) —

    the receiver of the invoked method or ‘nil`



19
20
21
 
# File 'lib/rubocop/ast/node/send_node.rb', line 19

def receiver
  node_parts[0]
end

#self_receiver? ⇒ Boolean

Checks whether the receiver of this method invocation is ‘self`.

Returns:

  • (Boolean) —

    whether the receiver of this method invocation is ‘self`



124
125
126
 
# File 'lib/rubocop/ast/node/send_node.rb', line 124

def self_receiver?
  receiver && receiver.self_type?
end

#setter_method? ⇒ Boolean

Checks whether the invoked method is a setter method.

Returns:

  • (Boolean) —

    whether the invoked method is a setter



68
69
70
 
# File 'lib/rubocop/ast/node/send_node.rb', line 68

def setter_method?
  loc.operator
end