Class: Prism::ElseNode

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

Overview

Represents an ‘else` clause in a `case`, `if`, or `unless` statement.

if a then b else c end
            ^^^^^^^^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(else_keyword_loc, statements, end_keyword_loc, location) ⇒ ElseNode

def initialize: (else_keyword_loc: Location, statements: StatementsNode?, end_keyword_loc: Location?, location: Location) -> void



4839
4840
4841
4842
4843
4844
 
# File 'lib/prism/node.rb', line 4839

def initialize(else_keyword_loc, statements, end_keyword_loc, location)
  @else_keyword_loc = else_keyword_loc
  @statements = statements
  @end_keyword_loc = end_keyword_loc
  @location = location
end

Instance Attribute Details

#else_keyword_loc ⇒ Object (readonly)

attr_reader else_keyword_loc: Location



4830
4831
4832
 
# File 'lib/prism/node.rb', line 4830

def else_keyword_loc
  @else_keyword_loc
end

#end_keyword_loc ⇒ Object (readonly)

attr_reader end_keyword_loc: Location?



4836
4837
4838
 
# File 'lib/prism/node.rb', line 4836

def end_keyword_loc
  @end_keyword_loc
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



4833
4834
4835
 
# File 'lib/prism/node.rb', line 4833

def statements
  @statements
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



4847
4848
4849
 
# File 'lib/prism/node.rb', line 4847

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

#child_nodes ⇒ Object Also known as: deconstruct

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



4852
4853
4854
 
# File 'lib/prism/node.rb', line 4852

def child_nodes
  [statements]
end

#comment_targets ⇒ Object

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



4864
4865
4866
 
# File 'lib/prism/node.rb', line 4864

def comment_targets
  [else_keyword_loc, *statements, *end_keyword_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



4857
4858
4859
4860
4861
 
# File 'lib/prism/node.rb', line 4857

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

#copy(**params) ⇒ Object

def copy: (**params) -> ElseNode



4869
4870
4871
4872
4873
4874
4875
4876
 
# File 'lib/prism/node.rb', line 4869

def copy(**params)
  ElseNode.new(
    params.fetch(:else_keyword_loc) { else_keyword_loc },
    params.fetch(:statements) { statements },
    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]



4882
4883
4884
 
# File 'lib/prism/node.rb', line 4882

def deconstruct_keys(keys)
  { else_keyword_loc: else_keyword_loc, statements: statements, end_keyword_loc: end_keyword_loc, location: location }
end

#else_keyword ⇒ Object

def else_keyword: () -> String



4887
4888
4889
 
# File 'lib/prism/node.rb', line 4887

def else_keyword
  else_keyword_loc.slice
end

#end_keyword ⇒ Object

def end_keyword: () -> String?



4892
4893
4894
 
# File 'lib/prism/node.rb', line 4892

def end_keyword
  end_keyword_loc&.slice
end

#inspect(inspector = NodeInspector.new) ⇒ Object 



4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
 
# File 'lib/prism/node.rb', line 4896

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── else_keyword_loc: #{inspector.location(else_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
  inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
  inspector.to_str
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



4923
4924
4925
 
# File 'lib/prism/node.rb', line 4923

def type
  :else_node
end