class Prism::HashPatternNode

Represents a hash pattern in pattern matching.

foo => { a: 1, b: 2 }
       ^^^^^^^^^^^^^^

foo => { a: 1, b: 2, **c }
       ^^^^^^^^^^^^^^^^^^^

foo => Bar[a: 1, b: 2]
       ^^^^^^^^^^^^^^^

foo in { a: 1, b: 2 }
       ^^^^^^^^^^^^^^

Attributes

constant [R]

Represents the optional constant preceding the Hash.

foo => Bar[a: 1, b: 2]
     ^^^

foo => Bar::Baz[a: 1, b: 2]
     ^^^^^^^^

elements [R]

Represents the explicit named hash keys and values.

foo => { a: 1, b:, ** }
         ^^^^^^^^

rest [R]

Represents the rest of the Hash keys and values. This can be named, unnamed, or explicitly forbidden via **nil, this last one results in a NoKeywordsParameterNode.

foo => { a: 1, b:, **c }
                   ^^^

foo => { a: 1, b:, ** }
                   ^^

foo => { a: 1, b:, **nil }
                   ^^^^^

Public Class Methods

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

Source

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

Initialize a new HashPatternNode node.

type ()

Source

# File lib/prism/node.rb, line 8520
def self.type
  :hash_pattern_node
end

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

Public Instance Methods

=== (other)

Source

# File lib/prism/node.rb, line 8526
def ===(other)
  other.is_a?(HashPatternNode) &&
    (constant === other.constant) &&
    (elements.length == other.elements.length) &&
    elements.zip(other.elements).all? { |left, right| left === right } &&
    (rest === other.rest) &&
    (opening_loc.nil? == other.opening_loc.nil?) &&
    (closing_loc.nil? == other.closing_loc.nil?)
end

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

accept (visitor)

Source

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

def accept: (Visitor visitor) -> void

child_nodes ()

Source

# File lib/prism/node.rb, line 8391
def child_nodes
  [constant, *elements, rest]
end

def child_nodes: () -> Array

Also aliased as: deconstruct

closing ()

Source

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

def closing: () -> String?

closing_loc ()

Source

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

The location of the closing brace.

foo => { a: 1 }
              ^

foo => Bar[a: 1]
               ^

comment_targets ()

Source

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

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

compact_child_nodes ()

Source

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

def compact_child_nodes: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, constant: self.constant, elements: self.elements, rest: self.rest, opening_loc: self.opening_loc, closing_loc: self.closing_loc)

Source

# File lib/prism/node.rb, line 8410
def copy(node_id: self.node_id, location: self.location, flags: self.flags, constant: self.constant, elements: self.elements, rest: self.rest, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
  HashPatternNode.new(source, node_id, location, flags, constant, elements, rest, opening_loc, closing_loc)
end

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?constant: ConstantPathNode | ConstantReadNode | nil, ?elements: Array, ?rest: AssocSplatNode | NoKeywordsParameterNode | nil, ?opening_loc: Location?, ?closing_loc: Location?) -> HashPatternNode

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes

deconstruct_keys (keys)

Source

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

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, constant: ConstantPathNode | ConstantReadNode | nil, elements: Array, rest: AssocSplatNode | NoKeywordsParameterNode | nil, opening_loc: Location?, closing_loc: Location? }

inspect ()

Source

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

def inspect -> String

opening ()

Source

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

def opening: () -> String?

opening_loc ()

Source

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

The location of the opening brace.

foo => { a: 1 }
       ^

foo => Bar[a: 1]
          ^

save_closing_loc (repository)

Source

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

type ()

Source

# File lib/prism/node.rb, line 8515
def type
  :hash_pattern_node
end

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