class Prism::ConstantPathNode

Represents accessing a constant through a path of ‘::` operators.

Foo::Bar
^^^^^^^^

Attributes

child[R]

attr_reader child: Node

delimiter_loc[R]

attr_reader delimiter_loc: Location

parent[R]

attr_reader parent: Node?

Public Class Methods

new(parent, child, delimiter_loc, location) click to toggle source

def initialize: (parent: Node?, child: Node, delimiter_loc: Location, location: Location) -> void

# File lib/prism/node.rb, line 4419
def initialize(parent, child, delimiter_loc, location)
  @parent = parent
  @child = child
  @delimiter_loc = delimiter_loc
  @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 lib/prism/node.rb, line 4511
def self.type
  :constant_path_node
end

Public Instance Methods

accept(visitor) click to toggle source

def accept: (visitor: Visitor) -> void

# File lib/prism/node.rb, line 4427
def accept(visitor)
  visitor.visit_constant_path_node(self)
end

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 4432
def child_nodes
  [parent, child]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 4445
def comment_targets
  [*parent, child, delimiter_loc]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 4437
def compact_child_nodes
  compact = []
  compact << parent if parent
  compact << child
  compact
end

copy(**params) click to toggle source

def copy: (**params) -> ConstantPathNode

# File lib/prism/node.rb, line 4450
def copy(**params)
  ConstantPathNode.new(
    params.fetch(:parent) { parent },
    params.fetch(:child) { child },
    params.fetch(:delimiter_loc) { delimiter_loc },
    params.fetch(:location) { location },
  )
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

# File lib/prism/node.rb, line 4463
def deconstruct_keys(keys)
  { parent: parent, child: child, delimiter_loc: delimiter_loc, location: location }
end

delimiter() click to toggle source

def delimiter: () -> String

# File lib/prism/node.rb, line 4468
def delimiter
  delimiter_loc.slice
end

full_name() click to toggle source

Returns the full name of this constant path. For example: “Foo::Bar”

# File lib/prism/node_ext.rb, line 129
def full_name
  full_name_parts.join("::")
end

full_name_parts() click to toggle source

Returns the list of parts for the full name of this constant path. For example: [:Foo, :Bar]

# File lib/prism/node_ext.rb, line 112
def full_name_parts
  parts = [child.name]
  current = parent

  while current.is_a?(ConstantPathNode)
    parts.unshift(current.child.name)
    current = current.parent
  end

  unless current.is_a?(ConstantReadNode)
    raise DynamicPartsInConstantPathError, "Constant path contains dynamic parts. Cannot compute full name"
  end

  parts.unshift(current&.name || :"")
end

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

def inspect(inspector: NodeInspector) -> String

# File lib/prism/node.rb, line 4473
def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  if (parent = self.parent).nil?
    inspector << "├── parent: ∅\n"
  else
    inspector << "├── parent:\n"
    inspector << parent.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── child:\n"
  inspector << inspector.child_node(child, "│   ")
  inspector << "└── delimiter_loc: #{inspector.location(delimiter_loc)}\n"
  inspector.to_str
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 lib/prism/node.rb, line 4501
def type
  :constant_path_node
end