class Prism::IfNode - Documentation for Ruby 4.0
Description: class Prism::IfNode: Represents the use of the `if` keyword, either in the block form or the modifier form, or a ternary expression.
Keywords: ruby,class,Prism::IfNode

🔍

No recent searches

# 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)
Source

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

Initialize a new `IfNode` node.

type ()
Source

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

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

### Public Instance Methods

=== (other)
Source

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

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

accept (visitor)
Source

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

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

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

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

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

compact_child_nodes ()
Source

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

def `compact_child_nodes`: () -> Array

consequent ()
Source

    # File lib/prism/node_ext.rb, line 488
    def consequent
      deprecated("subsequent")
      subsequent
    end

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

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)
Source

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

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`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

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

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

each_child_node () { |predicate| ... }
Source

    # File lib/prism/node.rb, line 9105
    def each_child_node
      return to_enum(:each_child_node) unless block_given?

      yield predicate
      yield statements if statements
      yield subsequent if subsequent
    end

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

end_keyword ()
Source

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

def `end_keyword`: () -> `String`?

end_keyword_loc ()
Source

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

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

    if foo
      bar
    end
    ^^^

if_keyword ()
Source

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

def `if_keyword`: () -> `String`?

if_keyword_loc ()
Source

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

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.

inspect ()
Source

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

def inspect -> `String`

save_end_keyword_loc (repository)
Source

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

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

save_if_keyword_loc (repository)
Source

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

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

save_then_keyword_loc (repository)
Source

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

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

then_keyword ()
Source

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

def `then_keyword`: () -> `String`?

then_keyword_loc ()
Source

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

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

    if foo then bar end
           ^^^^

    a ? b : c
      ^

type ()
Source

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

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