class Prism::ConstantPathNode

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

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

Public Class Methods

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

Source

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

Public Instance Methods

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.

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]

name → Symbol | nil

Source

# File lib/prism/node.rb, line 6908
def name
  @name
end

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

parent → Node | nil

Source

# File lib/prism/node.rb, line 6900
def parent
  @parent
end

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
^^^

Locations

Public Instance Methods

delimiter_loc → Location

Source

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

name_loc → Location

Source

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

Node Interface

These methods are present on all subclasses of Node. Read the node interface docs for more information.

Public Class Methods

type ()

Source

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

See Node.type.

Public Instance Methods

accept (visitor)

Source

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

See Node.accept.

child_nodes ()

Source

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

See Node.child_nodes.

Also aliased as: deconstruct

comment_targets ()

Source

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

See Node.comment_targets.

compact_child_nodes ()

Source

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

See Node.compact_child_nodes.

copy(**fields) → ConstantPathNode

Source

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

Creates a copy of self with the given fields, using self as the template.

deconstruct ()

Alias for: child_nodes

each_child_node () { |parent| ... }

Source

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

  yield parent if parent
end

See Node.each_child_node.

type ()

Source

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

See Node#type.

Repository

Methods related to Relocation.

Public Instance Methods

save_delimiter_loc (repository)

Source

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

Slicing

Public Instance Methods

delimiter → String

Source

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

Slice the location of delimiter_loc from the source.