Class: Prism::AssocSplatNode

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

Overview

Represents a splat in a hash literal.

{ **foo }
  ^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value, operator_loc, location) ⇒ AssocSplatNode

def initialize: (value: Node?, operator_loc: Location, location: Location) -> void



964
965
966
967
968
 
# File 'lib/prism/node.rb', line 964

def initialize(value, operator_loc, location)
  @value = value
  @operator_loc = operator_loc
  @location = location
end

Instance Attribute Details

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



961
962
963
 
# File 'lib/prism/node.rb', line 961

def operator_loc
  @operator_loc
end

#value ⇒ Object (readonly)

attr_reader value: Node?



958
959
960
 
# File 'lib/prism/node.rb', line 958

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



1051
1052
1053
 
# File 'lib/prism/node.rb', line 1051

def self.type
  :assoc_splat_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



971
972
973
 
# File 'lib/prism/node.rb', line 971

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

#child_nodes ⇒ Object Also known as: deconstruct

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



976
977
978
 
# File 'lib/prism/node.rb', line 976

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



988
989
990
 
# File 'lib/prism/node.rb', line 988

def comment_targets
  [*value, operator_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



981
982
983
984
985
 
# File 'lib/prism/node.rb', line 981

def compact_child_nodes
  compact = []
  compact << value if value
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> AssocSplatNode



993
994
995
996
997
998
999
 
# File 'lib/prism/node.rb', line 993

def copy(**params)
  AssocSplatNode.new(
    params.fetch(:value) { value },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



1005
1006
1007
 
# File 'lib/prism/node.rb', line 1005

def deconstruct_keys(keys)
  { value: value, operator_loc: operator_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/prism/node.rb', line 1015

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  if (value = self.value).nil?
    inspector << "├── value: ∅\n"
  else
    inspector << "├── value:\n"
    inspector << value.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector.to_str
end

#operator ⇒ Object

def operator: () -> String



1010
1011
1012
 
# File 'lib/prism/node.rb', line 1010

def operator
  operator_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



1041
1042
1043
 
# File 'lib/prism/node.rb', line 1041

def type
  :assoc_splat_node
end