Module: RuboCop::AST::MethodDispatchNode

Extended by:
NodePattern::Macros
Includes:
MethodIdentifierPredicates
Included in:
BreakNode, DefinedNode, RetryNode, ReturnNode, SendNode, SuperNode, YieldNode
Defined in:
lib/rubocop/ast/node/mixin/method_dispatch_node.rb

Overview

Common functionality for nodes that are a kind of method dispatch: ‘send`, `csend`, `super`, `zsuper`, `yield`, `defined?`

Constant Summary collapse

ARITHMETIC_OPERATORS = 
%i[+ - * / % **].freeze
SPECIAL_MODIFIERS = 
%w[private protected].freeze

Constants included from MethodIdentifierPredicates

RuboCop::AST::MethodIdentifierPredicates::ENUMERATOR_METHODS, RuboCop::AST::MethodIdentifierPredicates::OPERATOR_METHODS

Instance Method Summary collapse

Methods included from NodePattern::Macros

def_node_matcher, def_node_search, node_search, node_search_all, node_search_body, node_search_first

Methods included from MethodIdentifierPredicates

#assignment_method?, #bang_method?, #camel_case_method?, #comparison_method?, #enumerator_method?, #method?, #negation_method?, #operator_method?, #predicate_method?, #prefix_bang?, #prefix_not?

Instance Method Details

#access_modifier? ⇒ Boolean

Checks whether the dispatched method is an access modifier.

Returns:

  • (Boolean) —

    whether the dispatched method is an access modifier



57
58
59
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 57

def access_modifier?
  bare_access_modifier? || non_bare_access_modifier?
end

#arguments ⇒ Array<Node>

An array containing the arguments of the dispatched method.

Returns:

  • (Array<Node>) —

    the arguments of the dispatched method



31
32
33
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 31

def arguments
  node_parts[2..-1]
end

#arithmetic_operation? ⇒ Boolean

Checks whether this node is an arithmetic operation

Returns:

  • (Boolean) —

    whether the dispatched method is an arithmetic operation



168
169
170
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 168

def arithmetic_operation?
  ARITHMETIC_OPERATORS.include?(method_name)
end

#bare_access_modifier? ⇒ Boolean

Checks whether the dispatched method is a bare access modifier that affects all methods defined after the macro.

Returns:

  • (Boolean) —

    whether the dispatched method is a bare access modifier



66
67
68
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 66

def bare_access_modifier?
  macro? && bare_access_modifier_declaration?
end

#binary_operation? ⇒ Bookean

Checks whether this is a binary operation.

Examples:


foo + bar

Returns:

  • (Bookean) —

    whether this method is a binary operation



223
224
225
226
227
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 223

def binary_operation?
  return false unless loc.selector

  operator_method? && loc.expression.begin_pos != loc.selector.begin_pos
end

#block_literal? ⇒ Boolean

Whether this method dispatch has an explicit block.

Returns:

  • (Boolean) —

    whether the dispatched method has a block



160
161
162
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 160

def block_literal?
  parent&.block_type? && eql?(parent.send_node)
end

#block_node ⇒ BlockNode?

The ‘block` node associated with this method dispatch, if any.

Returns:

  • (BlockNode, nil) —

    the ‘block` node associated with this method call or `nil`



39
40
41
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 39

def block_node
  parent if block_literal?
end

#command?(name) ⇒ Boolean

Checks whether the name of the dispatched method 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



93
94
95
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 93

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

#const_receiver? ⇒ Boolean

Checks whether the explicit receiver of this method dispatch is a ‘const` node.

Returns:

  • (Boolean) —

    whether the receiver of this method dispatch is a ‘const` node



145
146
147
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 145

def const_receiver?
  receiver&.const_type?
end

#def_modifier? ⇒ Boolean

Checks if this node is part of a chain of ‘def` modifiers.

Examples:


private def foo; end

Returns:

  • (Boolean) —

    whether the dispatched method is a ‘def` modifier



179
180
181
182
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 179

def def_modifier?
  send_type? &&
    [self, *each_descendant(:send)].any?(&:adjacent_def_modifier?)
end

#dot? ⇒ Boolean

Checks whether the dispatched method 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



112
113
114
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 112

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

#double_colon? ⇒ Boolean

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

Returns:

  • (Boolean) —

    whether the method was called with a connecting dot



120
121
122
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 120

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

#implicit_call? ⇒ Boolean

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

Returns:

  • (Boolean) —

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



153
154
155
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 153

def implicit_call?
  method?(:call) && !loc.selector
end

#lambda? ⇒ Boolean

Checks whether this is a lambda. Some versions of parser parses non-literal lambdas as a method send.

Returns:

  • (Boolean) —

    whether this method is a lambda



188
189
190
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 188

def lambda?
  block_literal? && command?(:lambda)
end

#lambda_literal? ⇒ Boolean

Checks whether this is a lambda literal (stabby lambda.)

Examples:


-> (foo) { bar }

Returns:

  • (Boolean) —

    whether this method is a lambda literal



199
200
201
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 199

def lambda_literal?
  block_literal? && loc.expression && loc.expression.source == '->'
end

#macro? ⇒ Boolean

Note:

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

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

Returns:

  • (Boolean) —

    whether the dispatched method is a macro method



50
51
52
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 50

def macro?
  !receiver && macro_scope?
end

#method_name ⇒ Symbol

The name of the dispatched method as a symbol.

Returns:

  • (Symbol) —

    the name of the dispatched method



24
25
26
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 24

def method_name
  node_parts[1]
end

#non_bare_access_modifier? ⇒ Boolean

Checks whether the dispatched method is a non-bare access modifier that affects only the method it receives.

Returns:

  • (Boolean) —

    whether the dispatched method is a non-bare access modifier



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

def non_bare_access_modifier?
  macro? && non_bare_access_modifier_declaration?
end

#receiver ⇒ Node?

The receiving node of the method dispatch.

Returns:

  • (Node, nil) —

    the receiver of the dispatched method or ‘nil`



17
18
19
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 17

def receiver
  node_parts[0]
end

#safe_navigation? ⇒ Boolean

Checks whether the dispatched method uses a safe navigation operator to connect the receiver and the method name.

Returns:

  • (Boolean) —

    whether the method was called with a connecting dot



128
129
130
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 128

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

#self_receiver? ⇒ Boolean

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

Returns:

  • (Boolean) —

    whether the receiver of this method dispatch is ‘self`



136
137
138
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 136

def self_receiver?
  receiver&.self_type?
end

#setter_method? ⇒ Boolean Also known as: assignment?

Checks whether the dispatched method is a setter method.

Returns:

  • (Boolean) —

    whether the dispatched method is a setter



100
101
102
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 100

def setter_method?
  loc.respond_to?(:operator) && loc.operator
end

#special_modifier? ⇒ Boolean

Checks whether the dispatched method is a bare ‘private` or `protected` access modifier that affects all methods defined after the macro.

Returns:

  • (Boolean) —

    whether the dispatched method is a bare ‘private` or `protected` access modifier



84
85
86
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 84

def special_modifier?
  bare_access_modifier? && SPECIAL_MODIFIERS.include?(source)
end

#unary_operation? ⇒ Boolean

Checks whether this is a unary operation.

Examples:


-foo

Returns:

  • (Boolean) —

    whether this method is a unary operation



210
211
212
213
214
 
# File 'lib/rubocop/ast/node/mixin/method_dispatch_node.rb', line 210

def unary_operation?
  return false unless loc.selector

  operator_method? && loc.expression.begin_pos == loc.selector.begin_pos
end