Class: Prism::ConstantPathTargetNode
Relationships & Source Files | |
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 writing to a constant path in a context that doesn’t have an explicit value.
Foo::Foo, Bar::Bar = baz
^^^^^^^^ ^^^^^^^^
Class Method Summary
- .new(parent, child, delimiter_loc, location) ⇒ ConstantPathTargetNode constructor
-
.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.
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
Instance Method Summary
-
#accept(visitor)
def accept: (visitor:
Visitor
) -> void. -
#child_nodes
(also: #deconstruct)
def child_nodes: () -> Array[nil | Node].
-
#comment_targets
def comment_targets: () -> Array[Node | Location].
-
#compact_child_nodes
def compact_child_nodes: () -> Array.
-
#copy(**params)
def copy: (**params) ->
ConstantPathTargetNode
. -
#deconstruct
Alias for #child_nodes.
- #deconstruct_keys(keys)
-
#delimiter
def delimiter: () -> String.
-
#full_name
Returns the full name of this constant path.
-
#full_name_parts
Returns the list of parts for the full name of this constant path.
-
#inspect(inspector = NodeInspector.new)
def inspect(inspector: NodeInspector) -> String.
-
#type
Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform.
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) ⇒ ConstantPathTargetNode
[ GitHub ]
# File 'lib/prism/node.rb', line 4742
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
# File 'lib/prism/node.rb', line 4834
def self.type :constant_path_target_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.
# File 'lib/prism/node_ext.rb', line 217
attr_reader :child
#delimiter_loc (readonly)
attr_reader delimiter_loc: Location
# File 'lib/prism/node.rb', line 4739
attr_reader :delimiter_loc
#parent (readonly)
attr_reader parent: Node?
# File 'lib/prism/node.rb', line 4733
attr_reader :parent
Instance Method Details
#accept(visitor)
def accept: (visitor: Visitor
) -> void
# File 'lib/prism/node.rb', line 4750
def accept(visitor) visitor.visit_constant_path_target_node(self) end
#child_nodes Also known as: #deconstruct
def child_nodes: () -> Array[nil | Node]
#comment_targets
def comment_targets: () -> Array[Node | Location]
# File 'lib/prism/node.rb', line 4768
def comment_targets [*parent, child, delimiter_loc] end
#compact_child_nodes
def compact_child_nodes: () -> Array
#copy(**params)
def copy: (**params) -> ConstantPathTargetNode
# File 'lib/prism/node.rb', line 4773
def copy(**params) ConstantPathTargetNode.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.
# File 'lib/prism/node.rb', line 4783
alias deconstruct child_nodes
#deconstruct_keys(keys)
# File 'lib/prism/node.rb', line 4786
def deconstruct_keys(keys) { parent: parent, child: child, delimiter_loc: delimiter_loc, location: location } end
#delimiter
def delimiter: () -> String
# File 'lib/prism/node.rb', line 4791
def delimiter delimiter_loc.slice end
#full_name
Returns the full name of this constant path. For example: “Foo::Bar”
# File 'lib/prism/node_ext.rb', line 210
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]
# File 'lib/prism/node_ext.rb', line 190
def full_name_parts parts = case parent when ConstantPathNode, ConstantReadNode parent.full_name_parts when nil [:""] else # e.g. self::Foo, (var)::Bar = baz raise ConstantPathNode::DynamicPartsInConstantPathError, "Constant target path contains dynamic parts. Cannot compute full name" end if name.nil? raise ConstantPathNode::MissingNodesInConstantPathError, "Constant target path contains missing nodes. Cannot compute full name" end parts.push(name) end
#inspect(inspector = NodeInspector.new)
def inspect(inspector: NodeInspector) -> String
# File 'lib/prism/node.rb', line 4796
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
# File 'lib/prism/node.rb', line 4824
def type :constant_path_target_node end