Represents the use of the ‘unless` keyword, either in the block form or the modifier form.
bar unless foo ^^^^^^^^^^^^^^ unless foo then bar end ^^^^^^^^^^^^^^^^^^^^^^^
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
^^^^
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
^^^
The else clause of the unless expression, if present.
unless cond then bar else baz end
^^^^^^^^
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17503
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.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17664
def self.type
:unless_node
end
Return a symbol representation of this node type. See ‘Node::type`.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17670
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.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17517
def accept(visitor)
visitor.visit_unless_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17522
def child_nodes
[predicate, statements, else_clause]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17536
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]
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17527
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
# File tmp/rubies/ruby-3.4.1/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.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17541
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
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17549
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? }
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17649
def end_keyword
end_keyword_loc&.slice
end
def end_keyword: () -> String?
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17620
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
^^^
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17654
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17639
def keyword
keyword_loc.slice
end
def keyword: () -> String
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17560
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
^^^^^^
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17634
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.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17568
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.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17599
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.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17644
def then_keyword
then_keyword_loc&.slice
end
def then_keyword: () -> String?
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17585
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
^^^^
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 17659
def type
:unless_node
end
Return a symbol representation of this node type. See ‘Node#type`.