class Prism::IndexOperatorWriteNode

Represents the use of an assignment operator on a call to ‘[]`.

foo.bar[baz] += value
^^^^^^^^^^^^^^^^^^^^^

Attributes

arguments[R]

attr_reader arguments: ArgumentsNode?

block[R]

attr_reader block: Node?

call_operator_loc[R]

attr_reader call_operator_loc: Location?

closing_loc[R]

attr_reader closing_loc: Location

opening_loc[R]

attr_reader opening_loc: Location

operator[R]

attr_reader operator: Symbol

operator_loc[R]

attr_reader operator_loc: Location

receiver[R]

attr_reader receiver: Node?

value[R]

attr_reader value: Node

Public Class Methods

new(flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator, operator_loc, value, location) click to toggle source

def initialize: (flags: Integer, receiver: Node?, call_operator_loc: Location?, opening_loc: Location, arguments: ArgumentsNode?, closing_loc: Location, block: Node?, operator: Symbol, operator_loc: Location, value: Node, location: Location) -> void

# File lib/prism/node.rb, line 8476
def initialize(flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator, operator_loc, value, location)
  @flags = flags
  @receiver = receiver
  @call_operator_loc = call_operator_loc
  @opening_loc = opening_loc
  @arguments = arguments
  @closing_loc = closing_loc
  @block = block
  @operator = operator
  @operator_loc = operator_loc
  @value = value
  @location = location
end

type() click to toggle source

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

# File lib/prism/node.rb, line 8627
def self.type
  :index_operator_write_node
end

Public Instance Methods

accept(visitor) click to toggle source

def accept: (visitor: Visitor) -> void

# File lib/prism/node.rb, line 8491
def accept(visitor)
  visitor.visit_index_operator_write_node(self)
end

attribute_write?() click to toggle source

def attribute_write?: () -> bool

# File lib/prism/node.rb, line 8551
def attribute_write?
  flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
end

call_operator() click to toggle source

def call_operator: () -> String?

# File lib/prism/node.rb, line 8556
def call_operator
  call_operator_loc&.slice
end

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 8496
def child_nodes
  [receiver, arguments, block, value]
end

Also aliased as: deconstruct

closing() click to toggle source

def closing: () -> String

# File lib/prism/node.rb, line 8566
def closing
  closing_loc.slice
end

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 8511
def comment_targets
  [*receiver, *call_operator_loc, opening_loc, *arguments, closing_loc, *block, operator_loc, value]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 8501
def compact_child_nodes
  compact = []
  compact << receiver if receiver
  compact << arguments if arguments
  compact << block if block
  compact << value
  compact
end

copy(**params) click to toggle source

def copy: (**params) -> IndexOperatorWriteNode

# File lib/prism/node.rb, line 8516
def copy(**params)
  IndexOperatorWriteNode.new(
    params.fetch(:flags) { flags },
    params.fetch(:receiver) { receiver },
    params.fetch(:call_operator_loc) { call_operator_loc },
    params.fetch(:opening_loc) { opening_loc },
    params.fetch(:arguments) { arguments },
    params.fetch(:closing_loc) { closing_loc },
    params.fetch(:block) { block },
    params.fetch(:operator) { operator },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:value) { value },
    params.fetch(:location) { location },
  )
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

# File lib/prism/node.rb, line 8536
def deconstruct_keys(keys)
  { flags: flags, receiver: receiver, call_operator_loc: call_operator_loc, opening_loc: opening_loc, arguments: arguments, closing_loc: closing_loc, block: block, operator: operator, operator_loc: operator_loc, value: value, location: location }
end

inspect(inspector = NodeInspector.new) click to toggle source

def inspect(inspector: NodeInspector) -> String

# File lib/prism/node.rb, line 8571
def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?), ("attribute_write" if attribute_write?)].compact
  inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  if (receiver = self.receiver).nil?
    inspector << "├── receiver: ∅\n"
  else
    inspector << "├── receiver:\n"
    inspector << receiver.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── call_operator_loc: #{inspector.location(call_operator_loc)}\n"
  inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
  if (arguments = self.arguments).nil?
    inspector << "├── arguments: ∅\n"
  else
    inspector << "├── arguments:\n"
    inspector << arguments.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
  if (block = self.block).nil?
    inspector << "├── block: ∅\n"
  else
    inspector << "├── block:\n"
    inspector << block.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── operator: #{operator.inspect}\n"
  inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector << "└── value:\n"
  inspector << inspector.child_node(value, "    ")
  inspector.to_str
end

opening() click to toggle source

def opening: () -> String

# File lib/prism/node.rb, line 8561
def opening
  opening_loc.slice
end

safe_navigation?() click to toggle source

def safe_navigation?: () -> bool

# File lib/prism/node.rb, line 8541
def safe_navigation?
  flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end

type() click to toggle source

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

# File lib/prism/node.rb, line 8617
def type
  :index_operator_write_node
end

variable_call?() click to toggle source

def variable_call?: () -> bool

# File lib/prism/node.rb, line 8546
def variable_call?
  flags.anybits?(CallNodeFlags::VARIABLE_CALL)
end