class Prism::AssocNode

Represents a hash key/value pair.

{ a => b }
  ^^^^^^

Attributes

key[R]

The key of the association. This can be any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

{ a: b }
  ^

{ foo => bar }
  ^^^

{ def a; end => 1 }
  ^^^^^^^^^^

value[R]

The value of the association, if present. This can be any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

{ foo => bar }
         ^^^

{ x: 1 }
     ^

Public Class Methods

new(source, key, value, operator_loc, location) click to toggle source

def initialize: (Prism::node key, Prism::node value, Location? operator_loc, Location location) -> void

# File lib/prism/node.rb, line 1022
def initialize(source, key, value, operator_loc, location)
  @source = source
  @newline = false
  @location = location
  @key = key
  @value = value
  @operator_loc = operator_loc
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 1135
def self.type
  :assoc_node
end

Public Instance Methods

===(other) click to toggle source

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

# File lib/prism/node.rb, line 1141
def ===(other)
  other.is_a?(AssocNode) &&
    (key === other.key) &&
    (value === other.value) &&
    (operator_loc.nil? == other.operator_loc.nil?)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

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

child_nodes() click to toggle source

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

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

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 1047
def comment_targets
  [key, value, *operator_loc] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

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

copy(key: self.key, value: self.value, operator_loc: self.operator_loc, location: self.location) click to toggle source

def copy: (?key: Prism::node, ?value: Prism::node, ?operator_loc: Location?, ?location: Location) -> AssocNode

# File lib/prism/node.rb, line 1052
def copy(key: self.key, value: self.value, operator_loc: self.operator_loc, location: self.location)
  AssocNode.new(source, key, value, operator_loc, location)
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { key: Prism::node, value: Prism::node, operator_loc: Location?, location: Location }

# File lib/prism/node.rb, line 1060
def deconstruct_keys(keys)
  { key: key, value: value, operator_loc: operator_loc, location: location }
end

inspect() click to toggle source

def inspect -> String

# File lib/prism/node.rb, line 1107
def inspect
  InspectVisitor.compose(self)
end

operator() click to toggle source

def operator: () -> String?

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

operator_loc() click to toggle source

The location of the ‘=>` operator, if present.

{ foo => bar }
      ^^

# File lib/prism/node.rb, line 1089
def operator_loc
  location = @operator_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
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 1125
def type
  :assoc_node
end