Class: Prism::AssocNode

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

Overview

Represents a hash key/value pair.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, key, value, operator_loc) ⇒ AssocNode

Initialize a new AssocNode node.



1266
1267
1268
1269
1270
1271
1272
1273
1274
 
# File 'lib/prism/node.rb', line 1266

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

Instance Attribute Details

#key ⇒ Object (readonly)

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 }
  ^^^^^^^^^^



1327
1328
1329
 
# File 'lib/prism/node.rb', line 1327

def key
  @key
end

#value ⇒ Object (readonly)

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 }
     ^



1336
1337
1338
 
# File 'lib/prism/node.rb', line 1336

def value
  @value
end

Class Method Details

.type ⇒ Object

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



1376
1377
1378
 
# File 'lib/prism/node.rb', line 1376

def self.type
  :assoc_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.



1382
1383
1384
1385
1386
1387
 
# File 'lib/prism/node.rb', line 1382

def ===(other)
  other.is_a?(AssocNode) &&
    (key === other.key) &&
    (value === other.value) &&
    (operator_loc.nil? == other.operator_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



1277
1278
1279
 
# File 'lib/prism/node.rb', line 1277

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



1282
1283
1284
 
# File 'lib/prism/node.rb', line 1282

def child_nodes
  [key, value]
end

#comment_targets ⇒ Object

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



1300
1301
1302
 
# File 'lib/prism/node.rb', line 1300

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



1295
1296
1297
 
# File 'lib/prism/node.rb', line 1295

def compact_child_nodes
  [key, value]
end

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

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



1305
1306
1307
 
# File 'lib/prism/node.rb', line 1305

def copy(node_id: self.node_id, location: self.location, flags: self.flags, key: self.key, value: self.value, operator_loc: self.operator_loc)
  AssocNode.new(source, node_id, location, flags, key, value, operator_loc)
end

#deconstruct_keys(keys) ⇒ Object

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



1313
1314
1315
 
# File 'lib/prism/node.rb', line 1313

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

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

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

Yields:



1287
1288
1289
1290
1291
1292
 
# File 'lib/prism/node.rb', line 1287

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield key
  yield value
end

#inspect ⇒ Object

def inspect -> String



1366
1367
1368
 
# File 'lib/prism/node.rb', line 1366

def inspect
  InspectVisitor.compose(self)
end

#operator ⇒ Object

def operator: () -> String?



1361
1362
1363
 
# File 'lib/prism/node.rb', line 1361

def operator
  operator_loc&.slice
end

#operator_loc ⇒ Object

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

{ foo => bar }
      ^^



1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/prism/node.rb', line 1342

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

#save_operator_loc(repository) ⇒ Object

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



1356
1357
1358
 
# File 'lib/prism/node.rb', line 1356

def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc) unless @operator_loc.nil?
end

#type ⇒ Object

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



1371
1372
1373
 
# File 'lib/prism/node.rb', line 1371

def type
  :assoc_node
end