Class: Prism::ConstantWriteNode

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

Overview

Represents writing to a constant.

Foo = 1
^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Initialize a new ConstantWriteNode node.



6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
 
# File 'lib/prism/node.rb', line 6158

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

Instance Attribute Details

#name ⇒ Object (readonly)

The name of the [constant](github.com/ruby/prism/blob/main/docs/parsing_rules.md#constants).

Foo = :bar # name `:Foo`

XYZ = 1    # name `:XYZ`



6214
6215
6216
 
# File 'lib/prism/node.rb', line 6214

def name
  @name
end

#value ⇒ Object (readonly)

The value to write to the constant. It can be any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

FOO = :bar
      ^^^^

MyClass = Class.new
          ^^^^^^^^^



6239
6240
6241
 
# File 'lib/prism/node.rb', line 6239

def value
  @value
end

Class Method Details

.type ⇒ Object

Return a symbol representation of this node type. See Node::type.



6273
6274
6275
 
# File 'lib/prism/node.rb', line 6273

def self.type
  :constant_write_node
end

Instance Method Details

#===(other) ⇒ Object

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.



6279
6280
6281
6282
6283
6284
6285
 
# File 'lib/prism/node.rb', line 6279

def ===(other)
  other.is_a?(ConstantWriteNode) &&
    (name === other.name) &&
    (name_loc.nil? == other.name_loc.nil?) &&
    (value === other.value) &&
    (operator_loc.nil? == other.operator_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



6170
6171
6172
 
# File 'lib/prism/node.rb', line 6170

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



6175
6176
6177
 
# File 'lib/prism/node.rb', line 6175

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



6192
6193
6194
 
# File 'lib/prism/node.rb', line 6192

def comment_targets
  [name_loc, value, operator_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



6187
6188
6189
 
# File 'lib/prism/node.rb', line 6187

def compact_child_nodes
  [value]
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol, ?name_loc: Location, ?value: Prism::node, ?operator_loc: Location) -> ConstantWriteNode



6197
6198
6199
 
# File 'lib/prism/node.rb', line 6197

def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc)
  ConstantWriteNode.new(source, node_id, location, flags, name, name_loc, value, operator_loc)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, name: Symbol, name_loc: Location, value: Prism::node, operator_loc: Location }



6205
6206
6207
 
# File 'lib/prism/node.rb', line 6205

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

#each_child_node {|value| ... } ⇒ Object

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator

Yields:



6180
6181
6182
6183
6184
 
# File 'lib/prism/node.rb', line 6180

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield value
end

#full_name ⇒ Object

Returns the full name of this constant. For example: “Foo”



155
156
157
 
# File 'lib/prism/node_ext.rb', line 155

def full_name
  name.to_s
end

#full_name_parts ⇒ Object

Returns the list of parts for the full name of this constant. For example: [:Foo]



150
151
152
 
# File 'lib/prism/node_ext.rb', line 150

def full_name_parts
  [name]
end

#inspect ⇒ Object

def inspect -> String



6263
6264
6265
 
# File 'lib/prism/node.rb', line 6263

def inspect
  InspectVisitor.compose(self)
end

#name_loc ⇒ Object

The location of the constant name.

FOO = 1
^^^



6220
6221
6222
6223
6224
 
# File 'lib/prism/node.rb', line 6220

def name_loc
  location = @name_loc
  return location if location.is_a?(Location)
  @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#operator ⇒ Object

def operator: () -> String



6258
6259
6260
 
# File 'lib/prism/node.rb', line 6258

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the ‘=` operator.

FOO = :bar
    ^



6245
6246
6247
6248
6249
 
# File 'lib/prism/node.rb', line 6245

def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#save_name_loc(repository) ⇒ Object

Save the name_loc location using the given saved source so that it can be retrieved later.



6228
6229
6230
 
# File 'lib/prism/node.rb', line 6228

def save_name_loc(repository)
  repository.enter(node_id, :name_loc)
end

#save_operator_loc(repository) ⇒ Object

Save the operator_loc location using the given saved source so that it can be retrieved later.



6253
6254
6255
 
# File 'lib/prism/node.rb', line 6253

def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end

#type ⇒ Object

Return a symbol representation of this node type. See ‘Node#type`.



6268
6269
6270
 
# File 'lib/prism/node.rb', line 6268

def type
  :constant_write_node
end