class Prism::ConstantPathTargetNode - prism: Ruby Standard Library Documentation

# class Prism::ConstantPathTargetNode

Represents writing to a constant path in a context that doesn’t have an explicit value.

    Foo::Foo, Bar::Bar = baz
    ^^^^^^^^  ^^^^^^^^

### Attributes

name[R]

attr_reader name: Symbol?

parent[R]

attr_reader parent: Prism::node?

### Public Class Methods

new(source, node_id, location, flags, parent, name, delimiter_loc, name_loc) click to toggle source

Initialize a new `ConstantPathTargetNode` node.

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

type() click to toggle source

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

    # File prism/node.rb, line 5471
    def self.type
      :constant_path_target_node
    end

### Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

    # File prism/node.rb, line 5477
    def ===(other)
      other.is_a?(ConstantPathTargetNode) &&
        (parent === other.parent) &&
        (name === other.name) &&
        (delimiter_loc.nil? == other.delimiter_loc.nil?) &&
        (name_loc.nil? == other.name_loc.nil?)
    end

accept(visitor) click to toggle source

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

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

child() click to toggle source

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.

    # File prism/node_ext.rb, line 243
    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() click to toggle source

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

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

Also aliased as: deconstruct
comment_targets() click to toggle source

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

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

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

    # File prism/node.rb, line 5399
    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) click to toggle source

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

    # File prism/node.rb, line 5411
    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)
      ConstantPathTargetNode.new(source, node_id, location, flags, parent, name, delimiter_loc, name_loc)
    end

deconstruct()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

def `deconstruct_keys`: (Array keys) -> { node_id: Integer, location: `Location`, parent: Prism::node?, name: Symbol?, `delimiter_loc`: `Location`, `name_loc`: `Location` }

    # File prism/node.rb, line 5419
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, parent: parent, name: name, delimiter_loc: delimiter_loc, name_loc: name_loc }
    end

delimiter() click to toggle source

def delimiter: () -> String

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

delimiter_loc() click to toggle source

attr_reader `delimiter_loc`: `Location`

    # File prism/node.rb, line 5430
    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() click to toggle source

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

    # File prism/node_ext.rb, line 236
    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 prism/node_ext.rb, line 216
    def full_name_parts
      parts =
        case parent
        when ConstantPathNode, ConstantReadNode
          parent.full_name_parts
        when nil
          [:""]
        else
          # e.g. self::Foo, (var)::Bar = baz
          raise ConstantPathNode::DynamicPartsInConstantPathError, "Constant target path contains dynamic parts. Cannot compute full name"
        end

      if name.nil?
        raise ConstantPathNode::MissingNodesInConstantPathError, "Constant target path contains missing nodes. Cannot compute full name"
      end

      parts.push(name)
    end

inspect() click to toggle source

def inspect -> String

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

name_loc() click to toggle source

attr_reader `name_loc`: `Location`

    # File prism/node.rb, line 5443
    def name_loc
      location = @name_loc
      return location if location.is_a?(Location)
      @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

save_delimiter_loc(repository) click to toggle source

Save the `delimiter_loc` location using the given saved source so that it can be retrieved later.

    # File prism/node.rb, line 5438
    def save_delimiter_loc(repository)
      repository.enter(node_id, :delimiter_loc)
    end

save_name_loc(repository) click to toggle source

Save the `name_loc` location using the given saved source so that it can be retrieved later.

    # File prism/node.rb, line 5451
    def save_name_loc(repository)
      repository.enter(node_id, :name_loc)
    end

type() click to toggle source

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

    # File prism/node.rb, line 5466
    def type
      :constant_path_target_node
    end