class Ruby::Prism::ConstantWriteNode

Represents writing to a constant.

Foo = 1
^^^^^^^

Public Class Methods

new (source, node_id, location, flags, name, name_loc, value, operator_loc)

(Source source, Integer node_id, Location location, Integer flags, Symbol name, Location name_loc, Ruby::Prism::node value, Location operator_loc) → void

Source

# File lib/ruby/prism/node.rb, line 10172
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

Initialize a new ConstantWriteNode node.

Public Instance Methods

full_name ()

() → String

Source

# File lib/ruby/prism/node_ext.rb, line 210
def full_name
  name.to_s
end

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

full_name_parts ()

() → Array[Symbol]

Source

# File lib/ruby/prism/node_ext.rb, line 203
def full_name_parts
  [name]
end

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

name → Symbol

() → Symbol

Source

# File lib/ruby/prism/node.rb, line 10292
def name
  @name
end

The name of the constant.

Foo = :bar # name `:Foo`

XYZ = 1    # name `:XYZ`

value → Node

() → Ruby::Prism::node

Source

# File lib/ruby/prism/node.rb, line 10333
def value
  @value
end

The value to write to the constant. It can be any non-void expression.

FOO = :bar
      ^^^^

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

Locations

Public Instance Methods

name_loc → Location

() → Location

Source

# File lib/ruby/prism/node.rb, line 10306
def name_loc
  location = @name_loc
  return location if location.is_a?(Location)
  @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

The Location of the constant name.

FOO = 1
^^^

operator_loc → Location

() → Location

Source

# File lib/ruby/prism/node.rb, line 10347
def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

The Location of the = operator.

FOO = :bar
    ^

Node Interface

These methods are present on all subclasses of Node. Read the node interface docs for more information.

Public Class Methods

type ()

() → :constant_write_node

Source

# File lib/ruby/prism/node.rb, line 10271
def self.type
  :constant_write_node
end

See Node.type.

Public Instance Methods

accept (visitor)

(_Visitor visitor) → untyped

Source

# File lib/ruby/prism/node.rb, line 10197
def accept(visitor)
  visitor.visit_constant_write_node(self)
end

See Node.accept.

child_nodes ()

() → Array[node?]

Source

# File lib/ruby/prism/node.rb, line 10204
def child_nodes
  [value]
end

See Node.child_nodes.

Also aliased as: deconstruct

comment_targets ()

() → Array[node | Location]

Source

# File lib/ruby/prism/node.rb, line 10228
def comment_targets
  [name_loc, value, operator_loc] #: Array[Ruby::Prism::node | Location]
end

See Node.comment_targets.

compact_child_nodes ()

() → Array[node]

Source

# File lib/ruby/prism/node.rb, line 10221
def compact_child_nodes
  [value]
end

See Node.compact_child_nodes.

copy(**fields) → ConstantWriteNode

(?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol, ?name_loc: Location, ?value: Ruby::Prism::node, ?operator_loc: Location) → ConstantWriteNode

Source

# File lib/ruby/prism/node.rb, line 10238
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

Creates a copy of self with the given fields, using self as the template.

deconstruct ()

() → Array[node?]

Alias for: child_nodes

each_child_node () { |value| ... }

() → Enumerator[node, void]
() { (node) → void } → void

Source

# File lib/ruby/prism/node.rb, line 10212
def each_child_node(&blk)
  return to_enum(:each_child_node) unless block_given?

  yield value
end

See Node.each_child_node.

type ()

() → :constant_write_node

Source

# File lib/ruby/prism/node.rb, line 10264
def type
  :constant_write_node
end

See Node#type.

Repository

Methods related to Relocation.

Public Instance Methods

save_name_loc (repository)

(_Repository repository) → Relocation::Entry

Source

# File lib/ruby/prism/node.rb, line 10317
def save_name_loc(repository)
  repository.enter(node_id, :name_loc)
end

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

save_operator_loc (repository)

(_Repository repository) → Relocation::Entry

Source

# File lib/ruby/prism/node.rb, line 10358
def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end

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

Slicing

Public Instance Methods

operator → String

() → String

Source

# File lib/ruby/prism/node.rb, line 10370
def operator
  operator_loc.slice
end

Slice the location of operator_loc from the source.