Class: RuboCop::AST::CaseNode

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

Overview

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

#branches ⇒ Array<Node, nil>

Returns an array of all the when branches in the ‘case` statement.

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

Returns:

  • (Array<Node, nil>) —

    an array of the bodies of the when branches



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

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

#each_when(&block) ⇒ Object

Deprecated.

Use ‘when_branches.each`



19
20
21
22
23
24
25
 
# File 'lib/rubocop/ast/node/case_node.rb', line 19

def each_when(&block)
  return when_branches.to_enum(__method__) unless block

  when_branches.each(&block)

  self
end

#else? ⇒ Boolean

Checks whether this case statement has an ‘else` branch.

Returns:

  • (Boolean) —

    whether the ‘case` statement has an `else` branch



55
56
57
 
# File 'lib/rubocop/ast/node/case_node.rb', line 55

def else?
  loc.else
end

#else_branch ⇒ Node?

Returns the else branch of the ‘case` statement, if any.

Returns:

  • (Node) —

    the else branch node of the ‘case` statement

  • (nil) —

    if the case statement does not have an else branch.



48
49
50
 
# File 'lib/rubocop/ast/node/case_node.rb', line 48

def else_branch
  node_parts[-1]
end

#keyword ⇒ String

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

Returns:

  • (String) —

    the keyword of the ‘case` statement



14
15
16
 
# File 'lib/rubocop/ast/node/case_node.rb', line 14

def keyword
  'case'
end

#when_branches ⇒ Array<WhenNode>

Returns an array of all the when branches in the ‘case` statement.

Returns:

  • (Array<WhenNode>) —

    an array of ‘when` nodes



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

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