123456789_123456789_123456789_123456789_123456789_

Class: Prism::UnlessNode

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,
lib/prism/node_ext.rb,
lib/prism/parse_result/newlines.rb

Overview

Represents the use of the unless keyword, either in the block form or the modifier form.

bar unless foo
^^^^^^^^^^^^^^

unless foo then bar end
^^^^^^^^^^^^^^^^^^^^^^^

Class Method Summary

Instance Attribute Summary

  • #consequent readonly

    The else clause of the unless expression, if present.

  • #predicate readonly

    The condition to be evaluated for the unless expression.

  • #statements readonly

    The body of statements that will executed if the unless condition is falsey.

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc) ⇒ UnlessNode

Initialize a new UnlessNode node.

[ GitHub ] 

  


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



def initialize(source, node_id, location, flags, keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @keyword_loc = keyword_loc
  @predicate = predicate
  @then_keyword_loc = then_keyword_loc
  @statements = statements
  @consequent = consequent
  @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 15736



def self.type
  :unless_node
end


  







Instance Attribute Details



  

    #consequent   (readonly)
  



  

    
The else clause of the unless expression, if present.


unless cond then bar else baz end
                     ^^^^^^^^

  



  [ GitHub ]


  

  


# File 'lib/prism/node_ext.rb', line 506



attr_reader :consequent


  








  

    #predicate   (readonly)
  



  

    
The condition to be evaluated for the unless expression. It can be anynon-void expression.


unless cond then bar end
       ^^^^

bar unless cond
           ^^^^

  



  [ GitHub ]


  

  


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



attr_reader :predicate


  








  

    #statements   (readonly)
  



  

    
The body of statements that will executed if the unless condition is
falsey. Will be nil if no body is provided.


unless cond then bar end
                 ^^^

  



  [ GitHub ]


  

  


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



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 15742



def ===(other)
  other.is_a?(UnlessNode) &&
    (keyword_loc.nil? == other.keyword_loc.nil?) &&
    (predicate === other.predicate) &&
    (then_keyword_loc.nil? == other.then_keyword_loc.nil?) &&
    (statements === other.statements) &&
    (consequent === other.consequent) &&
    (end_keyword_loc.nil? == other.end_keyword_loc.nil?)
end


  








  

    #accept(visitor)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


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



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


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



def child_nodes
  [predicate, statements, consequent]
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


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



def comment_targets
  [keyword_loc, predicate, *then_keyword_loc, *statements, *consequent, *end_keyword_loc] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


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



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


  








  

    #copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, predicate: self.predicate, then_keyword_loc: self.then_keyword_loc, statements: self.statements, consequent: self.consequent, end_keyword_loc: self.end_keyword_loc)  
  



  

    
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?keyword_loc: Location, ?predicate: Prism.node, ?then_keyword_loc: Location?, ?statements: StatementsNode?, ?consequent: ElseNode?, ?end_keyword_loc: Location?) -> UnlessNode

  



  [ GitHub ]


  

  


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



def copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, predicate: self.predicate, then_keyword_loc: self.then_keyword_loc, statements: self.statements, consequent: self.consequent, end_keyword_loc: self.end_keyword_loc)
  UnlessNode.new(source, node_id, location, flags, keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc)
end


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


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



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, keyword_loc: Location, predicate: Prism.node, then_keyword_loc: Location?, statements: StatementsNode?, consequent: ElseNode?, end_keyword_loc: Location? }

  



  [ GitHub ]


  

  


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



def deconstruct_keys(keys)
  { node_id: node_id, location: location, keyword_loc: keyword_loc, predicate: predicate, then_keyword_loc: then_keyword_loc, statements: statements, consequent: consequent, end_keyword_loc: end_keyword_loc }
end


  








  

    #end_keyword  
  



  

    
def end_keyword: () -> String?

  



  [ GitHub ]


  

  


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



def end_keyword
  end_keyword_loc&.slice
end


  








  

    #end_keyword_loc  
  



  

    
The location of the end keyword, if present.


unless cond then bar end
                     ^^^

  



  [ GitHub ]


  

  


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



def end_keyword_loc
  location = @end_keyword_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @end_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


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



def inspect
  InspectVisitor.compose(self)
end


  








  

    #keyword  
  



  

    
def keyword: () -> String

  



  [ GitHub ]


  

  


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



def keyword
  keyword_loc.slice
end


  








  

    #keyword_loc  
  



  

    
The location of the unless keyword.


unless cond then bar end
^^^^^^

bar unless cond
    ^^^^^^

  



  [ GitHub ]


  

  


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



def keyword_loc
  location = @keyword_loc
  return location if location.is_a?(Location)
  @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end


  








  

    #newline_flag!(lines)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/prism/parse_result/newlines.rb', line 98



def newline_flag!(lines) # :nodoc:
  predicate.newline_flag!(lines)
end


  








  

    #then_keyword  
  



  

    
def then_keyword: () -> String?

  



  [ GitHub ]


  

  


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



def then_keyword
  then_keyword_loc&.slice
end


  








  

    #then_keyword_loc  
  



  

    
The location of the then keyword, if present.


unless cond then bar end
            ^^^^

  



  [ GitHub ]


  

  


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



def then_keyword_loc
  location = @then_keyword_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @then_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end


  








  

    #type  
  



  

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

  



  [ GitHub ]


  

  


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



def type
  :unless_node
end