Class: RuboCop::AST::RescueNode

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

Overview

A node extension for `rescue` nodes. This will be used in place of a plain node when the builder constructs the AST, making its methods available to all `rescue` 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?, #node_parts, #nonempty_line_count, #numeric_type?, #operator_keyword?, #parent, #parent?, #parent_module_name, #parenthesized_call?, #post_condition_loop?, #proc?, #pure?, #range_type?, #receiver, #reference?, #right_sibling, #right_siblings, #root?, #shorthand_asgn?, #sibling_index, #single_line?, #source, #source_length, #source_range, #special_keyword?, #str_content, #struct_constructor?, #truthy_literal?, #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

#bodyNode?

Returns the body of the rescue node.

Returns:

  • (Node, nil)

    The body of the rescue node.


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

def body
  node_parts[0]
end

#branchesArray<Node, nil>

Returns an array of all the rescue branches in the exception handling statement.

and the else (if any). Note that these bodies could be nil.

Returns:

  • (Array<Node, nil>)

    an array of the bodies of the rescue branches


27
28
29
30
31
# File 'lib/rubocop/ast/node/rescue_node.rb', line 27

def branches
  bodies = resbody_branches.map(&:body)
  bodies.push(else_branch) if else?
  bodies
end

#else?Boolean

Checks whether this exception handling statement has an `else` branch.

Returns:

  • (Boolean)

    whether the exception handling statement has an `else` branch


44
45
46
# File 'lib/rubocop/ast/node/rescue_node.rb', line 44

def else?
  loc.else
end

#else_branchNode?

Returns the else branch of the exception handling statement, if any.

Returns:

  • (Node)

    the else branch node of the exception handling statement

  • (nil)

    if the exception handling statement does not have an else branch.


37
38
39
# File 'lib/rubocop/ast/node/rescue_node.rb', line 37

def else_branch
  node_parts[-1]
end

#resbody_branchesArray<ResbodyNode>

Returns an array of all the rescue branches in the exception handling statement.

Returns:


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

def resbody_branches
  node_parts[1...-1]
end