Class: Prism::InstanceVariableOrWriteNode

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 an instance variable.

@target ||= value
^^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, name_loc, operator_loc, value, location) ⇒ InstanceVariableOrWriteNode

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



7366
7367
7368
7369
7370
7371
7372
 
# File 'lib/prism/node.rb', line 7366

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

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



7354
7355
7356
 
# File 'lib/prism/node.rb', line 7354

def name
  @name
end

#name_loc ⇒ Object (readonly)

attr_reader name_loc: Location



7357
7358
7359
 
# File 'lib/prism/node.rb', line 7357

def name_loc
  @name_loc
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



7360
7361
7362
 
# File 'lib/prism/node.rb', line 7360

def operator_loc
  @operator_loc
end

#value ⇒ Object (readonly)

attr_reader value: Node



7363
7364
7365
 
# File 'lib/prism/node.rb', line 7363

def value
  @value
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



7375
7376
7377
 
# File 'lib/prism/node.rb', line 7375

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

#child_nodes ⇒ Object Also known as: deconstruct

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



7380
7381
7382
 
# File 'lib/prism/node.rb', line 7380

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



7390
7391
7392
 
# File 'lib/prism/node.rb', line 7390

def comment_targets
  [name_loc, operator_loc, value]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



7385
7386
7387
 
# File 'lib/prism/node.rb', line 7385

def compact_child_nodes
  [value]
end

#copy(**params) ⇒ Object

def copy: (**params) -> InstanceVariableOrWriteNode



7395
7396
7397
7398
7399
7400
7401
7402
7403
 
# File 'lib/prism/node.rb', line 7395

def copy(**params)
  InstanceVariableOrWriteNode.new(
    params.fetch(:name) { name },
    params.fetch(:name_loc) { name_loc },
    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]



7409
7410
7411
 
# File 'lib/prism/node.rb', line 7409

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

#inspect(inspector = NodeInspector.new) ⇒ Object 



7418
7419
7420
7421
7422
7423
7424
7425
7426
 
# File 'lib/prism/node.rb', line 7418

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.to_str
end

#operator ⇒ Object

def operator: () -> String



7414
7415
7416
 
# File 'lib/prism/node.rb', line 7414

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



7442
7443
7444
 
# File 'lib/prism/node.rb', line 7442

def type
  :instance_variable_or_write_node
end