Class: Prism::UndefNode

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

Overview

Represents the use of the ‘undef` keyword.

undef :foo, :bar, :baz
^^^^^^^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(names, keyword_loc, location) ⇒ UndefNode

def initialize: (names: Array, keyword_loc: Location, location: Location) -> void



16379
16380
16381
16382
16383
 
# File 'lib/prism/node.rb', line 16379

def initialize(names, keyword_loc, location)
  @names = names
  @keyword_loc = keyword_loc
  @location = location
end

Instance Attribute Details

#keyword_loc ⇒ Object (readonly)

attr_reader keyword_loc: Location



16376
16377
16378
 
# File 'lib/prism/node.rb', line 16376

def keyword_loc
  @keyword_loc
end

#names ⇒ Object (readonly)

attr_reader names: Array



16373
16374
16375
 
# File 'lib/prism/node.rb', line 16373

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



16459
16460
16461
 
# File 'lib/prism/node.rb', line 16459

def self.type
  :undef_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



16386
16387
16388
 
# File 'lib/prism/node.rb', line 16386

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

#child_nodes ⇒ Object Also known as: deconstruct

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



16391
16392
16393
 
# File 'lib/prism/node.rb', line 16391

def child_nodes
  [*names]
end

#comment_targets ⇒ Object

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



16401
16402
16403
 
# File 'lib/prism/node.rb', line 16401

def comment_targets
  [*names, keyword_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



16396
16397
16398
 
# File 'lib/prism/node.rb', line 16396

def compact_child_nodes
  [*names]
end

#copy(**params) ⇒ Object

def copy: (**params) -> UndefNode



16406
16407
16408
16409
16410
16411
16412
 
# File 'lib/prism/node.rb', line 16406

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



16418
16419
16420
 
# File 'lib/prism/node.rb', line 16418

def deconstruct_keys(keys)
  { names: names, keyword_loc: keyword_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



16428
16429
16430
16431
16432
16433
 
# File 'lib/prism/node.rb', line 16428

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── names: #{inspector.list("#{inspector.prefix}│   ", names)}"
  inspector << "└── keyword_loc: #{inspector.location(keyword_loc)}\n"
  inspector.to_str
end

#keyword ⇒ Object

def keyword: () -> String



16423
16424
16425
 
# File 'lib/prism/node.rb', line 16423

def keyword
  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



16449
16450
16451
 
# File 'lib/prism/node.rb', line 16449

def type
  :undef_node
end