Represents referencing a constant.
Foo ^^^
The name of the [constant](github.com/ruby/prism/blob/main/docs/parsing_rules.md#constants).
X # name `:X` SOME_CONSTANT # name `:SOME_CONSTANT`
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5479
def initialize(source, name, location)
@source = source
@location = location
@name = name
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5554
def self.type
:constant_read_node
end
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
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5560
def ===(other)
other.is_a?(ConstantReadNode) &&
(name === other.name)
end
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5486
def accept(visitor)
visitor.visit_constant_read_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5491
def child_nodes
[]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5501
def comment_targets
[] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5496
def compact_child_nodes
[]
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5506
def copy(name: self.name, location: self.location)
ConstantReadNode.new(source, name, location)
end
def copy: (?name: Symbol, ?location: Location) -> ConstantReadNode
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5514
def deconstruct_keys(keys)
{ name: name, location: location }
end
def deconstruct_keys: (Array keys) -> { name: Symbol, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node_ext.rb, line 118
def full_name
name.to_s
end
Returns the full name of this constant. For example: “Foo”
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node_ext.rb, line 113
def full_name_parts
[name]
end
Returns the list of parts for the full name of this constant. For example: [:Foo]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5526
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5544
def type
:constant_read_node
end
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