class Prism::ArrayPatternNode

Represents an array pattern in pattern matching.

foo in 1, 2
       ^^^^

foo in [1, 2]
       ^^^^^^

foo in *bar
       ^^^^

foo in Bar[]
       ^^^^^

foo in Bar[1, 2, 3]
       ^^^^^^^^^^^^

Public Class Methods

new (source, node_id, location, flags, constant, requireds, rest, posts, opening_loc, closing_loc)

Source

# File lib/prism/node.rb, line 1616
def initialize(source, node_id, location, flags, constant, requireds, rest, posts, opening_loc, closing_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @constant = constant
  @requireds = requireds
  @rest = rest
  @posts = posts
  @opening_loc = opening_loc
  @closing_loc = closing_loc
end

Initialize a new ArrayPatternNode node.

Public Instance Methods

constant → ConstantPathNode | ConstantReadNode | nil

Source

# File lib/prism/node.rb, line 1739
def constant
  @constant
end

Represents the optional constant preceding the Array

foo in Bar[]
       ^^^

foo in Bar[1, 2, 3]
       ^^^

foo in Bar::Baz[1, 2, 3]
       ^^^^^^^^

posts → Array[Node]

Source

# File lib/prism/node.rb, line 1778
def posts
  @posts
end

Represents the elements after the rest element of the array pattern.

foo in *bar, baz
             ^^^

requireds → Array[Node]

Source

# File lib/prism/node.rb, line 1752
def requireds
  @requireds
end

Represents the required elements of the array pattern.

foo in [1, 2]
        ^  ^

rest → Node | nil

Source

# File lib/prism/node.rb, line 1765
def rest
  @rest
end

Represents the rest element of the array pattern.

foo in *bar
       ^^^^

Locations

Public Instance Methods

closing_loc → Location | nil

Source

# File lib/prism/node.rb, line 1822
def closing_loc
  location = @closing_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

Represents the closing Location of the array pattern.

foo in [1, 2]
            ^

opening_loc → Location | nil

Source

# File lib/prism/node.rb, line 1792
def opening_loc
  location = @opening_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

Represents the opening Location of the array pattern.

foo in [1, 2]
       ^

Node Interface

These methods are present on all subclasses of Node. Read the node interface docs for more information.

Public Class Methods

type ()

Source

# File lib/prism/node.rb, line 1713
def self.type
  :array_pattern_node
end

See Node.type.

Public Instance Methods

accept (visitor)

Source

# File lib/prism/node.rb, line 1643
def accept(visitor)
  visitor.visit_array_pattern_node(self)
end

See Node.accept.

child_nodes ()

Source

# File lib/prism/node.rb, line 1650
def child_nodes
  [constant, *requireds, rest, *posts]
end

See Node.child_nodes.

Also aliased as: deconstruct

comment_targets ()

Source

# File lib/prism/node.rb, line 1682
def comment_targets
  [*constant, *requireds, *rest, *posts, *opening_loc, *closing_loc] #: Array[Prism::node | Location]
end

See Node.comment_targets.

compact_child_nodes ()

Source

# File lib/prism/node.rb, line 1670
def compact_child_nodes
  compact = [] #: Array[Prism::node]
  if (constant = self.constant); compact << constant; end
  compact.concat(requireds)
  if (rest = self.rest); compact << rest; end
  compact.concat(posts)
  compact
end

See Node.compact_child_nodes.

copy(**fields) → ArrayPatternNode

Source

# File lib/prism/node.rb, line 1692
def copy(node_id: self.node_id, location: self.location, flags: self.flags, constant: self.constant, requireds: self.requireds, rest: self.rest, posts: self.posts, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
  ArrayPatternNode.new(source, node_id, location, flags, constant, requireds, rest, posts, opening_loc, closing_loc)
end

Creates a copy of self with the given fields, using self as the template.

deconstruct ()

Alias for: child_nodes

each_child_node () { |constant;| ... }

Source

# File lib/prism/node.rb, line 1658
def each_child_node(&blk)
  return to_enum(:each_child_node) unless block_given?

  if (constant = self.constant); yield constant; end
  requireds.each { |node| yield node }
  if (rest = self.rest); yield rest; end
  posts.each { |node| yield node }
end

See Node.each_child_node.

type ()

Source

# File lib/prism/node.rb, line 1706
def type
  :array_pattern_node
end

See Node#type.

Repository

Methods related to Relocation.

Public Instance Methods

save_closing_loc (repository)

Source

# File lib/prism/node.rb, line 1839
def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
end

Save the closing_loc location using the given saved source so that it can be retrieved later.

save_opening_loc (repository)

Source

# File lib/prism/node.rb, line 1809
def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
end

Save the opening_loc location using the given saved source so that it can be retrieved later.

Slicing

Public Instance Methods

closing → String | nil

Source

# File lib/prism/node.rb, line 1860
def closing
  closing_loc&.slice
end

Slice the location of closing_loc from the source.

opening → String | nil

Source

# File lib/prism/node.rb, line 1850
def opening
  opening_loc&.slice
end

Slice the location of opening_loc from the source.