class Prism::EnsureNode

Represents an ‘ensure` clause in a `begin` statement.

begin
  foo
ensure
^^^^^^
  bar
end

Attributes

statements[R]

attr_reader statements: StatementsNode?

Public Class Methods

new(source, ensure_keyword_loc, statements, end_keyword_loc, location) click to toggle source

def initialize: (Location ensure_keyword_loc, StatementsNode? statements, Location end_keyword_loc, Location location) -> void

# File lib/prism/node.rb, line 6528
def initialize(source, ensure_keyword_loc, statements, end_keyword_loc, location)
  @source = source
  @newline = false
  @location = location
  @ensure_keyword_loc = ensure_keyword_loc
  @statements = statements
  @end_keyword_loc = end_keyword_loc
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 6628
def self.type
  :ensure_node
end

Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

# File lib/prism/node.rb, line 6634
def ===(other)
  other.is_a?(EnsureNode) &&
    (ensure_keyword_loc.nil? == other.ensure_keyword_loc.nil?) &&
    (statements === other.statements) &&
    (end_keyword_loc.nil? == other.end_keyword_loc.nil?)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

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

child_nodes() click to toggle source

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

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

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 6555
def comment_targets
  [ensure_keyword_loc, *statements, end_keyword_loc] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 6548
def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << statements if statements
  compact
end

copy(ensure_keyword_loc: self.ensure_keyword_loc, statements: self.statements, end_keyword_loc: self.end_keyword_loc, location: self.location) click to toggle source

def copy: (?ensure_keyword_loc: Location, ?statements: StatementsNode?, ?end_keyword_loc: Location, ?location: Location) -> EnsureNode

# File lib/prism/node.rb, line 6560
def copy(ensure_keyword_loc: self.ensure_keyword_loc, statements: self.statements, end_keyword_loc: self.end_keyword_loc, location: self.location)
  EnsureNode.new(source, ensure_keyword_loc, statements, end_keyword_loc, location)
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { ensure_keyword_loc: Location, statements: StatementsNode?, end_keyword_loc: Location, location: Location }

# File lib/prism/node.rb, line 6568
def deconstruct_keys(keys)
  { ensure_keyword_loc: ensure_keyword_loc, statements: statements, end_keyword_loc: end_keyword_loc, location: location }
end

end_keyword() click to toggle source

def end_keyword: () -> String

# File lib/prism/node.rb, line 6595
def end_keyword
  end_keyword_loc.slice
end

end_keyword_loc() click to toggle source

attr_reader end_keyword_loc: Location

# File lib/prism/node.rb, line 6583
def end_keyword_loc
  location = @end_keyword_loc
  return location if location.is_a?(Location)
  @end_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

ensure_keyword() click to toggle source

def ensure_keyword: () -> String

# File lib/prism/node.rb, line 6590
def ensure_keyword
  ensure_keyword_loc.slice
end

ensure_keyword_loc() click to toggle source

attr_reader ensure_keyword_loc: Location

# File lib/prism/node.rb, line 6573
def ensure_keyword_loc
  location = @ensure_keyword_loc
  return location if location.is_a?(Location)
  @ensure_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

inspect() click to toggle source

def inspect -> String

# File lib/prism/node.rb, line 6600
def inspect
  InspectVisitor.compose(self)
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 6618
def type
  :ensure_node
end