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]
^^^^^^^^^^^^^^^^^^^

Attributes

constant[R]

attr_reader constant: ConstantReadNode | ConstantPathNode | nil

posts[R]

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

foo in *bar, baz
             ^^^

requireds[R]

Represents the required elements of the array pattern.

foo in [1, 2]
        ^  ^

rest[R]

Represents the rest element of the array pattern.

foo in *bar
       ^^^^

Public Class Methods

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

Initialize a new ArrayPatternNode node.

# File prism/node.rb, line 1021
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

type() click to toggle source

Return a symbol representation of this node type. See ‘Node::type`.

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

Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

# File prism/node.rb, line 1164
def ===(other)
  other.is_a?(ArrayPatternNode) &&
    (constant === other.constant) &&
    (requireds.length == other.requireds.length) &&
    requireds.zip(other.requireds).all? { |left, right| left === right } &&
    (rest === other.rest) &&
    (posts.length == other.posts.length) &&
    posts.zip(other.posts).all? { |left, right| left === right } &&
    (opening_loc.nil? == other.opening_loc.nil?) &&
    (closing_loc.nil? == other.closing_loc.nil?)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

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

child_nodes() click to toggle source

def child_nodes: () -> Array[nil | Node]

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

Also aliased as: deconstruct

closing() click to toggle source

def closing: () -> String?

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

closing_loc() click to toggle source

Represents the closing location of the array pattern.

foo in [1, 2]
            ^

# File prism/node.rb, line 1119
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

comment_targets() click to toggle source

def comment_targets: () -> Array[Node | Location]

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

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

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

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) click to toggle source

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?constant: ConstantReadNode | ConstantPathNode | nil, ?requireds: Array, ?rest: Prism::node?, ?posts: Array, ?opening_loc: Location?, ?closing_loc: Location?) -> ArrayPatternNode

# File prism/node.rb, line 1060
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

deconstruct()

def deconstruct: () -> Array[nil | Node]

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, constant: ConstantReadNode | ConstantPathNode | nil, requireds: Array, rest: Prism::node?, posts: Array, opening_loc: Location?, closing_loc: Location? }

# File prism/node.rb, line 1068
def deconstruct_keys(keys)
  { node_id: node_id, location: location, constant: constant, requireds: requireds, rest: rest, posts: posts, opening_loc: opening_loc, closing_loc: closing_loc }
end

inspect() click to toggle source

def inspect -> String

# File prism/node.rb, line 1148
def inspect
  InspectVisitor.compose(self)
end

opening() click to toggle source

def opening: () -> String?

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

opening_loc() click to toggle source

Represents the opening location of the array pattern.

foo in [1, 2]
       ^

# File prism/node.rb, line 1097
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

save_closing_loc(repository) click to toggle source

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

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

save_opening_loc(repository) click to toggle source

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

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

type() click to toggle source

Return a symbol representation of this node type. See ‘Node#type`.

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