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.



1183
1184
1185
1186
1187
1188
1189
1190
1191
 
# File 'lib/prism/node.rb', line 1183

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



1236
1237
1238
 
# File 'lib/prism/node.rb', line 1236

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



1245
1246
1247
 
# File 'lib/prism/node.rb', line 1245

def value
  @value
end

Class Method Details

.type ⇒ Object

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



1285
1286
1287
 
# File 'lib/prism/node.rb', line 1285

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.



1291
1292
1293
1294
1295
1296
 
# File 'lib/prism/node.rb', line 1291

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



1194
1195
1196
 
# File 'lib/prism/node.rb', line 1194

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

#child_nodes ⇒ Object Also known as: deconstruct

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



1199
1200
1201
 
# File 'lib/prism/node.rb', line 1199

def child_nodes
  [key, value]
end

#comment_targets ⇒ Object

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



1209
1210
1211
 
# File 'lib/prism/node.rb', line 1209

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



1204
1205
1206
 
# File 'lib/prism/node.rb', line 1204

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



1214
1215
1216
 
# File 'lib/prism/node.rb', line 1214

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



1222
1223
1224
 
# File 'lib/prism/node.rb', line 1222

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

#inspect ⇒ Object

def inspect -> String



1275
1276
1277
 
# File 'lib/prism/node.rb', line 1275

def inspect
  InspectVisitor.compose(self)
end

#operator ⇒ Object

def operator: () -> String?



1270
1271
1272
 
# File 'lib/prism/node.rb', line 1270

def operator
  operator_loc&.slice
end

#operator_loc ⇒ Object

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

{ foo => bar }
      ^^



1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
 
# File 'lib/prism/node.rb', line 1251

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.



1265
1266
1267
 
# File 'lib/prism/node.rb', line 1265

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`.



1280
1281
1282
 
# File 'lib/prism/node.rb', line 1280

def type
  :assoc_node
end