123456789_123456789_123456789_123456789_123456789_

Class: Prism::ConstantPathNode

Relationships & Source Files
Namespace Children
Exceptions:
DynamicPartsInConstantPathError, MissingNodesInConstantPathError
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PrismNode
Instance Chain:
self, PrismNode
Inherits: PrismNode
  • ::Object
Defined in: lib/prism/node.rb,
ext/prism/api_node.c,
lib/prism/node_ext.rb

Overview

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

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

Class Method Summary

Instance Attribute Summary

  • #name readonly

    The name of the constant being accessed.

  • #parent readonly

    The left-hand node of the path, if present.

Instance Method Summary

Constructor Details

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

Initialize a new ConstantPathNode node.

[ GitHub ] 

  


# File 'lib/prism/node.rb', line 4225



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


  







Class Method Details



  

    .type  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4326



def self.type
  :constant_path_node
end


  







Instance Attribute Details



  

    #name   (readonly)
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4283



attr_reader :name


  








  

    #parent   (readonly)
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4281



attr_reader :parent


  







Instance Method Details



  

    #===(other)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4332



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


  








  

    #accept(visitor)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4237



def accept(visitor)
  visitor.visit_constant_path_node(self)
end


  








  

    #child  
  



  

    
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.

  



  [ GitHub ]


  

  


# 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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4242



def child_nodes
  [parent]
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4254



def comment_targets
  [*parent, delimiter_loc, name_loc] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4247



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)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4259



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


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4264



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4267



def deconstruct_keys(keys)
  { node_id: node_id, location: location, parent: parent, name: name, delimiter_loc: delimiter_loc, name_loc: name_loc }
end


  








  

    #delimiter  
  



  

    
def delimiter: () -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4311



def delimiter
  delimiter_loc.slice
end


  








  

    #delimiter_loc  
  



  

    
The location of the :: delimiter.


::Foo
^^

One::Two
   ^^

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4291



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  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node_ext.rb', line 198



def full_name
  full_name_parts.join("::")
end


  








  

    #full_name_parts  
  



  

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

  



  [ GitHub ]


  

  


# 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


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4316



def inspect
  InspectVisitor.compose(self)
end


  








  

    #name_loc  
  



  

    
The location of the name of the constant.


::Foo
  ^^^

One::Two
     ^^^

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4304



def name_loc
  location = @name_loc
  return location if location.is_a?(Location)
  @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end


  








  

    #type  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 4321



def type
  :constant_path_node
end