class Prism::ConstantPathNode - Documentation for Ruby 4.0
Description: class Prism::ConstantPathNode: operators.
Keywords: ruby,class,Prism::ConstantPathNode

🔍

No recent searches

# class Prism::ConstantPathNode

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

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

### Attributes

name [R]

The name of the constant being accessed. This could be `nil` in the event of a syntax error.

parent [R]

The left-hand node of the path, if present. It can be `nil` or any 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
    ^^^

### Public Class Methods

new (source, node_id, location, flags, parent, name, delimiter_loc, name_loc)
Source

    # File lib/prism/node.rb, line 5387
    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.

type ()
Source

    # File lib/prism/node.rb, line 5509
    def self.type
      :constant_path_node
    end

Return a symbol representation of this node type. See `Node::type`.

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 5515
    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.

accept (visitor)
Source

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

def accept: (`Visitor` visitor) -> void

child ()
Source

    # File lib/prism/node_ext.rb, line 205
    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.

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 5423
    def comment_targets
      [*parent, delimiter_loc, name_loc] #: Array[Prism::node | Location]
    end

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

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 5416
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      compact << parent if parent
      compact
    end

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)
Source

    # File lib/prism/node.rb, line 5428
    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

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?parent: Prism::node?, ?name: `Symbol`?, ?delimiter_loc: `Location`, ?name_loc: `Location`) -> `ConstantPathNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 5436
    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` }

delimiter ()
Source

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

def delimiter: () -> `String`

delimiter_loc ()
Source

    # File lib/prism/node.rb, line 5462
    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
       ^^

each_child_node () { |parent| ... }
Source

    # File lib/prism/node.rb, line 5409
    def each_child_node
      return to_enum(:each_child_node) unless block_given?

      yield parent if parent
    end

def `each_child_node`: () { (Prism::node) -> void } -> void | () -> Enumerator

full_name ()
Source

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

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

full_name_parts ()
Source

    # File lib/prism/node_ext.rb, line 176
    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]

inspect ()
Source

    # File lib/prism/node.rb, line 5499
    def inspect
      InspectVisitor.compose(self)
    end

def inspect -> `String`

name_loc ()
Source

    # File lib/prism/node.rb, line 5481
    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
         ^^^

save_delimiter_loc (repository)
Source

    # File lib/prism/node.rb, line 5470
    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.

save_name_loc (repository)
Source

    # File lib/prism/node.rb, line 5489
    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.

type ()
Source

    # File lib/prism/node.rb, line 5504
    def type
      :constant_path_node
    end

Return a symbol representation of this node type. See `Node#type`.