Class: Prism::ConstantWriteNode

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

Overview

Represents writing to a constant.

Foo = 1
^^^^^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

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



4443
4444
4445
4446
4447
4448
4449
 
# File 'lib/prism/node.rb', line 4443

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

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



4431
4432
4433
 
# File 'lib/prism/node.rb', line 4431

def name
  @name
end

#name_loc ⇒ Object (readonly)

attr_reader name_loc: Location



4434
4435
4436
 
# File 'lib/prism/node.rb', line 4434

def name_loc
  @name_loc
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



4440
4441
4442
 
# File 'lib/prism/node.rb', line 4440

def operator_loc
  @operator_loc
end

#value ⇒ Object (readonly)

attr_reader value: Node



4437
4438
4439
 
# File 'lib/prism/node.rb', line 4437

def value
  @value
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



4452
4453
4454
 
# File 'lib/prism/node.rb', line 4452

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

#child_nodes ⇒ Object Also known as: deconstruct

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



4457
4458
4459
 
# File 'lib/prism/node.rb', line 4457

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



4467
4468
4469
 
# File 'lib/prism/node.rb', line 4467

def comment_targets
  [name_loc, value, operator_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



4462
4463
4464
 
# File 'lib/prism/node.rb', line 4462

def compact_child_nodes
  [value]
end

#copy(**params) ⇒ Object

def copy: (**params) -> ConstantWriteNode



4472
4473
4474
4475
4476
4477
4478
4479
4480
 
# File 'lib/prism/node.rb', line 4472

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

#deconstruct_keys(keys) ⇒ Object

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



4486
4487
4488
 
# File 'lib/prism/node.rb', line 4486

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

#inspect(inspector = NodeInspector.new) ⇒ Object 



4495
4496
4497
4498
4499
4500
4501
4502
4503
 
# File 'lib/prism/node.rb', line 4495

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

#operator ⇒ Object

def operator: () -> String



4491
4492
4493
 
# File 'lib/prism/node.rb', line 4491

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



4519
4520
4521
 
# File 'lib/prism/node.rb', line 4519

def type
  :constant_write_node
end