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.0-preview1/lib/prism/node.rb, line 18096
def initialize(source, keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc, location)
@source = source
@location = location
@keyword_loc = keyword_loc
@predicate = predicate
@then_keyword_loc = then_keyword_loc
@statements = statements
@consequent = consequent
@end_keyword_loc = end_keyword_loc
end
def initialize: (Location
keyword_loc
, Prism::node predicate, Location
? then_keyword_loc
, StatementsNode
? statements, ElseNode
? consequent, Location
? end_keyword_loc
, Location
location) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18253
def self.type
:unless_node
end
Similar to type
, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like type
, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.
def self.type: () -> Symbol
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18259
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) &&
(consequent === other.consequent) &&
(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.0-preview1/lib/prism/node.rb, line 18108
def accept(visitor)
visitor.visit_unless_node(self)
end
def accept: (Visitor
visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18113
def child_nodes
[predicate, statements, consequent]
end
def child_nodes
: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18127
def comment_targets
[keyword_loc, predicate, *then_keyword_loc, *statements, *consequent, *end_keyword_loc] #: Array[Prism::node | Location]
end
def comment_targets
: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18118
def compact_child_nodes
compact = [] #: Array[Prism::node]
compact << predicate
compact << statements if statements
compact << consequent if consequent
compact
end
def compact_child_nodes
: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18132
def copy(keyword_loc: self.keyword_loc, predicate: self.predicate, then_keyword_loc: self.then_keyword_loc, statements: self.statements, consequent: self.consequent, end_keyword_loc: self.end_keyword_loc, location: self.location)
UnlessNode.new(source, keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc, location)
end
def copy: (?keyword_loc: Location
, ?predicate: Prism::node, ?then_keyword_loc: Location
?, ?statements: StatementsNode
?, ?consequent: ElseNode
?, ?end_keyword_loc: Location
?, ?location: Location
) -> UnlessNode
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18140
def deconstruct_keys(keys)
{ keyword_loc: keyword_loc, predicate: predicate, then_keyword_loc: then_keyword_loc, statements: statements, consequent: consequent, end_keyword_loc: end_keyword_loc, location: location }
end
def deconstruct_keys
: (Array keys) -> { keyword_loc
: Location
, predicate: Prism::node, then_keyword_loc
: Location
?, statements: StatementsNode
?, consequent: ElseNode
?, end_keyword_loc
: Location
?, location: Location
}
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18220
def end_keyword
end_keyword_loc&.slice
end
def end_keyword
: () -> String
?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18197
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.0-preview1/lib/prism/node.rb, line 18225
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18210
def keyword
keyword_loc.slice
end
def keyword: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18151
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.0-preview1/lib/prism/node.rb, line 18215
def then_keyword
then_keyword_loc&.slice
end
def then_keyword
: () -> String
?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 18168
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.0-preview1/lib/prism/node.rb, line 18243
def type
:unless_node
end
Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.
Instead, you can call type
, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.
def type: () -> Symbol