Class: Prism::KeywordHashNode

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

Overview

Represents a hash literal without opening and closing braces.

foo(a: b)
    ^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(flags, elements, location) ⇒ KeywordHashNode

def initialize: (flags: Integer, elements: Array, location: Location) -> void



10411
10412
10413
10414
10415
 
# File 'lib/prism/node.rb', line 10411

def initialize(flags, elements, location)
  @flags = flags
  @elements = elements
  @location = location
end

Instance Attribute Details

#elements ⇒ Object (readonly)

attr_reader elements: Array



10408
10409
10410
 
# File 'lib/prism/node.rb', line 10408

def elements
  @elements
end

#flags ⇒ Object (readonly)

Returns the value of attribute flags.



10405
10406
10407
 
# File 'lib/prism/node.rb', line 10405

def flags
  @flags
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



10492
10493
10494
 
# File 'lib/prism/node.rb', line 10492

def self.type
  :keyword_hash_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



10418
10419
10420
 
# File 'lib/prism/node.rb', line 10418

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

#child_nodes ⇒ Object Also known as: deconstruct

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



10423
10424
10425
 
# File 'lib/prism/node.rb', line 10423

def child_nodes
  [*elements]
end

#comment_targets ⇒ Object

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



10433
10434
10435
 
# File 'lib/prism/node.rb', line 10433

def comment_targets
  [*elements]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



10428
10429
10430
 
# File 'lib/prism/node.rb', line 10428

def compact_child_nodes
  [*elements]
end

#copy(**params) ⇒ Object

def copy: (**params) -> KeywordHashNode



10438
10439
10440
10441
10442
10443
10444
 
# File 'lib/prism/node.rb', line 10438

def copy(**params)
  KeywordHashNode.new(
    params.fetch(:flags) { flags },
    params.fetch(:elements) { elements },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



10450
10451
10452
 
# File 'lib/prism/node.rb', line 10450

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



10460
10461
10462
10463
10464
10465
10466
 
# File 'lib/prism/node.rb', line 10460

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  flags = [("static_keys" if static_keys?)].compact
  inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  inspector << "└── elements: #{inspector.list("#{inspector.prefix}    ", elements)}"
  inspector.to_str
end

#static_keys? ⇒ Boolean

def static_keys?: () -> bool

Returns:

  • (Boolean) 


10455
10456
10457
 
# File 'lib/prism/node.rb', line 10455

def static_keys?
  flags.anybits?(KeywordHashNodeFlags::STATIC_KEYS)
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



10482
10483
10484
 
# File 'lib/prism/node.rb', line 10482

def type
  :keyword_hash_node
end