Class: Prism::IfNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents the use of the ‘if` keyword, either in the block form or the modifier form.

bar if foo
^^^^^^^^^^

if foo then bar end
^^^^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(if_keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc, location) ⇒ IfNode

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



7733
7734
7735
7736
7737
7738
7739
7740
7741
 
# File 'lib/prism/node.rb', line 7733

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

Instance Attribute Details

#consequent ⇒ Object (readonly)

attr_reader consequent: Node?



7727
7728
7729
 
# File 'lib/prism/node.rb', line 7727

def consequent
  @consequent
end

#end_keyword_loc ⇒ Object (readonly)

attr_reader end_keyword_loc: Location?



7730
7731
7732
 
# File 'lib/prism/node.rb', line 7730

def end_keyword_loc
  @end_keyword_loc
end

#if_keyword_loc ⇒ Object (readonly)

attr_reader if_keyword_loc: Location?



7715
7716
7717
 
# File 'lib/prism/node.rb', line 7715

def if_keyword_loc
  @if_keyword_loc
end

#predicate ⇒ Object (readonly)

attr_reader predicate: Node



7718
7719
7720
 
# File 'lib/prism/node.rb', line 7718

def predicate
  @predicate
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



7724
7725
7726
 
# File 'lib/prism/node.rb', line 7724

def statements
  @statements
end

#then_keyword_loc ⇒ Object (readonly)

attr_reader then_keyword_loc: Location?



7721
7722
7723
 
# File 'lib/prism/node.rb', line 7721

def then_keyword_loc
  @then_keyword_loc
end

Class Method Details

.type ⇒ Object

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. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



7854
7855
7856
 
# File 'lib/prism/node.rb', line 7854

def self.type
  :if_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



7744
7745
7746
 
# File 'lib/prism/node.rb', line 7744

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

#child_nodes ⇒ Object Also known as: deconstruct

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



7753
7754
7755
 
# File 'lib/prism/node.rb', line 7753

def child_nodes
  [predicate, statements, consequent]
end

#comment_targets ⇒ Object

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



7767
7768
7769
 
# File 'lib/prism/node.rb', line 7767

def comment_targets
  [*if_keyword_loc, predicate, *then_keyword_loc, *statements, *consequent, *end_keyword_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



7758
7759
7760
7761
7762
7763
7764
 
# File 'lib/prism/node.rb', line 7758

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

#copy(**params) ⇒ Object

def copy: (**params) -> IfNode



7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
 
# File 'lib/prism/node.rb', line 7772

def copy(**params)
  IfNode.new(
    params.fetch(:if_keyword_loc) { if_keyword_loc },
    params.fetch(:predicate) { predicate },
    params.fetch(:then_keyword_loc) { then_keyword_loc },
    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]



7788
7789
7790
 
# File 'lib/prism/node.rb', line 7788

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

#end_keyword ⇒ Object

def end_keyword: () -> String?



7803
7804
7805
 
# File 'lib/prism/node.rb', line 7803

def end_keyword
  end_keyword_loc&.slice
end

#if_keyword ⇒ Object

def if_keyword: () -> String?



7793
7794
7795
 
# File 'lib/prism/node.rb', line 7793

def if_keyword
  if_keyword_loc&.slice
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
 
# File 'lib/prism/node.rb', line 7808

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── if_keyword_loc: #{inspector.location(if_keyword_loc)}\n"
  inspector << "├── predicate:\n"
  inspector << inspector.child_node(predicate, "│   ")
  inspector << "├── then_keyword_loc: #{inspector.location(then_keyword_loc)}\n"
  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

#set_newline_flag(newline_marked) ⇒ Object

:nodoc:



7748
7749
7750
 
# File 'lib/prism/node.rb', line 7748

def set_newline_flag(newline_marked) # :nodoc:
  predicate.set_newline_flag(newline_marked)
end

#then_keyword ⇒ Object

def then_keyword: () -> String?



7798
7799
7800
 
# File 'lib/prism/node.rb', line 7798

def then_keyword
  then_keyword_loc&.slice
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



7844
7845
7846
 
# File 'lib/prism/node.rb', line 7844

def type
  :if_node
end