Class: Prism::ConstantPathNode
- Inherits:
-
PrismNode
- Object
- PrismNode
- Prism::ConstantPathNode
- Defined in:
- lib/prism/node.rb,
lib/prism/node_ext.rb,
ext/prism/api_node.c
Overview
Represents accessing a constant through a path of ‘::` operators.
Foo::Bar
^^^^^^^^
Defined Under Namespace
Classes: DynamicPartsInConstantPathError, MissingNodesInConstantPathError
Instance Attribute Summary collapse
-
#name ⇒ Object
readonly
The name of the constant being accessed.
-
#parent ⇒ Object
readonly
The left-hand node of the path, if present.
Class Method Summary collapse
-
.type ⇒ Object
Return a symbol representation of this node type.
Instance Method Summary collapse
-
#===(other) ⇒ Object
Implements case-equality for the node.
-
#accept(visitor) ⇒ Object
def accept: (Visitor visitor) -> void.
-
#child ⇒ Object
Previously, we had a child node on this class that contained either a constant read or a missing node.
-
#child_nodes ⇒ Object
(also: #deconstruct)
def child_nodes: () -> Array[nil | Node].
-
#comment_targets ⇒ Object
def comment_targets: () -> Array[Node | Location].
-
#compact_child_nodes ⇒ Object
def compact_child_nodes: () -> Array.
-
#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) ⇒ Object
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?parent: Prism::node?, ?name: Symbol?, ?delimiter_loc: Location, ?name_loc: Location) -> ConstantPathNode.
-
#deconstruct_keys(keys) ⇒ Object
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, parent: Prism::node?, name: Symbol?, delimiter_loc: Location, name_loc: Location }.
-
#delimiter ⇒ Object
def delimiter: () -> String.
-
#delimiter_loc ⇒ Object
The location of the ‘::` delimiter.
-
#full_name ⇒ Object
Returns the full name of this constant path.
-
#full_name_parts ⇒ Object
Returns the list of parts for the full name of this constant path.
-
#initialize(source, node_id, location, flags, parent, name, delimiter_loc, name_loc) ⇒ ConstantPathNode
constructor
Initialize a new ConstantPathNode node.
-
#inspect ⇒ Object
def inspect -> String.
-
#name_loc ⇒ Object
The location of the name of the constant.
-
#type ⇒ Object
Return a symbol representation of this node type.
Constructor Details
#initialize(source, node_id, location, flags, parent, name, delimiter_loc, name_loc) ⇒ ConstantPathNode
Initialize a new ConstantPathNode node.
4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 |
# File 'lib/prism/node.rb', line 4350 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 |
Instance Attribute Details
#name ⇒ Object (readonly)
The name of the constant being accessed. This could be ‘nil` in the event of a syntax error.
4409 4410 4411 |
# File 'lib/prism/node.rb', line 4409 def name @name end |
#parent ⇒ Object (readonly)
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
^^^
4406 4407 4408 |
# File 'lib/prism/node.rb', line 4406 def parent @parent end |
Class Method Details
.type ⇒ Object
Return a symbol representation of this node type. See ‘Node::type`.
4453 4454 4455 |
# File 'lib/prism/node.rb', line 4453 def self.type :constant_path_node end |
Instance Method Details
#===(other) ⇒ Object
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
4459 4460 4461 4462 4463 4464 4465 |
# File 'lib/prism/node.rb', line 4459 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 |
#accept(visitor) ⇒ Object
def accept: (Visitor visitor) -> void
4362 4363 4364 |
# File 'lib/prism/node.rb', line 4362 def accept(visitor) visitor.visit_constant_path_node(self) end |
#child ⇒ Object
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.
202 203 204 205 206 207 208 209 210 |
# File '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 |
#child_nodes ⇒ Object Also known as: deconstruct
def child_nodes: () -> Array[nil | Node]
4367 4368 4369 |
# File 'lib/prism/node.rb', line 4367 def child_nodes [parent] end |
#comment_targets ⇒ Object
def comment_targets: () -> Array[Node | Location]
4379 4380 4381 |
# File 'lib/prism/node.rb', line 4379 def comment_targets [*parent, delimiter_loc, name_loc] #: Array[Prism::node | Location] end |
#compact_child_nodes ⇒ Object
def compact_child_nodes: () -> Array
4372 4373 4374 4375 4376 |
# File 'lib/prism/node.rb', line 4372 def compact_child_nodes compact = [] #: Array[Prism::node] compact << parent if parent compact end |
#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) ⇒ Object
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?parent: Prism::node?, ?name: Symbol?, ?delimiter_loc: Location, ?name_loc: Location) -> ConstantPathNode
4384 4385 4386 |
# File 'lib/prism/node.rb', line 4384 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 |
#deconstruct_keys(keys) ⇒ Object
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, parent: Prism::node?, name: Symbol?, delimiter_loc: Location, name_loc: Location }
4392 4393 4394 |
# File 'lib/prism/node.rb', line 4392 def deconstruct_keys(keys) { node_id: node_id, location: location, parent: parent, name: name, delimiter_loc: delimiter_loc, name_loc: name_loc } end |
#delimiter ⇒ Object
def delimiter: () -> String
4438 4439 4440 |
# File 'lib/prism/node.rb', line 4438 def delimiter delimiter_loc.slice end |
#delimiter_loc ⇒ Object
The location of the ‘::` delimiter.
::Foo
^^
One::Two
^^
4418 4419 4420 4421 4422 |
# File 'lib/prism/node.rb', line 4418 def delimiter_loc location = @delimiter_loc return location if location.is_a?(Location) @delimiter_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end |
#full_name ⇒ Object
Returns the full name of this constant path. For example: “Foo::Bar”
195 196 197 |
# File 'lib/prism/node_ext.rb', line 195 def full_name full_name_parts.join("::") end |
#full_name_parts ⇒ Object
Returns the list of parts for the full name of this constant path. For example: [:Foo, :Bar]
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File '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 |
#inspect ⇒ Object
def inspect -> String
4443 4444 4445 |
# File 'lib/prism/node.rb', line 4443 def inspect InspectVisitor.compose(self) end |
#name_loc ⇒ Object
The location of the name of the constant.
::Foo
^^^
One::Two
^^^
4431 4432 4433 4434 4435 |
# File 'lib/prism/node.rb', line 4431 def name_loc location = @name_loc return location if location.is_a?(Location) @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end |
#type ⇒ Object
Return a symbol representation of this node type. See ‘Node#type`.
4448 4449 4450 |
# File 'lib/prism/node.rb', line 4448 def type :constant_path_node end |