Represents a singleton class declaration involving the ‘class` keyword.
class << self end ^^^^^^^^^^^^^^^^^
attr_reader class_keyword_loc: Location
attr_reader operator_loc: Location
attr_reader expression: Node
attr_reader end_keyword_loc: Location
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15302
def initialize(locals, class_keyword_loc, operator_loc, expression, body, end_keyword_loc, location)
@locals = locals
@class_keyword_loc = class_keyword_loc
@operator_loc = operator_loc
@expression = expression
@body = body
@end_keyword_loc = end_keyword_loc
@location = location
end
def initialize: (locals: Array, class_keyword_loc: Location, operator_loc: Location, expression: Node, body: Node?, end_keyword_loc: Location, location: Location) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15413
def self.type
:singleton_class_node
end
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 tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15313
def accept(visitor)
visitor.visit_singleton_class_node(self)
end
def accept: (visitor: Visitor) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15318
def child_nodes
[expression, body]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15357
def class_keyword
class_keyword_loc.slice
end
def class_keyword: () -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15331
def comment_targets
[class_keyword_loc, operator_loc, expression, *body, end_keyword_loc]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15323
def compact_child_nodes
compact = []
compact << expression
compact << body if body
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15336
def copy(**params)
SingletonClassNode.new(
params.fetch(:locals) { locals },
params.fetch(:class_keyword_loc) { class_keyword_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:expression) { expression },
params.fetch(:body) { body },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:location) { location },
)
end
def copy: (**params) -> SingletonClassNode
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15352
def deconstruct_keys(keys)
{ locals: locals, class_keyword_loc: class_keyword_loc, operator_loc: operator_loc, expression: expression, body: body, end_keyword_loc: end_keyword_loc, location: location }
end
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15367
def end_keyword
end_keyword_loc.slice
end
def end_keyword: () -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15372
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── locals: #{locals.inspect}\n"
inspector << "├── class_keyword_loc: #{inspector.location(class_keyword_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "├── expression:\n"
inspector << inspector.child_node(expression, "│ ")
if (body = self.body).nil?
inspector << "├── body: ∅\n"
else
inspector << "├── body:\n"
inspector << body.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector.to_str
end
def inspect(inspector: NodeInspector) -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15362
def operator
operator_loc.slice
end
def operator: () -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 15403
def type
:singleton_class_node
end
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