Class: Prism::SplatNode

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

Overview

Represents the use of the splat operator.

[*a]
 ^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(operator_loc, expression, location) ⇒ SplatNode

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



15676
15677
15678
15679
15680
 
# File 'lib/prism/node.rb', line 15676

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

Instance Attribute Details

#expression ⇒ Object (readonly)

attr_reader expression: Node?



15673
15674
15675
 
# File 'lib/prism/node.rb', line 15673

def expression
  @expression
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



15670
15671
15672
 
# File 'lib/prism/node.rb', line 15670

def operator_loc
  @operator_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



15763
15764
15765
 
# File 'lib/prism/node.rb', line 15763

def self.type
  :splat_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



15683
15684
15685
 
# File 'lib/prism/node.rb', line 15683

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

#child_nodes ⇒ Object Also known as: deconstruct

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



15688
15689
15690
 
# File 'lib/prism/node.rb', line 15688

def child_nodes
  [expression]
end

#comment_targets ⇒ Object

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



15700
15701
15702
 
# File 'lib/prism/node.rb', line 15700

def comment_targets
  [operator_loc, *expression]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



15693
15694
15695
15696
15697
 
# File 'lib/prism/node.rb', line 15693

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

#copy(**params) ⇒ Object

def copy: (**params) -> SplatNode



15705
15706
15707
15708
15709
15710
15711
 
# File 'lib/prism/node.rb', line 15705

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

#deconstruct_keys(keys) ⇒ Object

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



15717
15718
15719
 
# File 'lib/prism/node.rb', line 15717

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
 
# File 'lib/prism/node.rb', line 15727

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

#operator ⇒ Object

def operator: () -> String



15722
15723
15724
 
# File 'lib/prism/node.rb', line 15722

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



15753
15754
15755
 
# File 'lib/prism/node.rb', line 15753

def type
  :splat_node
end