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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

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



16491
16492
16493
16494
16495
16496
16497
16498
16499
 
# File 'lib/prism/node.rb', line 16491

def initialize(keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc, location)
  @keyword_loc = 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: ElseNode?



16485
16486
16487
 
# File 'lib/prism/node.rb', line 16485

def consequent
  @consequent
end

#end_keyword_loc ⇒ Object (readonly)

attr_reader end_keyword_loc: Location?



16488
16489
16490
 
# File 'lib/prism/node.rb', line 16488

def end_keyword_loc
  @end_keyword_loc
end

#keyword_loc ⇒ Object (readonly)

attr_reader keyword_loc: Location



16473
16474
16475
 
# File 'lib/prism/node.rb', line 16473

def keyword_loc
  @keyword_loc
end

#predicate ⇒ Object (readonly)

attr_reader predicate: Node



16476
16477
16478
 
# File 'lib/prism/node.rb', line 16476

def predicate
  @predicate
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



16482
16483
16484
 
# File 'lib/prism/node.rb', line 16482

def statements
  @statements
end

#then_keyword_loc ⇒ Object (readonly)

attr_reader then_keyword_loc: Location?



16479
16480
16481
 
# File 'lib/prism/node.rb', line 16479

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



16612
16613
16614
 
# File 'lib/prism/node.rb', line 16612

def self.type
  :unless_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



16502
16503
16504
 
# File 'lib/prism/node.rb', line 16502

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

#child_nodes ⇒ Object Also known as: deconstruct

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



16511
16512
16513
 
# File 'lib/prism/node.rb', line 16511

def child_nodes
  [predicate, statements, consequent]
end

#comment_targets ⇒ Object

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



16525
16526
16527
 
# File 'lib/prism/node.rb', line 16525

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



16516
16517
16518
16519
16520
16521
16522
 
# File 'lib/prism/node.rb', line 16516

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

#copy(**params) ⇒ Object

def copy: (**params) -> UnlessNode



16530
16531
16532
16533
16534
16535
16536
16537
16538
16539
16540
 
# File 'lib/prism/node.rb', line 16530

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



16546
16547
16548
 
# File 'lib/prism/node.rb', line 16546

def deconstruct_keys(keys)
  { keyword_loc: 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?



16561
16562
16563
 
# File 'lib/prism/node.rb', line 16561

def end_keyword
  end_keyword_loc&.slice
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



16566
16567
16568
16569
16570
16571
16572
16573
16574
16575
16576
16577
16578
16579
16580
16581
16582
16583
16584
16585
16586
 
# File 'lib/prism/node.rb', line 16566

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, "│   ")
  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

#keyword ⇒ Object

def keyword: () -> String



16551
16552
16553
 
# File 'lib/prism/node.rb', line 16551

def keyword
  keyword_loc.slice
end

#set_newline_flag(newline_marked) ⇒ Object

:nodoc:



16506
16507
16508
 
# File 'lib/prism/node.rb', line 16506

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

#then_keyword ⇒ Object

def then_keyword: () -> String?



16556
16557
16558
 
# File 'lib/prism/node.rb', line 16556

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



16602
16603
16604
 
# File 'lib/prism/node.rb', line 16602

def type
  :unless_node
end