Represents the use of the ‘unless` keyword, either in the block form or the modifier form.
bar unless foo ^^^^^^^^^^^^^^ unless foo then bar end ^^^^^^^^^^^^^^^^^^^^^^^
attr_reader keyword_loc: Location
attr_reader then_keyword_loc: Location?
attr_reader statements: StatementsNode?
attr_reader consequent: ElseNode?
attr_reader end_keyword_loc: Location?
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16491
def initialize(keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc, location)
@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 initialize: (keyword_loc: Location, predicate: Node, then_keyword_loc: Location?, statements: StatementsNode?, consequent: ElseNode?, end_keyword_loc: Location?, location: Location) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16612
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.3.0/lib/prism/node.rb, line 16502
def accept(visitor)
visitor.visit_unless_node(self)
end
def accept: (visitor: Visitor) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16511
def child_nodes
[predicate, statements, consequent]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16525
def comment_targets
[keyword_loc, predicate, *then_keyword_loc, *statements, *consequent, *end_keyword_loc]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16516
def compact_child_nodes
compact = []
compact << predicate
compact << statements if statements
compact << consequent if consequent
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16530
def copy(**params)
UnlessNode.new(
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:predicate) { predicate },
params.fetch(:then_keyword_loc) { then_keyword_loc },
params.fetch(:statements) { statements },
params.fetch(:consequent) { consequent },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:location) { location },
)
end
def copy: (**params) -> UnlessNode
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16546
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
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16561
def end_keyword
end_keyword_loc&.slice
end
def end_keyword: () -> String?
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16566
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector << "├── predicate:\n"
inspector << inspector.child_node(predicate, "│ ")
inspector << "├── then_keyword_loc: #{inspector.location(then_keyword_loc)}\n"
if (statements = self.statements).nil?
inspector << "├── statements: ∅\n"
else
inspector << "├── statements:\n"
inspector << statements.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (consequent = self.consequent).nil?
inspector << "├── consequent: ∅\n"
else
inspector << "├── consequent:\n"
inspector << consequent.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector.to_str
end
def inspect(inspector: NodeInspector) -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16551
def keyword
keyword_loc.slice
end
def keyword: () -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16556
def then_keyword
then_keyword_loc&.slice
end
def then_keyword: () -> String?
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 16602
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