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.


1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/prism/node.rb', line 1025

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


1078
1079
1080
 
# File 'lib/prism/node.rb', line 1078

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


1087
1088
1089
 
# File 'lib/prism/node.rb', line 1087

def value
  @value
end

Class Method Details

.type ⇒ Object

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


1121
1122
1123
 
# File 'lib/prism/node.rb', line 1121

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.


1127
1128
1129
1130
1131
1132
 
# File 'lib/prism/node.rb', line 1127

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


1036
1037
1038
 
# File 'lib/prism/node.rb', line 1036

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

#child_nodes ⇒ Object Also known as: deconstruct

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


1041
1042
1043
 
# File 'lib/prism/node.rb', line 1041

def child_nodes
  [key, value]
end

#comment_targets ⇒ Object

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


1051
1052
1053
 
# File 'lib/prism/node.rb', line 1051

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array


1046
1047
1048
 
# File 'lib/prism/node.rb', line 1046

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


1056
1057
1058
 
# File 'lib/prism/node.rb', line 1056

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


1064
1065
1066
 
# File 'lib/prism/node.rb', line 1064

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

#inspect ⇒ Object

def inspect -> String


1111
1112
1113
 
# File 'lib/prism/node.rb', line 1111

def inspect
  InspectVisitor.compose(self)
end

#operator ⇒ Object

def operator: () -> String?


1106
1107
1108
 
# File 'lib/prism/node.rb', line 1106

def operator
  operator_loc&.slice
end

#operator_loc ⇒ Object

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

{ foo => bar }
      ^^


1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
 
# File 'lib/prism/node.rb', line 1093

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 ⇒ Object

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


1116
1117
1118
 
# File 'lib/prism/node.rb', line 1116

def type
  :assoc_node
end