Class: RuboCop::AST::UntilNode

Inherits:

Node

• Object
• Parser::AST::Node
• Node
• RuboCop::AST::UntilNode

Includes:

ConditionalNode, ModifierNode

Defined in:

lib/rubocop/ast/node/until_node.rb

Overview

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

Constant Summary

Constants inherited from Node

Node::ARGUMENT_TYPES, 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::LOOP_TYPES, Node::MUTABLE_LITERALS, Node::OPERATOR_KEYWORDS, Node::POST_CONDITION_LOOP_TYPES, Node::REFERENCES, Node::SHORTHAND_ASSIGNMENTS, Node::SPECIAL_KEYWORDS, Node::TRUTHY_LITERALS, Node::VARIABLES

Instance Method Summary

• #do? ⇒ Boolean

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

• #inverse_keyword ⇒ String

  Returns the inverse keyword of the ‘until` node as a string.

• #keyword ⇒ String

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

Methods included from ModifierNode

#modifier_form?

Methods included from ConditionalNode

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

Methods inherited from Node

#ancestors, #argument?, #argument_type?, #assignment?, #assignment_or_similar?, #basic_conditional?, #basic_literal?, #boolean_type?, #call_type?, #chained?, #class_constructor?, #class_definition?, #complete!, #complete?, #conditional?, #const_name, #defined_module, #defined_module_name, #each_ancestor, #empty_source?, #equals_asgn?, #falsey_literal?, #first_line, #global_const?, #guard_clause?, #immutable_literal?, #initialize, #keyword?, #lambda?, #lambda_or_proc?, #last_line, #left_sibling, #left_siblings, #line_count, #literal?, #loop_keyword?, #match_guard_clause?, #module_definition?, #multiline?, #mutable_literal?, #nonempty_line_count, #numeric_type?, #operator_keyword?, #parent, #parent?, #parent_module_name, #parenthesized_call?, #post_condition_loop?, #proc?, #pure?, #range_type?, #receiver, #recursive_basic_literal?, #recursive_literal?, #reference?, #right_sibling, #right_siblings, #root?, #send_type?, #shorthand_asgn?, #sibling_index, #single_line?, #source, #source_length, #source_range, #special_keyword?, #str_content, #struct_constructor?, #truthy_literal?, #type?, #updated, #value_used?, #variable?

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

Methods included from Descendence

#child_nodes, #descendants, #each_child_node, #each_descendant, #each_node

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

# File 'lib/rubocop/ast/node/until_node.rb', line 30

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

#inverse_keyword ⇒ String

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

Returns:

• (String) —

  the inverse keyword of the ‘until` statement

# File 'lib/rubocop/ast/node/until_node.rb', line 23

def inverse_keyword
  'while'
end

#keyword ⇒ String

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

Returns:

• (String) —

  the keyword of the ‘until` statement

# File 'lib/rubocop/ast/node/until_node.rb', line 15

def keyword
  'until'
end