Represents writing to a constant path.
::Foo = 1 ^^^^^^^^^ Foo::Bar = 1 ^^^^^^^^^^^^ ::Foo::Bar = 1 ^^^^^^^^^^^^^^
A node representing the constant path being written to.
Foo::Bar = 1 ^^^^^^^^ ::Foo = :abc ^^^^^
The value to write to the constant path. It can be any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).
FOO::BAR = :abc
^^^^
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5359
def initialize(source, target, operator_loc, value, location)
@source = source
@location = location
@target = target
@operator_loc = operator_loc
@value = value
end
def initialize: (ConstantPathNode target, Location operator_loc, Prism::node value, Location location) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5459
def self.type
:constant_path_write_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 5465
def ===(other)
other.is_a?(ConstantPathWriteNode) &&
(target === other.target) &&
(operator_loc.nil? == other.operator_loc.nil?) &&
(value === other.value)
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 5368
def accept(visitor)
visitor.visit_constant_path_write_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5373
def child_nodes
[target, value]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5383
def comment_targets
[target, operator_loc, value] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5378
def compact_child_nodes
[target, value]
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5388
def copy(target: self.target, operator_loc: self.operator_loc, value: self.value, location: self.location)
ConstantPathWriteNode.new(source, target, operator_loc, value, location)
end
def copy: (?target: ConstantPathNode, ?operator_loc: Location, ?value: Prism::node, ?location: Location) -> ConstantPathWriteNode
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5396
def deconstruct_keys(keys)
{ target: target, operator_loc: operator_loc, value: value, location: location }
end
def deconstruct_keys: (Array keys) -> { target: ConstantPathNode, operator_loc: Location, value: Prism::node, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5431
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5426
def operator
operator_loc.slice
end
def operator: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5413
def operator_loc
location = @operator_loc
return location if location.is_a?(Location)
@operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
The location of the ‘=` operator.
::ABC = 123
^
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 5449
def type
:constant_path_write_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