Class: Prism::ConstantPathNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
lib/prism/node_ext.rb,
ext/prism/api_node.c

Overview

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

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

Defined Under Namespace

Classes: DynamicPartsInConstantPathError, MissingNodesInConstantPathError

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, parent, name, delimiter_loc, name_loc) ⇒ ConstantPathNode

Initialize a new ConstantPathNode node.



5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
 
# File 'lib/prism/node.rb', line 5045

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

Instance Attribute Details

#name ⇒ Object (readonly)

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



5104
5105
5106
 
# File 'lib/prism/node.rb', line 5104

def name
  @name
end

#parent ⇒ Object (readonly)

The left-hand node of the path, if present. It can be ‘nil` or any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#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
^^^



5101
5102
5103
 
# File 'lib/prism/node.rb', line 5101

def parent
  @parent
end

Class Method Details

.type ⇒ Object

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



5160
5161
5162
 
# File 'lib/prism/node.rb', line 5160

def self.type
  :constant_path_node
end

Instance Method Details

#===(other) ⇒ Object

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



5166
5167
5168
5169
5170
5171
5172
 
# File 'lib/prism/node.rb', line 5166

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) ⇒ Object

def accept: (Visitor visitor) -> void



5057
5058
5059
 
# File 'lib/prism/node.rb', line 5057

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

#child ⇒ Object

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.



202
203
204
205
206
207
208
209
210
 
# File 'lib/prism/node_ext.rb', line 202

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 ⇒ Object Also known as: deconstruct

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



5062
5063
5064
 
# File 'lib/prism/node.rb', line 5062

def child_nodes
  [parent]
end

#comment_targets ⇒ Object

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



5074
5075
5076
 
# File 'lib/prism/node.rb', line 5074

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



5067
5068
5069
5070
5071
 
# File 'lib/prism/node.rb', line 5067

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) ⇒ Object

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



5079
5080
5081
 
# File 'lib/prism/node.rb', line 5079

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_keys(keys) ⇒ Object

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



5087
5088
5089
 
# File 'lib/prism/node.rb', line 5087

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

#delimiter ⇒ Object

def delimiter: () -> String



5145
5146
5147
 
# File 'lib/prism/node.rb', line 5145

def delimiter
  delimiter_loc.slice
end

#delimiter_loc ⇒ Object

The location of the ‘::` delimiter.

::Foo
^^

One::Two
   ^^



5113
5114
5115
5116
5117
 
# File 'lib/prism/node.rb', line 5113

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 ⇒ Object

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



195
196
197
 
# File 'lib/prism/node_ext.rb', line 195

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

#full_name_parts ⇒ Object

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/prism/node_ext.rb', line 173

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 ⇒ Object

def inspect -> String



5150
5151
5152
 
# File 'lib/prism/node.rb', line 5150

def inspect
  InspectVisitor.compose(self)
end

#name_loc ⇒ Object

The location of the name of the constant.

::Foo
  ^^^

One::Two
     ^^^



5132
5133
5134
5135
5136
 
# File 'lib/prism/node.rb', line 5132

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) ⇒ Object

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



5121
5122
5123
 
# File 'lib/prism/node.rb', line 5121

def save_delimiter_loc(repository)
  repository.enter(node_id, :delimiter_loc)
end

#save_name_loc(repository) ⇒ Object

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



5140
5141
5142
 
# File 'lib/prism/node.rb', line 5140

def save_name_loc(repository)
  repository.enter(node_id, :name_loc)
end

#type ⇒ Object

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



5155
5156
5157
 
# File 'lib/prism/node.rb', line 5155

def type
  :constant_path_node
end