Class: RuboCop::AST::ForNode
- 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
-
#body ⇒ Node?
Returns the body of the ‘for` loop.
-
#collection ⇒ Node
Returns the collection the ‘for` loop is iterating over.
-
#do? ⇒ Boolean
Checks whether the ‘for` node has a `do` keyword.
-
#keyword ⇒ String
Returns the keyword of the ‘for` statement as a string.
-
#node_parts ⇒ Array<Node>
Custom destructuring method.
-
#variable ⇒ Node
Returns the iteration variable of the ‘for` loop.
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?, #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 Sexp
Constructor Details
This class inherits a constructor from RuboCop::AST::Node
Instance Method Details
#body ⇒ Node?
Returns the body of the ‘for` loop.
40 41 42 |
# File 'lib/rubocop/ast/node/for_node.rb', line 40 def body node_parts[2] end |
#collection ⇒ Node
Returns the collection the ‘for` loop is iterating over.
33 34 35 |
# File 'lib/rubocop/ast/node/for_node.rb', line 33 def collection node_parts[1] end |
#do? ⇒ Boolean
Checks 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.
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.
48 49 50 |
# File 'lib/rubocop/ast/node/for_node.rb', line 48 def node_parts [*self] end |
#variable ⇒ Node
Returns the iteration variable of the ‘for` loop.
26 27 28 |
# File 'lib/rubocop/ast/node/for_node.rb', line 26 def variable node_parts[0] end |