Class: Prism::ConstantOperatorWriteNode

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

Overview

Represents assigning to a constant using an operator that isn’t ‘=`.

Target += value
^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, name_loc, operator_loc, value, operator, location) ⇒ ConstantOperatorWriteNode

def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, operator: Symbol, location: Location) -> void



3512
3513
3514
3515
3516
3517
3518
3519
 
# File 'lib/prism/node.rb', line 3512

def initialize(name, name_loc, operator_loc, value, operator, location)
  @name = name
  @name_loc = name_loc
  @operator_loc = operator_loc
  @value = value
  @operator = operator
  @location = location
end

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



3497
3498
3499
 
# File 'lib/prism/node.rb', line 3497

def name
  @name
end

#name_loc ⇒ Object (readonly)

attr_reader name_loc: Location



3500
3501
3502
 
# File 'lib/prism/node.rb', line 3500

def name_loc
  @name_loc
end

#operator ⇒ Object (readonly)

attr_reader operator: Symbol



3509
3510
3511
 
# File 'lib/prism/node.rb', line 3509

def operator
  @operator
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



3503
3504
3505
 
# File 'lib/prism/node.rb', line 3503

def operator_loc
  @operator_loc
end

#value ⇒ Object (readonly)

attr_reader value: Node



3506
3507
3508
 
# File 'lib/prism/node.rb', line 3506

def value
  @value
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



3522
3523
3524
 
# File 'lib/prism/node.rb', line 3522

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

#child_nodes ⇒ Object Also known as: deconstruct

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



3527
3528
3529
 
# File 'lib/prism/node.rb', line 3527

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



3537
3538
3539
 
# File 'lib/prism/node.rb', line 3537

def comment_targets
  [name_loc, operator_loc, value]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



3532
3533
3534
 
# File 'lib/prism/node.rb', line 3532

def compact_child_nodes
  [value]
end

#copy(**params) ⇒ Object

def copy: (**params) -> ConstantOperatorWriteNode



3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
 
# File 'lib/prism/node.rb', line 3542

def copy(**params)
  ConstantOperatorWriteNode.new(
    params.fetch(:name) { name },
    params.fetch(:name_loc) { name_loc },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:value) { value },
    params.fetch(:operator) { operator },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



3557
3558
3559
 
# File 'lib/prism/node.rb', line 3557

def deconstruct_keys(keys)
  { name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, operator: operator, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object 



3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
 
# File 'lib/prism/node.rb', line 3561

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── name: #{name.inspect}\n"
  inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
  inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector << "├── value:\n"
  inspector << inspector.child_node(value, "│   ")
  inspector << "└── operator: #{operator.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



3586
3587
3588
 
# File 'lib/prism/node.rb', line 3586

def type
  :constant_operator_write_node
end