123456789_123456789_123456789_123456789_123456789_

Class: Prism::EnsureNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PrismNode
Instance Chain:
self, PrismNode
Inherits: PrismNode
Defined in: lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents an ensure clause in a begin statement.

begin
  foo
ensure
^^^^^^
  bar
end

Class Method Summary

Instance Attribute Summary

  • #statements readonly

    attr_reader statements: StatementsNode?

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, ensure_keyword_loc, statements, end_keyword_loc) ⇒ EnsureNode

Initialize a new EnsureNode node.

[ GitHub ] 

  


# File 'lib/prism/node.rb', line 5641



def initialize(source, node_id, location, flags, ensure_keyword_loc, statements, end_keyword_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @ensure_keyword_loc = ensure_keyword_loc
  @statements = statements
  @end_keyword_loc = end_keyword_loc
end


  







Class Method Details



  

    .type  
  



  

    
Return a symbol representation of this node type. See Node::type.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5723



def self.type
  :ensure_node
end


  







Instance Attribute Details



  

    #statements   (readonly)
  



  

    
attr_reader statements: StatementsNode?

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5694



attr_reader :statements


  







Instance Method Details



  

    #===(other)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5729



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)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5652



def accept(visitor)
  visitor.visit_ensure_node(self)
end


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5657



def child_nodes
  [statements]
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5669



def comment_targets
  [ensure_keyword_loc, *statements, end_keyword_loc] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5662



def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << statements if statements
  compact
end


  








  

    #copy(node_id: self.node_id, location: self.location, flags: self.flags, ensure_keyword_loc: self.ensure_keyword_loc, statements: self.statements, end_keyword_loc: self.end_keyword_loc)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5674



def copy(node_id: self.node_id, location: self.location, flags: self.flags, ensure_keyword_loc: self.ensure_keyword_loc, statements: self.statements, end_keyword_loc: self.end_keyword_loc)
  EnsureNode.new(source, node_id, location, flags, ensure_keyword_loc, statements, end_keyword_loc)
end


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5679



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5682



def deconstruct_keys(keys)
  { node_id: node_id, location: location, ensure_keyword_loc: ensure_keyword_loc, statements: statements, end_keyword_loc: end_keyword_loc }
end


  








  

    #end_keyword  
  



  

    
def end_keyword: () -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5708



def end_keyword
  end_keyword_loc.slice
end


  








  

    #end_keyword_loc  
  



  

    
attr_reader end_keyword_loc: Location

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5696



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  
  



  

    
def ensure_keyword: () -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5703



def ensure_keyword
  ensure_keyword_loc.slice
end


  








  

    #ensure_keyword_loc  
  



  

    
attr_reader ensure_keyword_loc: Location

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5687



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  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5713



def inspect
  InspectVisitor.compose(self)
end


  








  

    #type  
  



  

    
Return a symbol representation of this node type. See Node#type.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 5718



def type
  :ensure_node
end