Class: Prism::UnlessNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.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

Instance Method Summary collapse

Constructor Details

#initialize(keyword_loc, predicate, statements, consequent, end_keyword_loc, location) ⇒ UnlessNode

def initialize: (keyword_loc: Location, predicate: Node, statements: StatementsNode?, consequent: ElseNode?, end_keyword_loc: Location?, location: Location) -> void



13784
13785
13786
13787
13788
13789
13790
13791
 
# File 'lib/prism/node.rb', line 13784

def initialize(keyword_loc, predicate, statements, consequent, end_keyword_loc, location)
  @keyword_loc = keyword_loc
  @predicate = predicate
  @statements = statements
  @consequent = consequent
  @end_keyword_loc = end_keyword_loc
  @location = location
end

Instance Attribute Details

#consequent ⇒ Object (readonly)

attr_reader consequent: ElseNode?



13778
13779
13780
 
# File 'lib/prism/node.rb', line 13778

def consequent
  @consequent
end

#end_keyword_loc ⇒ Object (readonly)

attr_reader end_keyword_loc: Location?



13781
13782
13783
 
# File 'lib/prism/node.rb', line 13781

def end_keyword_loc
  @end_keyword_loc
end

#keyword_loc ⇒ Object (readonly)

attr_reader keyword_loc: Location



13769
13770
13771
 
# File 'lib/prism/node.rb', line 13769

def keyword_loc
  @keyword_loc
end

#predicate ⇒ Object (readonly)

attr_reader predicate: Node



13772
13773
13774
 
# File 'lib/prism/node.rb', line 13772

def predicate
  @predicate
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



13775
13776
13777
 
# File 'lib/prism/node.rb', line 13775

def statements
  @statements
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



13794
13795
13796
 
# File 'lib/prism/node.rb', line 13794

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

#child_nodes ⇒ Object Also known as: deconstruct

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



13803
13804
13805
 
# File 'lib/prism/node.rb', line 13803

def child_nodes
  [predicate, statements, consequent]
end

#comment_targets ⇒ Object

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



13817
13818
13819
 
# File 'lib/prism/node.rb', line 13817

def comment_targets
  [keyword_loc, predicate, *statements, *consequent, *end_keyword_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



13808
13809
13810
13811
13812
13813
13814
 
# File 'lib/prism/node.rb', line 13808

def compact_child_nodes
  compact = []
  compact << predicate
  compact << statements if statements
  compact << consequent if consequent
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> UnlessNode



13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
 
# File 'lib/prism/node.rb', line 13822

def copy(**params)
  UnlessNode.new(
    params.fetch(:keyword_loc) { keyword_loc },
    params.fetch(:predicate) { predicate },
    params.fetch(:statements) { statements },
    params.fetch(:consequent) { consequent },
    params.fetch(:end_keyword_loc) { end_keyword_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



13837
13838
13839
 
# File 'lib/prism/node.rb', line 13837

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

#end_keyword ⇒ Object

def end_keyword: () -> String?



13847
13848
13849
 
# File 'lib/prism/node.rb', line 13847

def end_keyword
  end_keyword_loc&.slice
end

#inspect(inspector = NodeInspector.new) ⇒ Object 



13851
13852
13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
 
# File 'lib/prism/node.rb', line 13851

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
  inspector << "├── predicate:\n"
  inspector << inspector.child_node(predicate, "│   ")
  if (statements = self.statements).nil?
    inspector << "├── statements: ∅\n"
  else
    inspector << "├── statements:\n"
    inspector << statements.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  if (consequent = self.consequent).nil?
    inspector << "├── consequent: ∅\n"
  else
    inspector << "├── consequent:\n"
    inspector << consequent.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
  inspector.to_str
end

#keyword ⇒ Object

def keyword: () -> String



13842
13843
13844
 
# File 'lib/prism/node.rb', line 13842

def keyword
  keyword_loc.slice
end

#set_newline_flag(newline_marked) ⇒ Object 



13798
13799
13800
 
# File 'lib/prism/node.rb', line 13798

def set_newline_flag(newline_marked)
  predicate.set_newline_flag(newline_marked)
end

#type ⇒ Object

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



13886
13887
13888
 
# File 'lib/prism/node.rb', line 13886

def type
  :unless_node
end