Class: Prism::UnlessNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
lib/prism/node_ext.rb,
lib/prism/parse_result/newlines.rb,
ext/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
^^^^^^^^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, keyword_loc, predicate, then_keyword_loc, statements, else_clause, end_keyword_loc) ⇒ UnlessNode

Initialize a new UnlessNode node.



18810
18811
18812
18813
18814
18815
18816
18817
18818
18819
18820
18821
 
# File 'lib/prism/node.rb', line 18810

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

Instance Attribute Details

#else_clause ⇒ Object (readonly)

The else clause of the unless expression, if present.

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



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

def else_clause
  @else_clause
end

#predicate ⇒ Object (readonly)

The condition to be evaluated for the unless expression. It can be any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

unless cond then bar end
       ^^^^

bar unless cond
           ^^^^



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

def predicate
  @predicate
end

#statements ⇒ Object (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
                 ^^^



18924
18925
18926
 
# File 'lib/prism/node.rb', line 18924

def statements
  @statements
end

Class Method Details

.type ⇒ Object

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



18980
18981
18982
 
# File 'lib/prism/node.rb', line 18980

def self.type
  :unless_node
end

Instance Method Details

#===(other) ⇒ Object

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



18986
18987
18988
18989
18990
18991
18992
18993
18994
 
# File 'lib/prism/node.rb', line 18986

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) ⇒ Object

def accept: (Visitor visitor) -> void



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

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



18829
18830
18831
 
# File 'lib/prism/node.rb', line 18829

def child_nodes
  [predicate, statements, else_clause]
end

#comment_targets ⇒ Object

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



18852
18853
18854
 
# File 'lib/prism/node.rb', line 18852

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



18843
18844
18845
18846
18847
18848
18849
 
# File 'lib/prism/node.rb', line 18843

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

#consequent ⇒ Object

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



506
507
508
509
 
# 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) ⇒ Object

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



18857
18858
18859
 
# File 'lib/prism/node.rb', line 18857

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_keys(keys) ⇒ Object

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? }



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

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| ... } ⇒ Object

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

Yields:



18834
18835
18836
18837
18838
18839
18840
 
# File 'lib/prism/node.rb', line 18834

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 ⇒ Object

def end_keyword: () -> String?



18965
18966
18967
 
# File 'lib/prism/node.rb', line 18965

def end_keyword
  end_keyword_loc&.slice
end

#end_keyword_loc ⇒ Object

The location of the end keyword, if present.

unless cond then bar end
                     ^^^



18936
18937
18938
18939
18940
18941
18942
18943
18944
18945
18946
 
# File 'lib/prism/node.rb', line 18936

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 ⇒ Object

def inspect -> String



18970
18971
18972
 
# File 'lib/prism/node.rb', line 18970

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String



18955
18956
18957
 
# File 'lib/prism/node.rb', line 18955

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

The location of the unless keyword.

unless cond then bar end
^^^^^^

bar unless cond
    ^^^^^^



18876
18877
18878
18879
18880
 
# File 'lib/prism/node.rb', line 18876

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) ⇒ Object

:nodoc:



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

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

#save_end_keyword_loc(repository) ⇒ Object

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



18950
18951
18952
 
# File 'lib/prism/node.rb', line 18950

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

#save_keyword_loc(repository) ⇒ Object

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



18884
18885
18886
 
# File 'lib/prism/node.rb', line 18884

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

#save_then_keyword_loc(repository) ⇒ Object

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



18915
18916
18917
 
# File 'lib/prism/node.rb', line 18915

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

#then_keyword ⇒ Object

def then_keyword: () -> String?



18960
18961
18962
 
# File 'lib/prism/node.rb', line 18960

def then_keyword
  then_keyword_loc&.slice
end

#then_keyword_loc ⇒ Object

The location of the then keyword, if present.

unless cond then bar end
            ^^^^



18901
18902
18903
18904
18905
18906
18907
18908
18909
18910
18911
 
# File 'lib/prism/node.rb', line 18901

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 ⇒ Object

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



18975
18976
18977
 
# File 'lib/prism/node.rb', line 18975

def type
  :unless_node
end