Class: RuboCop::AST::ArrayNode

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

Overview

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

Constant Summary collapse

PERCENT_LITERAL_TYPES = 
{
  string: /^%[wW]/,
  symbol: /^%[iI]/
}.freeze

Constants inherited from Node

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

Instance Method Summary collapse

Methods inherited from Node

#ancestors, #argument?, #assignment?, #basic_conditional?, #basic_literal?, #call_type?, #chained?, #child_nodes, #complete!, #complete?, #conditional?, #const_name, #defined_module, #defined_module_name, #descendants, #each_ancestor, #each_child_node, #each_descendant, #each_node, #empty_source?, #equals_asgn?, #falsey_literal?, #first_line, #immutable_literal?, #initialize, #keyword?, #last_line, #line_count, #literal?, #multiline?, #mutable_literal?, #node_parts, #nonempty_line_count, #numeric_type?, #operator_keyword?, #parent, #parent_module_name, #parenthesized_call?, #pure?, #range_type?, #receiver, #reference?, #shorthand_asgn?, #sibling_index, #single_line?, #source, #source_length, #source_range, #special_keyword?, #truthy_literal?, #updated, #value_used?, #variable?

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from Sexp

#s

Constructor Details

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

Instance Method Details

#bracketed? ⇒ Boolean

Checks whether the ‘array` literal is delimited by either percent or square brackets

brackets

Returns:

  • (Boolean) —

    whether the array is enclosed in percent or square



52
53
54
 
# File 'lib/rubocop/ast/node/array_node.rb', line 52

def bracketed?
  square_brackets? || percent_literal?
end

#percent_literal? ⇒ Boolean #percent_literal?(type) ⇒ Boolean

Checks whether the ‘array` literal is delimited by percent brackets.

Overloads:

  • #percent_literal? ⇒ Boolean

    Check for any percent literal.

  • #percent_literal?(type) ⇒ Boolean

    Check for percent literal of type ‘type`.

    Parameters:

    • type (Symbol) —

      an optional percent literal type

Returns:

  • (Boolean) —

    whether the array is enclosed in percent brackets



39
40
41
42
43
44
45
 
# File 'lib/rubocop/ast/node/array_node.rb', line 39

def percent_literal?(type = nil)
  if type
    loc.begin && loc.begin.source =~ PERCENT_LITERAL_TYPES[type]
  else
    loc.begin&.source&.start_with?('%')
  end
end

#square_brackets? ⇒ Boolean

Checks whether the ‘array` literal is delimited by square brackets.

Returns:

  • (Boolean) —

    whether the array is enclosed in square brackets



24
25
26
 
# File 'lib/rubocop/ast/node/array_node.rb', line 24

def square_brackets?
  loc.begin&.is?('[')
end

#values ⇒ Array<Node>

Returns an array of all value nodes in the ‘array` literal.

Returns:

  • (Array<Node>) —

    an array of value nodes



17
18
19
 
# File 'lib/rubocop/ast/node/array_node.rb', line 17

def values
  each_child_node.to_a
end