Class: YARP::EnsureNode

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

Overview

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

begin
  foo
ensure
^^^^^^
  bar
end

Instance Attribute 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



3887
3888
3889
3890
3891
3892
 
# File 'lib/yarp/node.rb', line 3887

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



3884
3885
3886
 
# File 'lib/yarp/node.rb', line 3884

def end_keyword_loc
  @end_keyword_loc
end

#ensure_keyword_loc ⇒ Object (readonly)

attr_reader ensure_keyword_loc: Location



3878
3879
3880
 
# File 'lib/yarp/node.rb', line 3878

def ensure_keyword_loc
  @ensure_keyword_loc
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



3881
3882
3883
 
# File 'lib/yarp/node.rb', line 3881

def statements
  @statements
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



3895
3896
3897
 
# File 'lib/yarp/node.rb', line 3895

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

#child_nodes ⇒ Object Also known as: deconstruct

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



3900
3901
3902
 
# File 'lib/yarp/node.rb', line 3900

def child_nodes
  [statements]
end

#comment_targets ⇒ Object

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



3905
3906
3907
 
# File 'lib/yarp/node.rb', line 3905

def comment_targets
  [ensure_keyword_loc, *statements, end_keyword_loc]
end

#copy(**params) ⇒ Object

def copy: (**params) -> EnsureNode



3910
3911
3912
3913
3914
3915
3916
3917
 
# File 'lib/yarp/node.rb', line 3910

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]



3923
3924
3925
 
# File 'lib/yarp/node.rb', line 3923

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



3933
3934
3935
 
# File 'lib/yarp/node.rb', line 3933

def end_keyword
  end_keyword_loc.slice
end

#ensure_keyword ⇒ Object

def ensure_keyword: () -> String



3928
3929
3930
 
# File 'lib/yarp/node.rb', line 3928

def ensure_keyword
  ensure_keyword_loc.slice
end

#inspect(inspector = NodeInspector.new) ⇒ Object 



3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
 
# File 'lib/yarp/node.rb', line 3937

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