Class: RuboCop::AST::ForNode

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

Overview

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

Constant Summary

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 inherited from Node

#ancestors, #argument?, #asgn_method_call?, #basic_literal?, #binary_operation?, #chained?, #child_nodes, #complete!, #complete?, #const_name, #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?, #receiver, #reference?, #sibling_index, #single_line?, #source, #source_range, #special_keyword?, #truthy_literal?, #unary_operation?, #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

#body ⇒ Node?

Returns the body of the ‘for` loop.

Returns:

  • (Node, nil) —

    The body of the ‘for` loop.



48
49
50
 
# File 'lib/rubocop/ast/node/for_node.rb', line 48

def body
  node_parts[2]
end

#collection ⇒ Node

Returns the collection the ‘for` loop is iterating over.

Returns:

  • (Node) —

    The collection the ‘for` loop is iterating over



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

def collection
  node_parts[1]
end

#do? ⇒ Boolean

Checks whether the ‘for` node has a `do` keyword.

Returns:

  • (Boolean) —

    whether the ‘for` node has a `do` keyword



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

def do?
  loc.begin && loc.begin.is?('do')
end

#keyword ⇒ String

Returns the keyword of the ‘for` statement as a string.

Returns:

  • (String) —

    the keyword of the ‘until` statement



12
13
14
 
# File 'lib/rubocop/ast/node/for_node.rb', line 12

def keyword
  'for'
end

#node_parts ⇒ Array<Node>

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

Returns:

  • (Array<Node>) —

    the different parts of the ‘until` statement



56
57
58
 
# File 'lib/rubocop/ast/node/for_node.rb', line 56

def node_parts
  to_a
end

#variable ⇒ Node

Returns the iteration variable of the ‘for` loop.

Returns:

  • (Node) —

    The iteration variable of the ‘for` loop



34
35
36
 
# File 'lib/rubocop/ast/node/for_node.rb', line 34

def variable
  node_parts[0]
end

#void_context? ⇒ true

Checks whether this node body is a void context. Always ‘true` for `for`.

Returns:

  • (true) —

    whether the ‘for` node body is a void context



27
28
29
 
# File 'lib/rubocop/ast/node/for_node.rb', line 27

def void_context?
  true
end