Represents accessing a constant through a path of ‘::` operators.
Foo::Bar ^^^^^^^^
The left-hand node of the path, if present. It can be ‘nil` or any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression). It will be `nil` when the constant lookup is at the root of the module tree.
Foo::Bar ^^^ self::Test ^^^^ a.b::C ^^^
The name of the constant being accessed. This could be ‘nil` in the event of a syntax error.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5045
def initialize(source, node_id, location, flags, parent, name, delimiter_loc, name_loc)
@source = source
@node_id = node_id
@location = location
@flags = flags
@parent = parent
@name = name
@delimiter_loc = delimiter_loc
@name_loc = name_loc
end
Initialize a new ConstantPathNode node.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5160
def self.type
:constant_path_node
end
Return a symbol representation of this node type. See ‘Node::type`.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5166
def ===(other)
other.is_a?(ConstantPathNode) &&
(parent === other.parent) &&
(name === other.name) &&
(delimiter_loc.nil? == other.delimiter_loc.nil?) &&
(name_loc.nil? == other.name_loc.nil?)
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.1/lib/prism/node.rb, line 5057
def accept(visitor)
visitor.visit_constant_path_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.1/lib/prism/node_ext.rb, line 202
def child
deprecated("name", "name_loc")
if name
ConstantReadNode.new(source, -1, name_loc, 0, name)
else
MissingNode.new(source, -1, location, 0)
end
end
Previously, we had a child node on this class that contained either a constant read or a missing node. To not cause a breaking change, we continue to supply that API.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5062
def child_nodes
[parent]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5074
def comment_targets
[*parent, delimiter_loc, name_loc] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5067
def compact_child_nodes
compact = [] #: Array[Prism::node]
compact << parent if parent
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5079
def copy(node_id: self.node_id, location: self.location, flags: self.flags, parent: self.parent, name: self.name, delimiter_loc: self.delimiter_loc, name_loc: self.name_loc)
ConstantPathNode.new(source, node_id, location, flags, parent, name, delimiter_loc, name_loc)
end
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5087
def deconstruct_keys(keys)
{ node_id: node_id, location: location, parent: parent, name: name, delimiter_loc: delimiter_loc, name_loc: name_loc }
end
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, parent: Prism::node?, name: Symbol?, delimiter_loc: Location, name_loc: Location }
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5145
def delimiter
delimiter_loc.slice
end
def delimiter: () -> String
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5113
def delimiter_loc
location = @delimiter_loc
return location if location.is_a?(Location)
@delimiter_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
The location of the ‘::` delimiter.
::Foo ^^ One::Two ^^
# File tmp/rubies/ruby-3.4.1/lib/prism/node_ext.rb, line 195
def full_name
full_name_parts.join("::")
end
Returns the full name of this constant path. For example: “Foo::Bar”
# File tmp/rubies/ruby-3.4.1/lib/prism/node_ext.rb, line 173
def full_name_parts
parts = [] #: Array[Symbol]
current = self #: node?
while current.is_a?(ConstantPathNode)
name = current.name
if name.nil?
raise MissingNodesInConstantPathError, "Constant path contains missing nodes. Cannot compute full name"
end
parts.unshift(name)
current = current.parent
end
if !current.is_a?(ConstantReadNode) && !current.nil?
raise DynamicPartsInConstantPathError, "Constant path contains dynamic parts. Cannot compute full name"
end
parts.unshift(current&.name || :"")
end
Returns the list of parts for the full name of this constant path. For example: [:Foo, :Bar]
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5150
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5132
def name_loc
location = @name_loc
return location if location.is_a?(Location)
@name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
The location of the name of the constant.
::Foo
^^^
One::Two
^^^
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5121
def save_delimiter_loc(repository)
repository.enter(node_id, :delimiter_loc)
end
Save the delimiter_loc location using the given saved source so that it can be retrieved later.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5140
def save_name_loc(repository)
repository.enter(node_id, :name_loc)
end
Save the name_loc location using the given saved source so that it can be retrieved later.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 5155
def type
:constant_path_node
end
Return a symbol representation of this node type. See ‘Node#type`.