class Prism::DefNode

Represents a method definition.

def method
end
^^^^^^^^^^

Attributes

body[R]

attr_reader body: Prism::node?

locals[R]

attr_reader locals: Array

name[R]

attr_reader name: Symbol

parameters[R]

attr_reader parameters: ParametersNode?

receiver[R]

attr_reader receiver: Prism::node?

Public Class Methods

new(source, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc, location) click to toggle source

def initialize: (Symbol name, Location name_loc, Prism::node? receiver, ParametersNode? parameters, Prism::node? body, Array locals, Location def_keyword_loc, Location? operator_loc, Location? lparen_loc, Location? rparen_loc, Location? equal_loc, Location? end_keyword_loc, Location location) -> void

# File lib/prism/node.rb, line 5792
def initialize(source, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc, location)
  @source = source
  @newline = false
  @location = location
  @name = name
  @name_loc = name_loc
  @receiver = receiver
  @parameters = parameters
  @body = body
  @locals = locals
  @def_keyword_loc = def_keyword_loc
  @operator_loc = operator_loc
  @lparen_loc = lparen_loc
  @rparen_loc = rparen_loc
  @equal_loc = equal_loc
  @end_keyword_loc = end_keyword_loc
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 6000
def self.type
  :def_node
end

Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

# File lib/prism/node.rb, line 6006
def ===(other)
  other.is_a?(DefNode) &&
    (name === other.name) &&
    (name_loc.nil? == other.name_loc.nil?) &&
    (receiver === other.receiver) &&
    (parameters === other.parameters) &&
    (body === other.body) &&
    (locals.length == other.locals.length) &&
    locals.zip(other.locals).all? { |left, right| left === right } &&
    (def_keyword_loc.nil? == other.def_keyword_loc.nil?) &&
    (operator_loc.nil? == other.operator_loc.nil?) &&
    (lparen_loc.nil? == other.lparen_loc.nil?) &&
    (rparen_loc.nil? == other.rparen_loc.nil?) &&
    (equal_loc.nil? == other.equal_loc.nil?) &&
    (end_keyword_loc.nil? == other.end_keyword_loc.nil?)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

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

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 5816
def child_nodes
  [receiver, parameters, body]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 5830
def comment_targets
  [name_loc, *receiver, *parameters, *body, def_keyword_loc, *operator_loc, *lparen_loc, *rparen_loc, *equal_loc, *end_keyword_loc] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 5821
def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << receiver if receiver
  compact << parameters if parameters
  compact << body if body
  compact
end

copy(name: self.name, name_loc: self.name_loc, receiver: self.receiver, parameters: self.parameters, body: self.body, locals: self.locals, def_keyword_loc: self.def_keyword_loc, operator_loc: self.operator_loc, lparen_loc: self.lparen_loc, rparen_loc: self.rparen_loc, equal_loc: self.equal_loc, end_keyword_loc: self.end_keyword_loc, location: self.location) click to toggle source

def copy: (?name: Symbol, ?name_loc: Location, ?receiver: Prism::node?, ?parameters: ParametersNode?, ?body: Prism::node?, ?locals: Array, ?def_keyword_loc: Location, ?operator_loc: Location?, ?lparen_loc: Location?, ?rparen_loc: Location?, ?equal_loc: Location?, ?end_keyword_loc: Location?, ?location: Location) -> DefNode

# File lib/prism/node.rb, line 5835
def copy(name: self.name, name_loc: self.name_loc, receiver: self.receiver, parameters: self.parameters, body: self.body, locals: self.locals, def_keyword_loc: self.def_keyword_loc, operator_loc: self.operator_loc, lparen_loc: self.lparen_loc, rparen_loc: self.rparen_loc, equal_loc: self.equal_loc, end_keyword_loc: self.end_keyword_loc, location: self.location)
  DefNode.new(source, name, name_loc, receiver, parameters, body, locals, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc, location)
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { name: Symbol, name_loc: Location, receiver: Prism::node?, parameters: ParametersNode?, body: Prism::node?, locals: Array, def_keyword_loc: Location, operator_loc: Location?, lparen_loc: Location?, rparen_loc: Location?, equal_loc: Location?, end_keyword_loc: Location?, location: Location }

# File lib/prism/node.rb, line 5843
def deconstruct_keys(keys)
  { name: name, name_loc: name_loc, receiver: receiver, parameters: parameters, body: body, locals: locals, def_keyword_loc: def_keyword_loc, operator_loc: operator_loc, lparen_loc: lparen_loc, rparen_loc: rparen_loc, equal_loc: equal_loc, end_keyword_loc: end_keyword_loc, location: location }
end

def_keyword() click to toggle source

def def_keyword: () -> String

# File lib/prism/node.rb, line 5942
def def_keyword
  def_keyword_loc.slice
end

def_keyword_loc() click to toggle source

attr_reader def_keyword_loc: Location

# File lib/prism/node.rb, line 5870
def def_keyword_loc
  location = @def_keyword_loc
  return location if location.is_a?(Location)
  @def_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

end_keyword() click to toggle source

def end_keyword: () -> String?

# File lib/prism/node.rb, line 5967
def end_keyword
  end_keyword_loc&.slice
end

end_keyword_loc() click to toggle source

attr_reader end_keyword_loc: Location?

# File lib/prism/node.rb, line 5929
def end_keyword_loc
  location = @end_keyword_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @end_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

equal() click to toggle source

def equal: () -> String?

# File lib/prism/node.rb, line 5962
def equal
  equal_loc&.slice
end

equal_loc() click to toggle source

attr_reader equal_loc: Location?

# File lib/prism/node.rb, line 5916
def equal_loc
  location = @equal_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @equal_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

inspect() click to toggle source

def inspect -> String

# File lib/prism/node.rb, line 5972
def inspect
  InspectVisitor.compose(self)
end

lparen() click to toggle source

def lparen: () -> String?

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

lparen_loc() click to toggle source

attr_reader lparen_loc: Location?

# File lib/prism/node.rb, line 5890
def lparen_loc
  location = @lparen_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @lparen_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

name_loc() click to toggle source

attr_reader name_loc: Location

# File lib/prism/node.rb, line 5851
def name_loc
  location = @name_loc
  return location if location.is_a?(Location)
  @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

operator() click to toggle source

def operator: () -> String?

# File lib/prism/node.rb, line 5947
def operator
  operator_loc&.slice
end

operator_loc() click to toggle source

attr_reader operator_loc: Location?

# File lib/prism/node.rb, line 5877
def operator_loc
  location = @operator_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

rparen() click to toggle source

def rparen: () -> String?

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

rparen_loc() click to toggle source

attr_reader rparen_loc: Location?

# File lib/prism/node.rb, line 5903
def rparen_loc
  location = @rparen_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @rparen_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
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 5990
def type
  :def_node
end