Class: RuboCop::AST::WhileNode

Inherits:
Node
  • Object
show all
Includes:
ConditionalNode, ModifierNode
Defined in:
lib/rubocop/ast/node/while_node.rb

Overview

A node extension for ‘while` nodes. This will be used in place of a plain node when the builder constructs the AST, making its methods available to all `while` 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 included from ModifierNode

#modifier_form?

Methods included from ConditionalNode

#body, #condition, #multiline_condition?, #single_line_condition?

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

#s

Constructor Details

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

Instance Method Details

#do? ⇒ Boolean

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

Returns:

  • (Boolean) —

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



30
31
32
 
# File 'lib/rubocop/ast/node/while_node.rb', line 30

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

#inverse_keyword ⇒ String

Returns the inverse keyword of the ‘while` node as a string. Returns `until` for `while` nodes and vice versa.

Returns:

  • (String) —

    the inverse keyword of the ‘while` statement



23
24
25
 
# File 'lib/rubocop/ast/node/while_node.rb', line 23

def inverse_keyword
  'until'
end

#keyword ⇒ String

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

Returns:

  • (String) —

    the keyword of the ‘while` statement



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

def keyword
  'while'
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 ‘while` statement



38
39
40
 
# File 'lib/rubocop/ast/node/while_node.rb', line 38

def node_parts
  [*self]
end