class Prism::DefinedNode

Represents the use of the ‘defined?` keyword.

defined?(a)
^^^^^^^^^^^

Attributes

keyword_loc[R]

attr_reader keyword_loc: Location

lparen_loc[R]

attr_reader lparen_loc: Location?

rparen_loc[R]

attr_reader rparen_loc: Location?

value[R]

attr_reader value: Node

Public Class Methods

new(lparen_loc, value, rparen_loc, keyword_loc, location) click to toggle source

def initialize: (lparen_loc: Location?, value: Node, rparen_loc: Location?, keyword_loc: Location, location: Location) -> void

# File lib/prism/node.rb, line 5458
def initialize(lparen_loc, value, rparen_loc, keyword_loc, location)
  @lparen_loc = lparen_loc
  @value = value
  @rparen_loc = rparen_loc
  @keyword_loc = keyword_loc
  @location = location
end

type() click to toggle source

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

# File lib/prism/node.rb, line 5555
def self.type
  :defined_node
end

Public Instance Methods

accept(visitor) click to toggle source

def accept: (visitor: Visitor) -> void

# File lib/prism/node.rb, line 5467
def accept(visitor)
  visitor.visit_defined_node(self)
end

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 5472
def child_nodes
  [value]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 5482
def comment_targets
  [*lparen_loc, value, *rparen_loc, keyword_loc]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 5477
def compact_child_nodes
  [value]
end

copy(**params) click to toggle source

def copy: (**params) -> DefinedNode

# File lib/prism/node.rb, line 5487
def copy(**params)
  DefinedNode.new(
    params.fetch(:lparen_loc) { lparen_loc },
    params.fetch(:value) { value },
    params.fetch(:rparen_loc) { rparen_loc },
    params.fetch(:keyword_loc) { keyword_loc },
    params.fetch(:location) { location },
  )
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

# File lib/prism/node.rb, line 5501
def deconstruct_keys(keys)
  { lparen_loc: lparen_loc, value: value, rparen_loc: rparen_loc, keyword_loc: keyword_loc, location: location }
end

inspect(inspector = NodeInspector.new) click to toggle source

def inspect(inspector: NodeInspector) -> String

# File lib/prism/node.rb, line 5521
def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n"
  inspector << "├── value:\n"
  inspector << inspector.child_node(value, "│   ")
  inspector << "├── rparen_loc: #{inspector.location(rparen_loc)}\n"
  inspector << "└── keyword_loc: #{inspector.location(keyword_loc)}\n"
  inspector.to_str
end

keyword() click to toggle source

def keyword: () -> String

# File lib/prism/node.rb, line 5516
def keyword
  keyword_loc.slice
end

lparen() click to toggle source

def lparen: () -> String?

# File lib/prism/node.rb, line 5506
def lparen
  lparen_loc&.slice
end

rparen() click to toggle source

def rparen: () -> String?

# File lib/prism/node.rb, line 5511
def rparen
  rparen_loc&.slice
end

type() click to toggle source

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

# File lib/prism/node.rb, line 5545
def type
  :defined_node
end