Class: Prism::ClassVariableOperatorWriteNode

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

Overview

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

@@target += value
^^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

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



3486
3487
3488
3489
3490
3491
3492
3493
# File 'lib/prism/node.rb', line 3486

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

#nameObject (readonly)

attr_reader name: Symbol



3471
3472
3473
# File 'lib/prism/node.rb', line 3471

def name
  @name
end

#name_locObject (readonly)

attr_reader name_loc: Location



3474
3475
3476
# File 'lib/prism/node.rb', line 3474

def name_loc
  @name_loc
end

#operatorObject (readonly)

attr_reader operator: Symbol



3483
3484
3485
# File 'lib/prism/node.rb', line 3483

def operator
  @operator
end

#operator_locObject (readonly)

attr_reader operator_loc: Location



3477
3478
3479
# File 'lib/prism/node.rb', line 3477

def operator_loc
  @operator_loc
end

#valueObject (readonly)

attr_reader value: Node



3480
3481
3482
# File 'lib/prism/node.rb', line 3480

def value
  @value
end

Class Method Details

.typeObject

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



3571
3572
3573
# File 'lib/prism/node.rb', line 3571

def self.type
  :class_variable_operator_write_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



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

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

#child_nodesObject Also known as: deconstruct

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



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

def child_nodes
  [value]
end

#comment_targetsObject

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



3511
3512
3513
# File 'lib/prism/node.rb', line 3511

def comment_targets
  [name_loc, operator_loc, value]
end

#compact_child_nodesObject

def compact_child_nodes: () -> Array



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

def compact_child_nodes
  [value]
end

#copy(**params) ⇒ Object

def copy: (**params) -> ClassVariableOperatorWriteNode



3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
# File 'lib/prism/node.rb', line 3516

def copy(**params)
  ClassVariableOperatorWriteNode.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]



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

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

def inspect(inspector: NodeInspector) -> String



3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
# File 'lib/prism/node.rb', line 3536

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

#typeObject

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



3561
3562
3563
# File 'lib/prism/node.rb', line 3561

def type
  :class_variable_operator_write_node
end