123456789_123456789_123456789_123456789_123456789_

Class: Prism::UnlessNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Node
Instance Chain:
self, Node
Inherits: Prism::Node
Defined in: lib/prism/node.rb,
lib/prism/node_ext.rb,
lib/prism/parse_result/newlines.rb,
prism/api_node.c

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

Node - Inherited

.fields

Returns a list of the fields that exist for this node class.
.type

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.

Instance Attribute Summary

  • #else_clause 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.

Node - Inherited

#newline?

Returns true if the node has the newline flag set.
#node_id

A unique identifier for this node.
#static_literal?

Returns true if the node has the static literal flag set.
#flags

An bitset of flags for this node.
#source

A pointer to the source that this node was created from.
#newline_flag?

Instance Method Summary

Node - Inherited

#accept

Accepts a visitor and calls back into the specialized visit function.
#breadth_first_search

Returns the first node that matches the given block when visited in a depth-first search.
#cached_end_code_units_column

Delegates to the cached_end_code_units_column of the associated location object.
#cached_end_code_units_offset

Delegates to the cached_end_code_units_offset of the associated location object.
#cached_start_code_units_column

Delegates to the cached_start_code_units_column of the associated location object.
#cached_start_code_units_offset

Delegates to the cached_start_code_units_offset of the associated location object.
#child_nodes

Returns an array of child nodes, including nils in the place of optional nodes that were not present.
#comment_targets

Returns an array of child nodes and locations that could potentially have comments attached to them.
#comments

Delegates to the comments of the associated location object.
#compact_child_nodes

Returns an array of child nodes, excluding any nils in the place of optional nodes that were not present.
#deconstruct

Alias for Node#child_nodes.
#each_child_node

With a block given, yields each child node.
#end_character_column

Delegates to the end_character_column of the associated location object.
#end_character_offset

Delegates to the end_character_offset of the associated location object.
#end_column

Delegates to the end_column of the associated location object.
#end_line

Delegates to the end_line of the associated location object.
#end_offset

The end offset of the node in the source.
#inspect

Returns a string representation of the node.
#leading_comments

Delegates to the leading_comments of the associated location object.
#location

A Location instance that represents the location of this node in the source.
#pretty_print

Similar to inspect, but respects the current level of indentation given by the pretty print object.
#save

Save this node using a saved source so that it can be retrieved later.
#save_location

Save the location using a saved source so that it can be retrieved later.
#script_lines

Alias for Node#source_lines.
#slice

Slice the location of the node from the source.
#slice_lines

Slice the location of the node from the source, starting at the beginning of the line that the location starts on, ending at the end of the line that the location ends on.
#source_lines

Returns all of the lines of the source code associated with this node.
#start_character_column

Delegates to the start_character_column of the associated location object.
#start_character_offset

Delegates to the start_character_offset of the associated location object.
#start_column

Delegates to the start_column of the associated location object.
#start_line

Delegates to the start_line of the associated location object.
#start_offset

The start offset of the node in the source.
#to_dot

Convert this node into a graphviz dot graph string.
#trailing_comments

Delegates to the trailing_comments of the associated location object.
#tunnel

Returns a list of nodes that are descendants of this node that contain the given line and column.
#type

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform.
#deprecated, #newline_flag!

Constructor Details

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

Initialize a new UnlessNode node.

[ GitHub ] 

  


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



def initialize(source, node_id, location, flags, keyword_loc, predicate, then_keyword_loc, statements, else_clause, 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
  @else_clause = else_clause
  @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 18961



def self.type
  :unless_node
end


  







Instance Attribute Details



  

    #else_clause   (readonly)
  



  

    

The else clause of the unless expression, if present.



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


  



  [ GitHub ]


  

  


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



attr_reader :else_clause


  








  

    #predicate   (readonly)
  



  

    

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



unless cond then bar end
       ^^^^

bar unless cond
           ^^^^


  



  [ GitHub ]


  

  


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



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 18905



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 18967



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) &&
    (else_clause === other.else_clause) &&
    (end_keyword_loc.nil? == other.end_keyword_loc.nil?)
end


  








  

    #accept(visitor)  
  



  

    

def accept: (Visitor visitor) -> void


  



  [ GitHub ]


  

  


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



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

    

def child_nodes: () -> Array


  



  [ GitHub ]


  

  


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



def child_nodes
  [predicate, statements, else_clause]
end


  








  

    #comment_targets  
  



  

    

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


  



  [ GitHub ]


  

  


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



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


  








  

    #compact_child_nodes  
  



  

    

def compact_child_nodes: () -> Array


  



  [ GitHub ]


  

  


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



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


  








  

    #consequent  
  



  

    

Returns the else clause of the unless node. This method is deprecated in favor of #else_clause.


  



  [ GitHub ]


  

  


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



def consequent
  deprecated("else_clause")
  else_clause
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, else_clause: self.else_clause, 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?, ?else_clause: ElseNode?, ?end_keyword_loc: Location?) -> UnlessNode


  



  [ GitHub ]


  

  


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



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, else_clause: self.else_clause, end_keyword_loc: self.end_keyword_loc)
  UnlessNode.new(source, node_id, location, flags, keyword_loc, predicate, then_keyword_loc, statements, else_clause, end_keyword_loc)
end


  








  

    #deconstruct  
  



  

    

Alias for #child_nodes.


  



  [ GitHub ]


  

  


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



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?, else_clause: ElseNode?, end_keyword_loc: Location? }


  



  [ GitHub ]


  

  


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



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


  








  

    #each_child_node {|predicate| ... } 
  



  

    

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator


  





  
Yields:





  [ GitHub ]


  

  


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



def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield predicate
  yield statements if statements
  yield else_clause if else_clause
end


  








  

    #end_keyword  
  



  

    

def end_keyword: () -> String?


  



  [ GitHub ]


  

  


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



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 18917



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 18951



def inspect
  InspectVisitor.compose(self)
end


  








  

    #keyword  
  



  

    

def keyword: () -> String


  



  [ GitHub ]


  

  


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



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 18857



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


  








  

    #save_end_keyword_loc(repository)  
  



  

    

Save the end_keyword_loc location using the given saved source so that it can be retrieved later.


  



  [ GitHub ]


  

  


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



def save_end_keyword_loc(repository)
  repository.enter(node_id, :end_keyword_loc) unless @end_keyword_loc.nil?
end


  








  

    #save_keyword_loc(repository)  
  



  

    

Save the keyword_loc location using the given saved source so that it can be retrieved later.


  



  [ GitHub ]


  

  


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



def save_keyword_loc(repository)
  repository.enter(node_id, :keyword_loc)
end


  








  

    #save_then_keyword_loc(repository)  
  



  

    

Save the then_keyword_loc location using the given saved source so that it can be retrieved later.


  



  [ GitHub ]


  

  


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



def save_then_keyword_loc(repository)
  repository.enter(node_id, :then_keyword_loc) unless @then_keyword_loc.nil?
end


  








  

    #then_keyword  
  



  

    

def then_keyword: () -> String?


  



  [ GitHub ]


  

  


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



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 18882



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 18956



def type
  :unless_node
end