class Prism::UnlessNode

Represents the use of the ‘unless` keyword, either in the block form or the modifier form.

bar unless foo
^^^^^^^^^^^^^^

unless foo then bar end
^^^^^^^^^^^^^^^^^^^^^^^

Attributes

else_clause [R]

The else clause of the unless expression, if present.

unless cond then bar else baz end
                     ^^^^^^^^

predicate [R]

The condition to be evaluated for the unless expression. It can be any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

unless cond then bar end
       ^^^^

bar unless cond
           ^^^^

statements [R]

The body of statements that will executed if the unless condition is falsey. Will be ‘nil` if no body is provided.

unless cond then bar end
                 ^^^

Public Class Methods

new (source, node_id, location, flags, keyword_loc, predicate, then_keyword_loc, statements, else_clause, end_keyword_loc)

Source

# File lib/prism/node.rb, line 17245
def initialize(source, node_id, location, flags, keyword_loc, predicate, then_keyword_loc, statements, else_clause, end_keyword_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @keyword_loc = keyword_loc
  @predicate = predicate
  @then_keyword_loc = then_keyword_loc
  @statements = statements
  @else_clause = else_clause
  @end_keyword_loc = end_keyword_loc
end

Initialize a new UnlessNode node.

type ()

Source

# File lib/prism/node.rb, line 17406
def self.type
  :unless_node
end

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

Public Instance Methods

=== (other)

Source

# File lib/prism/node.rb, line 17412
def ===(other)
  other.is_a?(UnlessNode) &&
    (keyword_loc.nil? == other.keyword_loc.nil?) &&
    (predicate === other.predicate) &&
    (then_keyword_loc.nil? == other.then_keyword_loc.nil?) &&
    (statements === other.statements) &&
    (else_clause === other.else_clause) &&
    (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 17259
def accept(visitor)
  visitor.visit_unless_node(self)
end

def accept: (Visitor visitor) -> void

child_nodes ()

Source

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

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

Also aliased as: deconstruct

comment_targets ()

Source

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

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

compact_child_nodes ()

Source

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

def compact_child_nodes: () -> Array

consequent ()

Source

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

Returns the else clause of the unless node. This method is deprecated in favor of else_clause.

copy (node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, predicate: self.predicate, then_keyword_loc: self.then_keyword_loc, statements: self.statements, else_clause: self.else_clause, end_keyword_loc: self.end_keyword_loc)

Source

# File lib/prism/node.rb, line 17283
def copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, predicate: self.predicate, then_keyword_loc: self.then_keyword_loc, statements: self.statements, else_clause: self.else_clause, end_keyword_loc: self.end_keyword_loc)
  UnlessNode.new(source, node_id, location, flags, keyword_loc, predicate, then_keyword_loc, statements, else_clause, end_keyword_loc)
end

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?keyword_loc: Location, ?predicate: Prism::node, ?then_keyword_loc: Location?, ?statements: StatementsNode?, ?else_clause: ElseNode?, ?end_keyword_loc: Location?) -> UnlessNode

deconstruct ()

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

Alias for: child_nodes

deconstruct_keys (keys)

Source

# File lib/prism/node.rb, line 17291
def deconstruct_keys(keys)
  { node_id: node_id, location: location, keyword_loc: keyword_loc, predicate: predicate, then_keyword_loc: then_keyword_loc, statements: statements, else_clause: else_clause, end_keyword_loc: end_keyword_loc }
end

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

end_keyword ()

Source

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

def end_keyword: () -> String?

end_keyword_loc ()

Source

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

unless cond then bar end
                     ^^^

inspect ()

Source

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

def inspect -> String

keyword ()

Source

# File lib/prism/node.rb, line 17381
def keyword
  keyword_loc.slice
end

def keyword: () -> String

keyword_loc ()

Source

# File lib/prism/node.rb, line 17302
def keyword_loc
  location = @keyword_loc
  return location if location.is_a?(Location)
  @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

The location of the ‘unless` keyword.

unless cond then bar end
^^^^^^

bar unless cond
    ^^^^^^

save_end_keyword_loc (repository)

Source

# File lib/prism/node.rb, line 17376
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_keyword_loc (repository)

Source

# File lib/prism/node.rb, line 17310
def save_keyword_loc(repository)
  repository.enter(node_id, :keyword_loc)
end

Save the 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 17341
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 17386
def then_keyword
  then_keyword_loc&.slice
end

def then_keyword: () -> String?

then_keyword_loc ()

Source

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

unless cond then bar end
            ^^^^

type ()

Source

# File lib/prism/node.rb, line 17401
def type
  :unless_node
end

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