Class: Prism::IfNode

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

Overview

Represents the use of the if keyword, either in the block form or the modifier form, or a ternary expression.

bar if foo
^^^^^^^^^^

if foo then bar end
^^^^^^^^^^^^^^^^^^^

foo ? bar : baz
^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, if_keyword_loc, predicate, then_keyword_loc, statements, subsequent, end_keyword_loc) ⇒ IfNode

Initialize a new IfNode node.



9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
 
# File 'lib/prism/node.rb', line 9089

def initialize(source, node_id, location, flags, if_keyword_loc, predicate, then_keyword_loc, statements, subsequent, end_keyword_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @if_keyword_loc = if_keyword_loc
  @predicate = predicate
  @then_keyword_loc = then_keyword_loc
  @statements = statements
  @subsequent = subsequent
  @end_keyword_loc = end_keyword_loc
end

Instance Attribute Details

#predicate ⇒ Object (readonly)

The node for the condition the IfNode is testing.

if foo
   ^^^
  bar
end

bar if foo
       ^^^

foo ? bar : baz
^^^



9184
9185
9186
 
# File 'lib/prism/node.rb', line 9184

def predicate
  @predicate
end

#statements ⇒ Object (readonly)

Represents the body of statements that will be executed when the predicate is evaluated as truthy. Will be nil when no body is provided.

if foo
  bar
  ^^^
  baz
  ^^^
end



9219
9220
9221
 
# File 'lib/prism/node.rb', line 9219

def statements
  @statements
end

#subsequent ⇒ Object (readonly)

Represents an ElseNode or an IfNode when there is an else or an elsif in the if statement.

if foo
  bar
elsif baz
^^^^^^^^^
  qux
  ^^^
end
^^^

if foo then bar else baz end
                ^^^^^^^^^^^^



9234
9235
9236
 
# File 'lib/prism/node.rb', line 9234

def subsequent
  @subsequent
end

Class Method Details

.type ⇒ Object

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



9286
9287
9288
 
# File 'lib/prism/node.rb', line 9286

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



9292
9293
9294
9295
9296
9297
9298
9299
9300
 
# File 'lib/prism/node.rb', line 9292

def ===(other)
  other.is_a?(IfNode) &&
    (if_keyword_loc.nil? == other.if_keyword_loc.nil?) &&
    (predicate === other.predicate) &&
    (then_keyword_loc.nil? == other.then_keyword_loc.nil?) &&
    (statements === other.statements) &&
    (subsequent === other.subsequent) &&
    (end_keyword_loc.nil? == other.end_keyword_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



9103
9104
9105
 
# File 'lib/prism/node.rb', line 9103

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



9108
9109
9110
 
# File 'lib/prism/node.rb', line 9108

def child_nodes
  [predicate, statements, subsequent]
end

#comment_targets ⇒ Object

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



9131
9132
9133
 
# File 'lib/prism/node.rb', line 9131

def comment_targets
  [*if_keyword_loc, predicate, *then_keyword_loc, *statements, *subsequent, *end_keyword_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



9122
9123
9124
9125
9126
9127
9128
 
# File 'lib/prism/node.rb', line 9122

def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << predicate
  compact << statements if statements
  compact << subsequent if subsequent
  compact
end

#consequent ⇒ Object

Returns the subsequent if/elsif/else clause of the if node. This method is deprecated in favor of #subsequent.



488
489
490
491
 
# File 'lib/prism/node_ext.rb', line 488

def consequent
  deprecated("subsequent")
  subsequent
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, if_keyword_loc: self.if_keyword_loc, predicate: self.predicate, then_keyword_loc: self.then_keyword_loc, statements: self.statements, subsequent: self.subsequent, end_keyword_loc: self.end_keyword_loc) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?if_keyword_loc: Location?, ?predicate: Prism::node, ?then_keyword_loc: Location?, ?statements: StatementsNode?, ?subsequent: ElseNode | IfNode | nil, ?end_keyword_loc: Location?) -> IfNode



9136
9137
9138
 
# File 'lib/prism/node.rb', line 9136

def copy(node_id: self.node_id, location: self.location, flags: self.flags, if_keyword_loc: self.if_keyword_loc, predicate: self.predicate, then_keyword_loc: self.then_keyword_loc, statements: self.statements, subsequent: self.subsequent, end_keyword_loc: self.end_keyword_loc)
  IfNode.new(source, node_id, location, flags, if_keyword_loc, predicate, then_keyword_loc, statements, subsequent, end_keyword_loc)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, if_keyword_loc: Location?, predicate: Prism::node, then_keyword_loc: Location?, statements: StatementsNode?, subsequent: ElseNode | IfNode | nil, end_keyword_loc: Location? }



