class Prism::ConstantPathOrWriteNode

Represents the use of the ‘||=` operator for assignment to a constant path.

Parent::Child ||= value
^^^^^^^^^^^^^^^^^^^^^^^

Attributes

operator_loc[R]

attr_reader operator_loc: Location

target[R]

attr_reader target: ConstantPathNode

value[R]

attr_reader value: Node

Public Class Methods

new(target, operator_loc, value, location) click to toggle source

def initialize: (target: ConstantPathNode, operator_loc: Location, value: Node, location: Location) -> void

# File prism/node.rb, line 4637
def initialize(target, operator_loc, value, location)
  @target = target
  @operator_loc = operator_loc
  @value = value
  @location = location
end

type() click to toggle source

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 prism/node.rb, line 4722
def self.type
  :constant_path_or_write_node
end

Public Instance Methods

accept(visitor) click to toggle source

def accept: (visitor: Visitor) -> void

# File prism/node.rb, line 4645
def accept(visitor)
  visitor.visit_constant_path_or_write_node(self)
end

child_nodes() click to toggle source

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

# File prism/node.rb, line 4650
def child_nodes
  [target, value]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File prism/node.rb, line 4660
def comment_targets
  [target, operator_loc, value]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File prism/node.rb, line 4655
def compact_child_nodes
  [target, value]
end

copy(**params) click to toggle source

def copy: (**params) -> ConstantPathOrWriteNode

# File prism/node.rb, line 4665
def copy(**params)
  ConstantPathOrWriteNode.new(
    params.fetch(:target) { target },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:value) { value },
    params.fetch(:location) { location },
  )
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

# File prism/node.rb, line 4678
def deconstruct_keys(keys)
  { target: target, operator_loc: operator_loc, value: value, location: location }
end

inspect(inspector = NodeInspector.new) click to toggle source

def inspect(inspector: NodeInspector) -> String

# File prism/node.rb, line 4688
def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── target:\n"
  inspector << inspector.child_node(target, "│   ")
  inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector << "└── value:\n"
  inspector << inspector.child_node(value, "    ")
  inspector.to_str
end

operator() click to toggle source

def operator: () -> String

# File prism/node.rb, line 4683
def operator
  operator_loc.slice
end

type() click to toggle source

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

# File prism/node.rb, line 4712
def type
  :constant_path_or_write_node
end