Class: Prism::OrNode

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

Overview

Represents the use of the ‘||` operator or the `or` keyword.

left or right
^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(left, right, operator_loc, location) ⇒ OrNode

def initialize: (left: Node, right: Node, operator_loc: Location, location: Location) -> void



13069
13070
13071
13072
13073
13074
 
# File 'lib/prism/node.rb', line 13069

def initialize(left, right, operator_loc, location)
  @left = left
  @right = right
  @operator_loc = operator_loc
  @location = location
end

Instance Attribute Details

#left ⇒ Object (readonly)

attr_reader left: Node



13060
13061
13062
 
# File 'lib/prism/node.rb', line 13060

def left
  @left
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



13066
13067
13068
 
# File 'lib/prism/node.rb', line 13066

def operator_loc
  @operator_loc
end

#right ⇒ Object (readonly)

attr_reader right: Node



13063
13064
13065
 
# File 'lib/prism/node.rb', line 13063

def right
  @right
end

Class Method Details

.type ⇒ Object

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



13154
13155
13156
 
# File 'lib/prism/node.rb', line 13154

def self.type
  :or_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



13077
13078
13079
 
# File 'lib/prism/node.rb', line 13077

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

#child_nodes ⇒ Object Also known as: deconstruct

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



13082
13083
13084
 
# File 'lib/prism/node.rb', line 13082

def child_nodes
  [left, right]
end

#comment_targets ⇒ Object

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



13092
13093
13094
 
# File 'lib/prism/node.rb', line 13092

def comment_targets
  [left, right, operator_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



13087
13088
13089
 
# File 'lib/prism/node.rb', line 13087

def compact_child_nodes
  [left, right]
end

#copy(**params) ⇒ Object

def copy: (**params) -> OrNode



13097
13098
13099
13100
13101
13102
13103
13104
 
# File 'lib/prism/node.rb', line 13097

def copy(**params)
  OrNode.new(
    params.fetch(:left) { left },
    params.fetch(:right) { right },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



13110
13111
13112
 
# File 'lib/prism/node.rb', line 13110

def deconstruct_keys(keys)
  { left: left, right: right, operator_loc: operator_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



13120
13121
13122
13123
13124
13125
13126
13127
13128
 
# File 'lib/prism/node.rb', line 13120

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── left:\n"
  inspector << inspector.child_node(left, "│   ")
  inspector << "├── right:\n"
  inspector << inspector.child_node(right, "│   ")
  inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector.to_str
end

#operator ⇒ Object

def operator: () -> String



13115
13116
13117
 
# File 'lib/prism/node.rb', line 13115

def operator
  operator_loc.slice
end

#type ⇒ Object

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



13144
13145
13146
 
# File 'lib/prism/node.rb', line 13144

def type
  :or_node
end