123456789_123456789_123456789_123456789_123456789_

Class: Prism::IfNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PrismNode
Instance Chain:
self, PrismNode
Inherits: PrismNode
Defined in: lib/prism/node.rb,
ext/prism/api_node.c,
lib/prism/node_ext.rb,
lib/prism/parse_result/newlines.rb

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

Class Method Summary

Instance Attribute Summary

  • #consequent readonly

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

  • #predicate readonly

    The node for the condition the IfNode is testing.

  • #statements readonly

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

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, if_keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc) ⇒ IfNode

Initialize a new IfNode node.

[ GitHub ] 

  


# File 'lib/prism/node.rb', line 7306



def initialize(source, node_id, location, flags, if_keyword_loc, predicate, then_keyword_loc, statements, consequent, 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
  @consequent = consequent
  @end_keyword_loc = end_keyword_loc
end


  







Class Method Details



  

    .type  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7473



def self.type
  :if_node
end


  







Instance Attribute Details



  

    #consequent   (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
                ^^^^^^^^^^^^

  



  [ GitHub ]


  

  


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



attr_reader :consequent


  








  

    #predicate   (readonly)
  



  

    
The node for the condition the IfNode is testing.


if foo
   ^^^
  bar
end

bar if foo
       ^^^

foo ? bar : baz
^^^

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7386



attr_reader :predicate


  








  

    #statements   (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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7414



attr_reader :statements


  







Instance Method Details



  

    #===(other)  
  



  

    
Implements case-equality for the node. This is effectively == but without
comparing the value of locations. Locations are checked only for presence.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7479



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) &&
    (consequent === other.consequent) &&
    (end_keyword_loc.nil? == other.end_keyword_loc.nil?)
end


  








  

    #accept(visitor)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7320



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7325



def child_nodes
  [predicate, statements, consequent]
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7339



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


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7330



def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << predicate
  compact << statements if statements
  compact << consequent if consequent
  compact
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, consequent: self.consequent, end_keyword_loc: self.end_keyword_loc)  
  



  

    
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?if_keyword_loc: Location?, ?predicate: Prism.node, ?then_keyword_loc: Location?, ?statements: StatementsNode?, ?consequent: Prism.node?, ?end_keyword_loc: Location?) -> IfNode

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7344



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, consequent: self.consequent, end_keyword_loc: self.end_keyword_loc)
  IfNode.new(source, node_id, location, flags, if_keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc)
end


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7349



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, if_keyword_loc: Location?, predicate: Prism.node, then_keyword_loc: Location?, statements: StatementsNode?, consequent: Prism.node?, end_keyword_loc: Location? }

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7352



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, consequent: consequent, end_keyword_loc: end_keyword_loc }
end


  








  

    #end_keyword  
  



  

    
def end_keyword: () -> String?

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7458



def end_keyword
  end_keyword_loc&.slice
end


  








  

    #end_keyword_loc  
  



  

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


if foo
  bar
end
^^^

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7435



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  
  



  

    
def if_keyword: () -> String?

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7448



def if_keyword
  if_keyword_loc&.slice
end


  








  

    #if_keyword_loc  
  



  

    
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.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7362



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  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7463



def inspect
  InspectVisitor.compose(self)
end


  








  

    #newline_flag!(lines)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



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


  








  

    #then_keyword  
  



  

    
def then_keyword: () -> String?

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7453



def then_keyword
  then_keyword_loc&.slice
end


  








  

    #then_keyword_loc  
  



  

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


if foo then bar end
       ^^^^

a ? b : c
  ^

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7394



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  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 7468



def type
  :if_node
end