Class: RuboCop::AST::DefNode

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

Overview

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

Constant Summary

Constants included from MethodIdentifierPredicates

MethodIdentifierPredicates::ENUMERATOR_METHODS, MethodIdentifierPredicates::OPERATOR_METHODS

Constants inherited from Node

Node::ASSIGNMENTS, Node::BASIC_CONDITIONALS, Node::BASIC_LITERALS, Node::COMPARISON_OPERATORS, Node::COMPOSITE_LITERALS, Node::CONDITIONALS, Node::EQUALS_ASSIGNMENTS, Node::FALSEY_LITERALS, Node::IMMUTABLE_LITERALS, Node::KEYWORDS, Node::LITERALS, Node::MUTABLE_LITERALS, Node::OPERATOR_KEYWORDS, Node::REFERENCES, Node::SHORTHAND_ASSIGNMENTS, Node::SPECIAL_KEYWORDS, Node::TRUTHY_LITERALS, Node::VARIABLES

Instance Method Summary collapse

Methods included from MethodIdentifierPredicates

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

Methods included from ParameterizedNode

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

Methods inherited from Node

#ancestors, #argument?, #assignment?, #basic_conditional?, #basic_literal?, #boolean_type?, #call_type?, #chained?, #child_nodes, #complete!, #complete?, #conditional?, #const_name, #defined_module, #defined_module_name, #descendants, #each_ancestor, #each_child_node, #each_descendant, #each_node, #empty_source?, #equals_asgn?, #falsey_literal?, #first_line, #guard_clause?, #immutable_literal?, #initialize, #keyword?, #last_line, #line_count, #literal?, #multiline?, #mutable_literal?, #nonempty_line_count, #numeric_type?, #operator_keyword?, #parent, #parent_module_name, #parenthesized_call?, #pure?, #range_type?, #reference?, #shorthand_asgn?, #sibling_index, #single_line?, #source, #source_length, #source_range, #special_keyword?, #truthy_literal?, #updated, #value_used?, #variable?

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 Sexp

#s

Constructor Details

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

Instance Method Details

#argument_forwarding? ⇒ Boolean

Note:

This is written in a way that may support lead arguments which are rumored to be added in a later version of Ruby.

Checks whether this method definition node forwards its arguments as per the feature added in Ruby 2.7.

Returns:

  • (Boolean) —

    whether the ‘def` node uses argument forwarding



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

def argument_forwarding?
  arguments.any?(&:forward_args_type?)
end

#arguments ⇒ Array<Node>

An array containing the arguments of the method definition.

Returns:

  • (Array<Node>) —

    the arguments of the method definition



40
41
42
 
# File 'lib/rubocop/ast/node/def_node.rb', line 40

def arguments
  node_parts[1]
end

#body ⇒ Node

Note:

this can be either a ‘begin` node, if the method body contains multiple expressions, or any other node, if it contains a single expression.

The body of the method definition.

Returns:

  • (Node) —

    the body of the method definition



51
52
53
 
# File 'lib/rubocop/ast/node/def_node.rb', line 51

def body
  node_parts[0]
end

#method_name ⇒ Symbol

The name of the defined method as a symbol.

Returns:

  • (Symbol) —

    the name of the defined method



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

def method_name
  node_parts[2]
end

#node_parts ⇒ Array

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

In this case, the ‘def` node destructures into:

`method_name, arguments, body`

while the ‘defs` node destructures into:

`receiver, method_name, arguments, body`

so we reverse the destructured array to get the optional receiver at the end, where it can be discarded.

Returns:

  • (Array) —

    the different parts of the ‘def` or `defs` node



77
78
79
 
# File 'lib/rubocop/ast/node/def_node.rb', line 77

def node_parts
  to_a.reverse
end

#receiver ⇒ Node?

The receiver of the method definition, if any.

Returns:

  • (Node, nil) —

    the receiver of the method definition, or ‘nil`.



58
59
60
 
# File 'lib/rubocop/ast/node/def_node.rb', line 58

def receiver
  node_parts[3]
end

#void_context? ⇒ Boolean

Checks whether this node body is a void context.

Returns:

  • (Boolean) —

    whether the ‘def` node body is a void context



15
16
17
 
# File 'lib/rubocop/ast/node/def_node.rb', line 15

def void_context?
  method?(:initialize) || assignment_method?
end