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::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?, #basic_conditional?, #basic_literal?, #boolean_type?, #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, #guard_clause?, #immutable_literal?, #initialize, #keyword?, #last_line, #left_sibling, #left_siblings, #line_count, #literal?, #loop_keyword?, #multiline?, #mutable_literal?, #node_parts, #nonempty_line_count, #numeric_type?, #operator_keyword?, #parent, #parent_module_name, #parenthesized_call?, #post_condition_loop?, #pure?, #range_type?, #receiver, #reference?, #right_sibling, #right_siblings, #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

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


59
60
61
# File 'lib/rubocop/ast/node/array_node.rb', line 59

def bracketed?
  square_brackets? || percent_literal?
end

#each_value(&block) ⇒ Object

Deprecated.

Use `values.each` (a.k.a. `children.each`)


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

def each_value(&block)
  return to_enum(__method__) unless block_given?

  values.each(&block)

  self
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


46
47
48
49
50
51
52
# File 'lib/rubocop/ast/node/array_node.rb', line 46

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


31
32
33
# File 'lib/rubocop/ast/node/array_node.rb', line 31

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