Class: Prism::ConstantPathOrWriteNode

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

Overview

Represents the use of the ‘||=` operator for assignment to a constant path.

Parent::Child ||= value
^^^^^^^^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(target, operator_loc, value, location) ⇒ ConstantPathOrWriteNode

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



4637
4638
4639
4640
4641
4642
 
# File 'lib/prism/node.rb', line 4637

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

Instance Attribute Details

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



4631
4632
4633
 
# File 'lib/prism/node.rb', line 4631

def operator_loc
  @operator_loc
end

#target ⇒ Object (readonly)

attr_reader target: ConstantPathNode



4628
4629
4630
 
# File 'lib/prism/node.rb', line 4628

def target
  @target
end

#value ⇒ Object (readonly)

attr_reader value: Node



4634
4635
4636
 
# File 'lib/prism/node.rb', line 4634

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



4722
4723
4724
 
# File 'lib/prism/node.rb', line 4722

def self.type
  :constant_path_or_write_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



4645
4646
4647
 
# File 'lib/prism/node.rb', line 4645

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

#child_nodes ⇒ Object Also known as: deconstruct

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



4650
4651
4652
 
# File 'lib/prism/node.rb', line 4650

def child_nodes
  [target, value]
end

#comment_targets ⇒ Object

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



4660
4661
4662
 
# File 'lib/prism/node.rb', line 4660

def comment_targets
  [target, operator_loc, value]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



4655
4656
4657
 
# File 'lib/prism/node.rb', line 4655

def compact_child_nodes
  [target, value]
end

#copy(**params) ⇒ Object

def copy: (**params) -> ConstantPathOrWriteNode



4665
4666
4667
4668
4669
4670
4671
4672
 
# File 'lib/prism/node.rb', line 4665

def copy(**params)
  ConstantPathOrWriteNode.new(
    params.fetch(:target) { target },
    params.fetch(:operator_loc) { operator_loc },
    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]



4678
4679
4680
 
# File 'lib/prism/node.rb', line 4678

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



4688
4689
4690
4691
4692
4693
4694
4695
4696
 
# File 'lib/prism/node.rb', line 4688

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── target:\n"
  inspector << inspector.child_node(target, "│   ")
  inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector << "└── value:\n"
  inspector << inspector.child_node(value, "    ")
  inspector.to_str
end

#operator ⇒ Object

def operator: () -> String



4683
4684
4685
 
# File 'lib/prism/node.rb', line 4683

def operator
  operator_loc.slice
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



4712
4713
4714
 
# File 'lib/prism/node.rb', line 4712

def type
  :constant_path_or_write_node
end