9144
9145
9146
 
# File 'lib/prism/node.rb', line 9144

def deconstruct_keys(keys)
  { node_id: node_id, location: location, if_keyword_loc: if_keyword_loc, predicate: predicate, then_keyword_loc: then_keyword_loc, statements: statements, subsequent: subsequent, end_keyword_loc: end_keyword_loc }
end

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

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

Yields:



9113
9114
9115
9116
9117
9118
9119
 
# File 'lib/prism/node.rb', line 9113

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield predicate
  yield statements if statements
  yield subsequent if subsequent
end

#end_keyword ⇒ Object

def end_keyword: () -> String?



9271
9272
9273
 
# File 'lib/prism/node.rb', line 9271

def end_keyword
  end_keyword_loc&.slice
end

#end_keyword_loc ⇒ Object

The location of the end keyword if present, nil otherwise.

if foo
  bar
end
^^^



9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
 
# File 'lib/prism/node.rb', line 9242

def end_keyword_loc
  location = @end_keyword_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @end_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#if_keyword ⇒ Object

def if_keyword: () -> String?



9261
9262
9263
 
# File 'lib/prism/node.rb', line 9261

def if_keyword
  if_keyword_loc&.slice
end

#if_keyword_loc ⇒ Object

The location of the if keyword if present.

bar if foo
    ^^

The if_keyword_loc field will be nil when the IfNode represents a ternary expression.



9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
 
# File 'lib/prism/node.rb', line 9154

def if_keyword_loc
  location = @if_keyword_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @if_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#inspect ⇒ Object

def inspect -> String



9276
9277
9278
 
# File 'lib/prism/node.rb', line 9276

def inspect
  InspectVisitor.compose(self)
end

#newline_flag!(lines) ⇒ Object

:nodoc:



92
93
94
 
# File 'lib/prism/parse_result/newlines.rb', line 92

def newline_flag!(lines) # :nodoc:
  predicate.newline_flag!(lines)
end

#save_end_keyword_loc(repository) ⇒ Object

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



9256
9257
9258
 
# File 'lib/prism/node.rb', line 9256

def save_end_keyword_loc(repository)
  repository.enter(node_id, :end_keyword_loc) unless @end_keyword_loc.nil?
end

#save_if_keyword_loc(repository) ⇒ Object

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



9168
9169
9170
 
# File 'lib/prism/node.rb', line 9168

def save_if_keyword_loc(repository)
  repository.enter(node_id, :if_keyword_loc) unless @if_keyword_loc.nil?
end

#save_then_keyword_loc(repository) ⇒ Object

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



9207
9208
9209
 
# File 'lib/prism/node.rb', line 9207

def save_then_keyword_loc(repository)
  repository.enter(node_id, :then_keyword_loc) unless @then_keyword_loc.nil?
end

#then_keyword ⇒ Object

def then_keyword: () -> String?



9266
9267
9268
 
# File 'lib/prism/node.rb', line 9266

def then_keyword
  then_keyword_loc&.slice
end

#then_keyword_loc ⇒ Object

The location of the then keyword (if present) or the ‘?` in a ternary expression, nil otherwise.

if foo then bar end
       ^^^^

a ? b : c
  ^



9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
 
# File 'lib/prism/node.rb', line 9193

def then_keyword_loc
  location = @then_keyword_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @then_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#type ⇒ Object

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



9281
9282
9283
 
# File 'lib/prism/node.rb', line 9281

def type
  :if_node
end