class Prism::CallOrWriteNode

Represents the use of the ‘||=` operator on a call.

foo.bar ||= value
^^^^^^^^^^^^^^^^^

Attributes

call_operator_loc[R]

attr_reader call_operator_loc: Location?

message_loc[R]

attr_reader message_loc: Location?

operator_loc[R]

attr_reader operator_loc: Location

read_name[R]

attr_reader read_name: Symbol

receiver[R]

attr_reader receiver: Node?

value[R]

attr_reader value: Node

write_name[R]

attr_reader write_name: Symbol

Public Class Methods

new(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value, location) click to toggle source

def initialize: (flags: Integer, receiver: Node?, call_operator_loc: Location?, message_loc: Location?, read_name: Symbol, write_name: Symbol, operator_loc: Location, value: Node, location: Location) -> void

# File lib/prism/node.rb, line 2537
def initialize(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value, location)
  @flags = flags
  @receiver = receiver
  @call_operator_loc = call_operator_loc
  @message_loc = message_loc
  @read_name = read_name
  @write_name = write_name
  @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 2670
def self.type
  :call_or_write_node
end

Public Instance Methods

accept(visitor) click to toggle source

def accept: (visitor: Visitor) -> void

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

attribute_write?() click to toggle source

def attribute_write?: () -> bool

# File lib/prism/node.rb, line 2606
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 2611
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 2555
def child_nodes
  [receiver, value]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 2568
def comment_targets
  [*receiver, *call_operator_loc, *message_loc, operator_loc, value]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

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

copy(**params) click to toggle source

def copy: (**params) -> CallOrWriteNode

# File lib/prism/node.rb, line 2573
def copy(**params)
  CallOrWriteNode.new(
    params.fetch(:flags) { flags },
    params.fetch(:receiver) { receiver },
    params.fetch(:call_operator_loc) { call_operator_loc },
    params.fetch(:message_loc) { message_loc },
    params.fetch(:read_name) { read_name },
    params.fetch(:write_name) { write_name },
    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 2591
def deconstruct_keys(keys)
  { flags: flags, receiver: receiver, call_operator_loc: call_operator_loc, message_loc: message_loc, read_name: read_name, write_name: write_name, 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 2626
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 << "├── message_loc: #{inspector.location(message_loc)}\n"
  inspector << "├── read_name: #{read_name.inspect}\n"
  inspector << "├── write_name: #{write_name.inspect}\n"
  inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector << "└── value:\n"
  inspector << inspector.child_node(value, "    ")
  inspector.to_str
end

message() click to toggle source

def message: () -> String?

# File lib/prism/node.rb, line 2616
def message
  message_loc&.slice
end

operator() click to toggle source

def operator: () -> String

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

safe_navigation?() click to toggle source

def safe_navigation?: () -> bool

# File lib/prism/node.rb, line 2596
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 2660
def type
  :call_or_write_node
end

variable_call?() click to toggle source

def variable_call?: () -> bool

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