Class: Prism::HashNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents a hash literal.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Initialize a new HashNode node.



8172
8173
8174
8175
8176
8177
8178
8179
8180
 
# File 'lib/prism/node.rb', line 8172

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



8238
8239
8240
 
# File 'lib/prism/node.rb', line 8238

def elements
  @elements
end

Class Method Details

.type ⇒ Object

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



8277
8278
8279
 
# File 'lib/prism/node.rb', line 8277

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.



8283
8284
8285
8286
8287
8288
8289
 
# File 'lib/prism/node.rb', line 8283

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



8183
8184
8185
 
# File 'lib/prism/node.rb', line 8183

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

#child_nodes ⇒ Object Also known as: deconstruct

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



8188
8189
8190
 
# File 'lib/prism/node.rb', line 8188

def child_nodes
  [*elements]
end

#closing ⇒ Object

def closing: () -> String



8262
8263
8264
 
# File 'lib/prism/node.rb', line 8262

def closing
  closing_loc.slice
end

#closing_loc ⇒ Object

The location of the closing brace.

{ a => b }
         ^



8244
8245
8246
8247
8248
 
# File 'lib/prism/node.rb', line 8244

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]



8198
8199
8200
 
# File 'lib/prism/node.rb', line 8198

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



8193
8194
8195
 
# File 'lib/prism/node.rb', line 8193

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



8203
8204
8205
 
# File 'lib/prism/node.rb', line 8203

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 }



8211
8212
8213
 
# File 'lib/prism/node.rb', line 8211

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



8267
8268
8269
 
# File 'lib/prism/node.rb', line 8267

def inspect
  InspectVisitor.compose(self)
end

#opening ⇒ Object

def opening: () -> String



8257
8258
8259
 
# File 'lib/prism/node.rb', line 8257

def opening
  opening_loc.slice
end

#opening_loc ⇒ Object

The location of the opening brace.

{ a => b }
^



8219
8220
8221
8222
8223
 
# File 'lib/prism/node.rb', line 8219

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

#save_closing_loc(repository) ⇒ Object

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



8252
8253
8254
 
# File 'lib/prism/node.rb', line 8252

def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc)
end

#save_opening_loc(repository) ⇒ Object

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



8227
8228
8229
 
# File 'lib/prism/node.rb', line 8227

def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc)
end

#type ⇒ Object

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



8272
8273
8274
 
# File 'lib/prism/node.rb', line 8272

def type
  :hash_node
end