Class: RuboCop::AST::KeywordBeginNode

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

Overview

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

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

#body ⇒ Node?

Returns the body of the ‘kwbegin` block. Returns `self` if the `kwbegin` contains multiple nodes.

Returns:

  • (Node, nil) —

    The body of the ‘kwbegin`.



13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/rubocop/ast/node/keyword_begin_node.rb', line 13

def body
  return unless node_parts.any?

  if rescue_node
    rescue_node.body
  elsif ensure_node
    ensure_node.node_parts[0]
  elsif node_parts.one?
    node_parts[0]
  else
    self
  end
end

#ensure_node ⇒ Node?

Returns the ‘rescue` node of the `kwbegin` block, if one is present.

Returns:

  • (Node, nil) —

    The ‘rescue` node within `kwbegin`.



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

def ensure_node
  node_parts[0] if node_parts[0]&.ensure_type?
end

#rescue_node ⇒ Node?

Returns the ‘rescue` node of the `kwbegin` block, if one is present.

Returns:

  • (Node, nil) —

    The ‘rescue` node within `kwbegin`.



37
38
39
40
41
 
# File 'lib/rubocop/ast/node/keyword_begin_node.rb', line 37

def rescue_node
  return ensure_node&.rescue_node if ensure_node&.rescue_node

  node_parts[0] if node_parts[0]&.rescue_type?
end