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(opening_loc, elements, closing_loc, location) ⇒ HashNode

def initialize: (opening_loc: Location, elements: Array, closing_loc: Location, location: Location) -> void



7476
7477
7478
7479
7480
7481
 
# File 'lib/prism/node.rb', line 7476

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

Instance Attribute Details

#closing_loc ⇒ Object (readonly)

attr_reader closing_loc: Location



7473
7474
7475
 
# File 'lib/prism/node.rb', line 7473

def closing_loc
  @closing_loc
end

#elements ⇒ Object (readonly)

attr_reader elements: Array



7470
7471
7472
 
# File 'lib/prism/node.rb', line 7470

def elements
  @elements
end

#opening_loc ⇒ Object (readonly)

attr_reader opening_loc: Location



7467
7468
7469
 
# File 'lib/prism/node.rb', line 7467

def opening_loc
  @opening_loc
end

Class Method Details

.type ⇒ Object

Similar to #type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



7564
7565
7566
 
# File 'lib/prism/node.rb', line 7564

def self.type
  :hash_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



7484
7485
7486
 
# File 'lib/prism/node.rb', line 7484

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

#child_nodes ⇒ Object Also known as: deconstruct

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



7489
7490
7491
 
# File 'lib/prism/node.rb', line 7489

def child_nodes
  [*elements]
end

#closing ⇒ Object

def closing: () -> String



7527
7528
7529
 
# File 'lib/prism/node.rb', line 7527

def closing
  closing_loc.slice
end

#comment_targets ⇒ Object

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



7499
7500
7501
 
# File 'lib/prism/node.rb', line 7499

def comment_targets
  [opening_loc, *elements, closing_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



7494
7495
7496
 
# File 'lib/prism/node.rb', line 7494

def compact_child_nodes
  [*elements]
end

#copy(**params) ⇒ Object

def copy: (**params) -> HashNode



7504
7505
7506
7507
7508
7509
7510
7511
 
# File 'lib/prism/node.rb', line 7504

def copy(**params)
  HashNode.new(
    params.fetch(:opening_loc) { opening_loc },
    params.fetch(:elements) { elements },
    params.fetch(:closing_loc) { closing_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



7517
7518
7519
 
# File 'lib/prism/node.rb', line 7517

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



7532
7533
7534
7535
7536
7537
7538
 
# File 'lib/prism/node.rb', line 7532

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
  inspector << "├── elements: #{inspector.list("#{inspector.prefix}│   ", elements)}"
  inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
  inspector.to_str
end

#opening ⇒ Object

def opening: () -> String



7522
7523
7524
 
# File 'lib/prism/node.rb', line 7522

def opening
  opening_loc.slice
end

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



7554
7555
7556
 
# File 'lib/prism/node.rb', line 7554

def type
  :hash_node
end