Class: Prism::ConstantReadNode

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

Overview

Represents referencing a constant.

Foo
^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, location) ⇒ ConstantReadNode

def initialize: (name: Symbol, location: Location) -> void



4959
4960
4961
4962
 
# File 'lib/prism/node.rb', line 4959

def initialize(name, location)
  @name = name
  @location = location
end

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



4956
4957
4958
 
# File 'lib/prism/node.rb', line 4956

def name
  @name
end

Class Method Details

.type ⇒ Object

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



5031
5032
5033
 
# File 'lib/prism/node.rb', line 5031

def self.type
  :constant_read_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



4965
4966
4967
 
# File 'lib/prism/node.rb', line 4965

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

#child_nodes ⇒ Object Also known as: deconstruct

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



4970
4971
4972
 
# File 'lib/prism/node.rb', line 4970

def child_nodes
  []
end

#comment_targets ⇒ Object

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



4980
4981
4982
 
# File 'lib/prism/node.rb', line 4980

def comment_targets
  []
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



4975
4976
4977
 
# File 'lib/prism/node.rb', line 4975

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> ConstantReadNode



4985
4986
4987
4988
4989
4990
 
# File 'lib/prism/node.rb', line 4985

def copy(**params)
  ConstantReadNode.new(
    params.fetch(:name) { name },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



4996
4997
4998
 
# File 'lib/prism/node.rb', line 4996

def deconstruct_keys(keys)
  { name: name, location: location }
end

#full_name ⇒ Object

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



96
97
98
 
# File 'lib/prism/node_ext.rb', line 96

def full_name
  name.name
end

#full_name_parts ⇒ Object

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



91
92
93
 
# File 'lib/prism/node_ext.rb', line 91

def full_name_parts
  [name]
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



5001
5002
5003
5004
5005
 
# File 'lib/prism/node.rb', line 5001

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "└── name: #{name.inspect}\n"
  inspector.to_str
end

#type ⇒ Object

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



5021
5022
5023
 
# File 'lib/prism/node.rb', line 5021

def type
  :constant_read_node
end