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, Node
Instance Chain:
self, Node
Inherits: Prism::Node
Defined in: lib/prism/node.rb,
lib/prism/node_ext.rb

Overview

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

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

Class Method Summary

Instance Attribute Summary

  • #child readonly

    Previously, we had a child node on this class that contained either a constant read or a missing node.

  • #delimiter_loc readonly

    attr_reader delimiter_loc: Location.

  • #parent readonly

    attr_reader parent: Node?

Node - Inherited

#location

A Location instance that represents the location of this node in the source.
#newline?

See additional method definition at file lib/prism/node.rb line 16.

Instance Method Summary

Node - Inherited

#pretty_print

Similar to inspect, but respects the current level of indentation given by the pretty print object.
#slice

Slice the location of the node from the source.
#to_dot

Convert this node into a graphviz dot graph string.
#deprecated, #newline!, #set_newline_flag

Constructor Details

.new(parent, child, delimiter_loc, location) ⇒ ConstantPathNode

def initialize: (parent: Node?, child: Node, delimiter_loc: Location, location: Location) -> void

[ GitHub ] 

  


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



def initialize(parent, child, delimiter_loc, location)
  @parent = parent
  @child = child
  @delimiter_loc = delimiter_loc
  @location = location
end


  







Class Method Details



  

    .type  
  



  

    

Similar to #type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.



def self.type: () -> Symbol


  



  [ GitHub ]


  

  


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



def self.type
  :constant_path_node
end


  







Instance Attribute Details



  

    #child   (readonly)
  



  

    

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 181



attr_reader :child


  








  

    #delimiter_loc   (readonly)
  



  

    

attr_reader delimiter_loc: Location


  



  [ GitHub ]


  

  


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



attr_reader :delimiter_loc


  








  

    #parent   (readonly)
  



  

    

attr_reader parent: Node?


  



  [ GitHub ]


  

  


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



attr_reader :parent


  







Instance Method Details



  

    #accept(visitor)  
  



  

    

def accept: (visitor: Visitor) -> void


  



  [ GitHub ]


  

  


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



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

    

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


  



  [ GitHub ]


  

  


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



def child_nodes
  [parent, child]
end


  








  

    #comment_targets  
  



  

    

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


  



  [ GitHub ]


  

  


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



def comment_targets
  [*parent, child, delimiter_loc]
end


  








  

    #compact_child_nodes  
  



  

    

def compact_child_nodes: () -> Array


  



  [ GitHub ]


  

  


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



def compact_child_nodes
  compact = []
  compact << parent if parent
  compact << child
  compact
end


  








  

    #copy(**params)  
  



  

    

def copy: (**params) -> ConstantPathNode


  



  [ GitHub ]


  

  


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



def copy(**params)
  ConstantPathNode.new(
    params.fetch(:parent) { parent },
    params.fetch(:child) { child },
    params.fetch(:delimiter_loc) { delimiter_loc },
    params.fetch(:location) { location },
  )
end


  








  

    #deconstruct  
  



  

    

Alias for #child_nodes.


  



  [ GitHub ]


  

  


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



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]


  



  [ GitHub ]


  

  


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



def deconstruct_keys(keys)
  { parent: parent, child: child, delimiter_loc: delimiter_loc, location: location }
end


  








  

    #delimiter  
  



  

    

def delimiter: () -> String


  



  [ GitHub ]


  

  


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



def delimiter
  delimiter_loc.slice
end


  








  

    #full_name  
  



  

    

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


  



  [ GitHub ]


  

  


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



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 152



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(inspector = NodeInspector.new)  
  



  

    

def inspect(inspector: NodeInspector) -> String


  



  [ GitHub ]


  

  


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



def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  if (parent = self.parent).nil?
    inspector << "├── parent: ∅\n"
  else
    inspector << "├── parent:\n"
    inspector << parent.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── child:\n"
  inspector << inspector.child_node(child, "│   ")
  inspector << "└── delimiter_loc: #{inspector.location(delimiter_loc)}\n"
  inspector.to_str
end


  








  

    #type  
  



  

    

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling [cls1, cls2].include?(node.class) or putting the node into a case statement and doing case node; when cls1; when cls2; end. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.



Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.



def type: () -> Symbol


  



  [ GitHub ]


  

  


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



def type
  :constant_path_node
end