Class: Prism::HashNode

Inherits:

PrismNode

• Object
• PrismNode
• Prism::HashNode

Defined in:

lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents a hash literal.

{ a => b }
^^^^^^^^^^

Instance Attribute Summary

• #elements ⇒ Object readonly

  The elements of the hash.

Class Method Summary

• .type ⇒ Object

  Return a symbol representation of this node type.

Instance Method Summary

• #===(other) ⇒ Object

  Implements case-equality for the node.

• #accept(visitor) ⇒ Object

  def accept: (Visitor visitor) -> void.

• #child_nodes ⇒ Object (also: #deconstruct)

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

• #closing ⇒ Object

  def closing: () -> String.

• #closing_loc ⇒ Object

  The location of the closing brace.

• #comment_targets ⇒ Object

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

• #compact_child_nodes ⇒ Object

  def compact_child_nodes: () -> Array.

• #copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, elements: self.elements, closing_loc: self.closing_loc) ⇒ Object

  def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?opening_loc: Location, ?elements: Array[AssocNode | AssocSplatNode], ?closing_loc: Location) -> HashNode.

• #deconstruct_keys(keys) ⇒ Object

  def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, opening_loc: Location, elements: Array[AssocNode | AssocSplatNode], closing_loc: Location }.

• #initialize(source, node_id, location, flags, opening_loc, elements, closing_loc) ⇒ HashNode constructor

  Initialize a new HashNode node.

• #inspect ⇒ Object

  def inspect -> String.

• #opening ⇒ Object

  def opening: () -> String.

• #opening_loc ⇒ Object

  The location of the opening brace.

• #type ⇒ Object

  Return a symbol representation of this node type.

Constructor Details

#initialize(source, node_id, location, flags, opening_loc, elements, closing_loc) ⇒ HashNode

Initialize a new HashNode node.

# File 'lib/prism/node.rb', line 7231

def initialize(source, node_id, location, flags, opening_loc, elements, closing_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @opening_loc = opening_loc
  @elements = elements
  @closing_loc = closing_loc
end

Instance Attribute Details

#elements ⇒ Object (readonly)

The elements of the hash. These can be either ‘AssocNode`s or `AssocSplatNode`s.

{ a: b }
  ^^^^

{ **foo }
  ^^^^^

# File 'lib/prism/node.rb', line 7291

def elements
  @elements
end

Class Method Details

.type ⇒ Object

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

# File 'lib/prism/node.rb', line 7324

def self.type
  :hash_node
end

Instance Method Details

#===(other) ⇒ Object

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

# File 'lib/prism/node.rb', line 7330

def ===(other)
  other.is_a?(HashNode) &&
    (opening_loc.nil? == other.opening_loc.nil?) &&
    (elements.length == other.elements.length) &&
    elements.zip(other.elements).all? { |left, right| left === right } &&
    (closing_loc.nil? == other.closing_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void

# File 'lib/prism/node.rb', line 7242

def accept(visitor)
  visitor.visit_hash_node(self)
end

#child_nodes ⇒ Object Also known as: deconstruct

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

# File 'lib/prism/node.rb', line 7247

def child_nodes
  [*elements]
end

#closing ⇒ Object

def closing: () -> String

# File 'lib/prism/node.rb', line 7309

def closing
  closing_loc.slice
end

#closing_loc ⇒ Object

The location of the closing brace.

{ a => b }
         ^

# File 'lib/prism/node.rb', line 7297

def closing_loc
  location = @closing_loc
  return location if location.is_a?(Location)
  @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#comment_targets ⇒ Object

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

# File 'lib/prism/node.rb', line 7257

def comment_targets
  [opening_loc, *elements, closing_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array

# File 'lib/prism/node.rb', line 7252

def compact_child_nodes
  [*elements]
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, elements: self.elements, closing_loc: self.closing_loc) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?opening_loc: Location, ?elements: Array[AssocNode | AssocSplatNode], ?closing_loc: Location) -> HashNode

# File 'lib/prism/node.rb', line 7262

def copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, elements: self.elements, closing_loc: self.closing_loc)
  HashNode.new(source, node_id, location, flags, opening_loc, elements, closing_loc)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, opening_loc: Location, elements: Array[AssocNode | AssocSplatNode], closing_loc: Location }

# File 'lib/prism/node.rb', line 7270

def deconstruct_keys(keys)
  { node_id: node_id, location: location, opening_loc: opening_loc, elements: elements, closing_loc: closing_loc }
end

#inspect ⇒ Object

def inspect -> String

# File 'lib/prism/node.rb', line 7314

def inspect
  InspectVisitor.compose(self)
end

#opening ⇒ Object

def opening: () -> String

# File 'lib/prism/node.rb', line 7304

def opening
  opening_loc.slice
end

#opening_loc ⇒ Object

The location of the opening brace.

{ a => b }
^

# File 'lib/prism/node.rb', line 7278

def opening_loc
  location = @opening_loc
  return location if location.is_a?(Location)
  @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#type ⇒ Object

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

# File 'lib/prism/node.rb', line 7319

def type
  :hash_node
end