class Prism::UntilNode
Represents the use of the ‘until` keyword, either in the block form or the modifier form.
bar until foo ^^^^^^^^^^^^^ until foo do bar end ^^^^^^^^^^^^^^^^^^^^
Attributes
private attr_reader flags: Integer
attr_reader predicate: Prism::node
attr_reader statements: StatementsNode
?
Public Class Methods
def initialize: (Integer
flags, Location
keyword_loc
, Location
? closing_loc
, Prism::node predicate, StatementsNode
? statements, Location
location) -> void
# File lib/prism/node.rb, line 18089 def initialize(source, flags, keyword_loc, closing_loc, predicate, statements, location) @source = source @newline = false @location = location @flags = flags @keyword_loc = keyword_loc @closing_loc = closing_loc @predicate = predicate @statements = statements 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 lib/prism/node.rb, line 18228 def self.type :until_node end
Public Instance Methods
def accept: (Visitor
visitor) -> void
# File lib/prism/node.rb, line 18101 def accept(visitor) visitor.visit_until_node(self) end
def begin_modifier?: () -> bool
# File lib/prism/node.rb, line 18172 def begin_modifier? flags.anybits?(LoopFlags::BEGIN_MODIFIER) end
def child_nodes
: () -> Array[nil | Node]
# File lib/prism/node.rb, line 18110 def child_nodes [predicate, statements] end
def closing: () -> String
?
# File lib/prism/node.rb, line 18182 def closing closing_loc&.slice end
attr_reader closing_loc
: Location
?
# File lib/prism/node.rb, line 18152 def closing_loc location = @closing_loc case location when nil nil when Location location else @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end end
def comment_targets
: () -> Array[Node | Location]
# File lib/prism/node.rb, line 18123 def comment_targets [keyword_loc, *closing_loc, predicate, *statements] #: Array[Prism::node | Location] end
def compact_child_nodes
: () -> Array
# File lib/prism/node.rb, line 18115 def compact_child_nodes compact = [] #: Array[Prism::node] compact << predicate compact << statements if statements compact end
def copy: (?flags: Integer
, ?keyword_loc: Location
, ?closing_loc: Location
?, ?predicate: Prism::node, ?statements: StatementsNode
?, ?location: Location
) -> UntilNode
# File lib/prism/node.rb, line 18128 def copy(flags: self.flags, keyword_loc: self.keyword_loc, closing_loc: self.closing_loc, predicate: self.predicate, statements: self.statements, location: self.location) UntilNode.new(source, flags, keyword_loc, closing_loc, predicate, statements, location) end
def deconstruct_keys
: (Array keys) -> { flags: Integer
, keyword_loc
: Location
, closing_loc
: Location
?, predicate: Prism::node, statements: StatementsNode
?, location: Location
}
# File lib/prism/node.rb, line 18136 def deconstruct_keys(keys) { flags: flags, keyword_loc: keyword_loc, closing_loc: closing_loc, predicate: predicate, statements: statements, location: location } end
def inspect(NodeInspector inspector) -> String
# File lib/prism/node.rb, line 18187 def inspect(inspector = NodeInspector.new) inspector << inspector.header(self) flags = [("begin_modifier" if begin_modifier?)].compact inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n" inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n" inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n" inspector << "├── predicate:\n" inspector << inspector.child_node(predicate, "│ ") if (statements = self.statements).nil? inspector << "└── statements: ∅\n" else inspector << "└── statements:\n" inspector << statements.inspect(inspector.child_inspector(" ")).delete_prefix(inspector.prefix) end inspector.to_str end
def keyword: () -> String
# File lib/prism/node.rb, line 18177 def keyword keyword_loc.slice end
attr_reader keyword_loc
: Location
# File lib/prism/node.rb, line 18145 def keyword_loc location = @keyword_loc return location if location.is_a?(Location) @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) 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
# File lib/prism/node.rb, line 18218 def type :until_node end