class Prism::IfNode - prism: Ruby Standard Library Documentation

# class Prism::IfNode

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

### Attributes

predicate[R]

The node for the condition the ‘IfNode` is testing.

    if foo
       ^^^
      bar
    end

    bar if foo
           ^^^

    foo ? bar : baz
    ^^^

statements[R]

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

subsequent[R]

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

### Public Class Methods

new(source, node_id, location, flags, if_keyword_loc, predicate, then_keyword_loc, statements, subsequent, end_keyword_loc) click to toggle source

Initialize a new `IfNode` node.

    # File prism/node.rb, line 8447
    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

type() click to toggle source

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

    # File prism/node.rb, line 8635
    def self.type
      :if_node
    end

### Public Instance Methods

===(other) click to toggle source

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

    # File prism/node.rb, line 8641
    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) click to toggle source

def accept: (`Visitor` visitor) -> void

    # File prism/node.rb, line 8461
    def accept(visitor)
      visitor.visit_if_node(self)
    end

child_nodes() click to toggle source

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

    # File prism/node.rb, line 8466
    def child_nodes
      [predicate, statements, subsequent]
    end

Also aliased as: deconstruct
comment_targets() click to toggle source

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

    # File prism/node.rb, line 8480
    def comment_targets
      [*if_keyword_loc, predicate, *then_keyword_loc, *statements, *subsequent, *end_keyword_loc] #: Array[Prism::node | Location]
    end

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

    # File prism/node.rb, line 8471
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      compact << predicate
      compact << statements if statements
      compact << subsequent if subsequent
      compact
    end

consequent() click to toggle source

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

    # File prism/node_ext.rb, line 485
    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) click to toggle source

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`

    # File prism/node.rb, line 8485
    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()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

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

    # File prism/node.rb, line 8493
    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

end_keyword() click to toggle source

def `end_keyword`: () -> String?

    # File prism/node.rb, line 8620
    def end_keyword
      end_keyword_loc&.slice
    end

end_keyword_loc() click to toggle source

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

    if foo
      bar
    end
    ^^^

    # File prism/node.rb, line 8591
    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() click to toggle source

def `if_keyword`: () -> String?

    # File prism/node.rb, line 8610
    def if_keyword
      if_keyword_loc&.slice
    end

if_keyword_loc() click to toggle source

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.

    # File prism/node.rb, line 8503
    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() click to toggle source

def inspect -> String

    # File prism/node.rb, line 8625
    def inspect
      InspectVisitor.compose(self)
    end

save_end_keyword_loc(repository) click to toggle source

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

    # File prism/node.rb, line 8605
    def save_end_keyword_loc(repository)
      repository.enter(node_id, :end_keyword_loc) unless @end_keyword_loc.nil?
    end

save_if_keyword_loc(repository) click to toggle source

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

    # File prism/node.rb, line 8517
    def save_if_keyword_loc(repository)
      repository.enter(node_id, :if_keyword_loc) unless @if_keyword_loc.nil?
    end

save_then_keyword_loc(repository) click to toggle source

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

    # File prism/node.rb, line 8556
    def save_then_keyword_loc(repository)
      repository.enter(node_id, :then_keyword_loc) unless @then_keyword_loc.nil?
    end

then_keyword() click to toggle source

def `then_keyword`: () -> String?

    # File prism/node.rb, line 8615
    def then_keyword
      then_keyword_loc&.slice
    end

then_keyword_loc() click to toggle source

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

    if foo then bar end
           ^^^^

    a ? b : c
      ^

    # File prism/node.rb, line 8542
    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() click to toggle source

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

    # File prism/node.rb, line 8630
    def type
      :if_node
    end