class Prism::UntilNode - Documentation for Ruby 3.3

# 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

closing_loc[R]

attr_reader `closing_loc`: `Location`?

keyword_loc[R]

attr_reader `keyword_loc`: `Location`

predicate[R]

attr_reader predicate: `Node`

statements[R]

attr_reader statements: `StatementsNode`?

### Public Class Methods

new(flags, keyword_loc, closing_loc, predicate, statements, location) click to toggle source

def initialize: (flags: `Integer`, `keyword_loc`: `Location`, `closing_loc`: `Location`?, predicate: `Node`, statements: `StatementsNode`?, location: `Location`) -> void

    # File lib/prism/node.rb, line 16641
    def initialize(flags, keyword_loc, closing_loc, predicate, statements, location)
      @flags = flags
      @keyword_loc = keyword_loc
      @closing_loc = closing_loc
      @predicate = predicate
      @statements = statements
      @location = location
    end

type() click to toggle source

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 16754
    def self.type
      :until_node
    end

### Public Instance Methods

accept(visitor) click to toggle source

def accept: (visitor: `Visitor`) -> void

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

begin_modifier?() click to toggle source

def begin_modifier?: () -> bool

    # File lib/prism/node.rb, line 16698
    def begin_modifier?
      flags.anybits?(LoopFlags::BEGIN_MODIFIER)
    end

child_nodes() click to toggle source

def `child_nodes`: () -> Array[nil | Node]

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

Also aliased as: deconstruct
closing() click to toggle source

def closing: () -> `String`?

    # File lib/prism/node.rb, line 16708
    def closing
      closing_loc&.slice
    end

comment_targets() click to toggle source

def `comment_targets`: () -> Array[Node | Location]

    # File lib/prism/node.rb, line 16673
    def comment_targets
      [keyword_loc, *closing_loc, predicate, *statements]
    end

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

    # File lib/prism/node.rb, line 16665
    def compact_child_nodes
      compact = []
      compact << predicate
      compact << statements if statements
      compact
    end

copy(**params) click to toggle source

def copy: (**params) -> `UntilNode`

    # File lib/prism/node.rb, line 16678
    def copy(**params)
      UntilNode.new(
        params.fetch(:flags) { flags },
        params.fetch(:keyword_loc) { keyword_loc },
        params.fetch(:closing_loc) { closing_loc },
        params.fetch(:predicate) { predicate },
        params.fetch(:statements) { statements },
        params.fetch(:location) { location },
      )
    end

deconstruct()

def deconstruct: () -> Array[nil | Node]

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

def `deconstruct_keys`: (keys: Array) -> Hash[Symbol, nil | `Node` | Array | `String` | `Token` | Array | Location]

    # File lib/prism/node.rb, line 16693
    def deconstruct_keys(keys)
      { flags: flags, keyword_loc: keyword_loc, closing_loc: closing_loc, predicate: predicate, statements: statements, location: location }
    end

inspect(inspector = NodeInspector.new) click to toggle source

def inspect(inspector: NodeInspector) -> `String`

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

keyword() click to toggle source

def keyword: () -> `String`

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

type() click to toggle source

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 16744
    def type
      :until_node
    end