Class: Prism::PinnedVariableNode

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

Overview

Represents the use of the ‘^` operator for pinning a variable in a pattern matching expression.

foo in ^bar
       ^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(variable, operator_loc, location) ⇒ PinnedVariableNode

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



13558
13559
13560
13561
13562
 
# File 'lib/prism/node.rb', line 13558

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

Instance Attribute Details

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



13555
13556
13557
 
# File 'lib/prism/node.rb', line 13555

def operator_loc
  @operator_loc
end

#variable ⇒ Object (readonly)

attr_reader variable: Node



13552
13553
13554
 
# File 'lib/prism/node.rb', line 13552

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



13639
13640
13641
 
# File 'lib/prism/node.rb', line 13639

def self.type
  :pinned_variable_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



13565
13566
13567
 
# File 'lib/prism/node.rb', line 13565

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

#child_nodes ⇒ Object Also known as: deconstruct

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



13570
13571
13572
 
# File 'lib/prism/node.rb', line 13570

def child_nodes
  [variable]
end

#comment_targets ⇒ Object

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



13580
13581
13582
 
# File 'lib/prism/node.rb', line 13580

def comment_targets
  [variable, operator_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



13575
13576
13577
 
# File 'lib/prism/node.rb', line 13575

def compact_child_nodes
  [variable]
end

#copy(**params) ⇒ Object

def copy: (**params) -> PinnedVariableNode



13585
13586
13587
13588
13589
13590
13591
 
# File 'lib/prism/node.rb', line 13585

def copy(**params)
  PinnedVariableNode.new(
    params.fetch(:variable) { variable },
    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]



13597
13598
13599
 
# File 'lib/prism/node.rb', line 13597

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



13607
13608
13609
13610
13611
13612
13613
 
# File 'lib/prism/node.rb', line 13607

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── variable:\n"
  inspector << inspector.child_node(variable, "│   ")
  inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector.to_str
end

#operator ⇒ Object

def operator: () -> String



13602
13603
13604
 
# File 'lib/prism/node.rb', line 13602

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



13629
13630
13631
 
# File 'lib/prism/node.rb', line 13629

def type
  :pinned_variable_node
end