class Prism::ConstantPathTargetNode - Documentation for Ruby 4.0
Description: class Prism::ConstantPathTargetNode: Represents writing to a constant path in a context that doesn't have an explicit value.
Keywords: ruby,class,Prism::ConstantPathTargetNode

🔍

No recent searches

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

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

type ()
Source

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

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

### Public Instance Methods

=== (other)
Source

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

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 5754
    def accept(visitor)
      visitor.visit_constant_path_target_node(self)
    end

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

child ()
Source

    # File lib/prism/node_ext.rb, line 246
    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 5759
    def child_nodes
      [parent]
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

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

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

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 5791
    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 5828
    def delimiter
      delimiter_loc.slice
    end

def delimiter: () -> `String`

delimiter_loc ()
Source

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

attr_reader `delimiter_loc`: `Location`

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

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

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 5833
    def inspect
      InspectVisitor.compose(self)
    end

def inspect -> `String`

name_loc ()
Source

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

attr_reader `name_loc`: `Location`

save_delimiter_loc (repository)
Source

    # File lib/prism/node.rb, line 5810
    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 5823
    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 5838
    def type
      :constant_path_target_node
    end

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