Class: Prism::EnsureNode

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

Overview

Represents an ‘ensure` clause in a `begin` statement.

begin
  foo
ensure
^^^^^^
  bar
end

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ensure_keyword_loc, statements, end_keyword_loc, location) ⇒ EnsureNode

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



5907
5908
5909
5910
5911
5912
 
# File 'lib/prism/node.rb', line 5907

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

Instance Attribute Details

#end_keyword_loc ⇒ Object (readonly)

attr_reader end_keyword_loc: Location



5904
5905
5906
 
# File 'lib/prism/node.rb', line 5904

def end_keyword_loc
  @end_keyword_loc
end

#ensure_keyword_loc ⇒ Object (readonly)

attr_reader ensure_keyword_loc: Location



5898
5899
5900
 
# File 'lib/prism/node.rb', line 5898

def ensure_keyword_loc
  @ensure_keyword_loc
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



5901
5902
5903
 
# File 'lib/prism/node.rb', line 5901

def statements
  @statements
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



6002
6003
6004
 
# File 'lib/prism/node.rb', line 6002

def self.type
  :ensure_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



5915
5916
5917
 
# File 'lib/prism/node.rb', line 5915

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

#child_nodes ⇒ Object Also known as: deconstruct

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



5920
5921
5922
 
# File 'lib/prism/node.rb', line 5920

def child_nodes
  [statements]
end

#comment_targets ⇒ Object

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



5932
5933
5934
 
# File 'lib/prism/node.rb', line 5932

def comment_targets
  [ensure_keyword_loc, *statements, end_keyword_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



5925
5926
5927
5928
5929
 
# File 'lib/prism/node.rb', line 5925

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

#copy(**params) ⇒ Object

def copy: (**params) -> EnsureNode



5937
5938
5939
5940
5941
5942
5943
5944
 
# File 'lib/prism/node.rb', line 5937

def copy(**params)
  EnsureNode.new(
    params.fetch(:ensure_keyword_loc) { ensure_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]



5950
5951
5952
 
# File 'lib/prism/node.rb', line 5950

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

#end_keyword ⇒ Object

def end_keyword: () -> String



5960
5961
5962
 
# File 'lib/prism/node.rb', line 5960

def end_keyword
  end_keyword_loc.slice
end

#ensure_keyword ⇒ Object

def ensure_keyword: () -> String



5955
5956
5957
 
# File 'lib/prism/node.rb', line 5955

def ensure_keyword
  ensure_keyword_loc.slice
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
 
# File 'lib/prism/node.rb', line 5965

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── ensure_keyword_loc: #{inspector.location(ensure_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



5992
5993
5994
 
# File 'lib/prism/node.rb', line 5992

def type
  :ensure_node
end