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

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 30017
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.

Public Instance Methods

consequent ()

Source

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

else_clause → ElseNode | nil

Source

# File lib/prism/node.rb, line 30220
def else_clause
  @else_clause
end

The else clause of the unless expression, if present.

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

predicate → Node

Source

# File lib/prism/node.rb, line 30163
def predicate
  @predicate
end

The condition to be evaluated for the unless expression. It can be any non-void expression.

unless cond then bar end
       ^^^^

bar unless cond
           ^^^^

statements → StatementsNode | nil

Source

# File lib/prism/node.rb, line 30207
def statements
  @statements
end

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

Locations

Public Instance Methods

end_keyword_loc → Location | nil

Source

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

keyword_loc → Location

Source

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

then_keyword_loc → Location | nil

Source

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

Node Interface

These methods are present on all subclasses of Node. Read the node interface docs for more information.

Public Class Methods

type ()

Source

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

See Node.type.

Public Instance Methods

accept (visitor)

Source

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

See Node.accept.

child_nodes ()

Source

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

See Node.child_nodes.

Also aliased as: deconstruct

comment_targets ()

Source

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

See Node.comment_targets.

compact_child_nodes ()

Source

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

See Node.compact_child_nodes.

copy(**fields) → UnlessNode

Source

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

Creates a copy of self with the given fields, using self as the template.

deconstruct ()

Alias for: child_nodes

each_child_node () { |predicate| ... }

Source

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

  yield predicate
  if (statements = self.statements); yield statements; end
  if (else_clause = self.else_clause); yield else_clause; end
end

See Node.each_child_node.

type ()

Source

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

See Node#type.

Repository

Methods related to Relocation.

Public Instance Methods

save_end_keyword_loc (repository)

Source

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

Slicing

Public Instance Methods

end_keyword → String | nil

Source

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

Slice the location of end_keyword_loc from the source.

keyword → String

Source

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

Slice the location of keyword_loc from the source.

then_keyword → String | nil

Source

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

Slice the location of then_keyword_loc from the source.