Class: Prism::ImplicitNode

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

Overview

Represents a node that is implicitly being added to the tree but doesn’t correspond directly to a node in the source.

{ foo: }
  ^^^^

{ Foo: }
  ^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value, location) ⇒ ImplicitNode

def initialize: (value: Node, location: Location) -> void



7959
7960
7961
7962
 
# File 'lib/prism/node.rb', line 7959

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

Instance Attribute Details

#value ⇒ Object (readonly)

attr_reader value: Node



7956
7957
7958
 
# File 'lib/prism/node.rb', line 7956

def value
  @value
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



8032
8033
8034
 
# File 'lib/prism/node.rb', line 8032

def self.type
  :implicit_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



7965
7966
7967
 
# File 'lib/prism/node.rb', line 7965

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

#child_nodes ⇒ Object Also known as: deconstruct

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



7970
7971
7972
 
# File 'lib/prism/node.rb', line 7970

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



7980
7981
7982
 
# File 'lib/prism/node.rb', line 7980

def comment_targets
  [value]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



7975
7976
7977
 
# File 'lib/prism/node.rb', line 7975

def compact_child_nodes
  [value]
end

#copy(**params) ⇒ Object

def copy: (**params) -> ImplicitNode



7985
7986
7987
7988
7989
7990
 
# File 'lib/prism/node.rb', line 7985

def copy(**params)
  ImplicitNode.new(
    params.fetch(:value) { value },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



7996
7997
7998
 
# File 'lib/prism/node.rb', line 7996

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



8001
8002
8003
8004
8005
8006
 
# File 'lib/prism/node.rb', line 8001

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "└── value:\n"
  inspector << inspector.child_node(value, "    ")
  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



8022
8023
8024
 
# File 'lib/prism/node.rb', line 8022

def type
  :implicit_node
end