Class: Prism::ConstantTargetNode

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

Overview

Represents writing to a constant in a context that doesn’t have an explicit value.

Foo, Bar = baz
^^^  ^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, location) ⇒ ConstantTargetNode

def initialize: (name: Symbol, location: Location) -> void



5045
5046
5047
5048
 
# File 'lib/prism/node.rb', line 5045

def initialize(name, location)
  @name = name
  @location = location
end

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



5042
5043
5044
 
# File 'lib/prism/node.rb', line 5042

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



5117
5118
5119
 
# File 'lib/prism/node.rb', line 5117

def self.type
  :constant_target_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



5051
5052
5053
 
# File 'lib/prism/node.rb', line 5051

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

#child_nodes ⇒ Object Also known as: deconstruct

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



5056
5057
5058
 
# File 'lib/prism/node.rb', line 5056

def child_nodes
  []
end

#comment_targets ⇒ Object

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



5066
5067
5068
 
# File 'lib/prism/node.rb', line 5066

def comment_targets
  []
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



5061
5062
5063
 
# File 'lib/prism/node.rb', line 5061

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> ConstantTargetNode



5071
5072
5073
5074
5075
5076
 
# File 'lib/prism/node.rb', line 5071

def copy(**params)
  ConstantTargetNode.new(
    params.fetch(:name) { name },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



5082
5083
5084
 
# File 'lib/prism/node.rb', line 5082

def deconstruct_keys(keys)
  { name: name, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



5087
5088
5089
5090
5091
 
# File 'lib/prism/node.rb', line 5087

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "└── name: #{name.inspect}\n"
  inspector.to_str
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



5107
5108
5109
 
# File 'lib/prism/node.rb', line 5107

def type
  :constant_target_node
end