Represents a module declaration involving the ‘module` keyword.
module Foo end ^^^^^^^^^^^^^^
attr_reader constant_path: Prism::node
attr_reader body: Prism::node?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 13142
def initialize(source, locals, module_keyword_loc, constant_path, body, end_keyword_loc, name, location)
@source = source
@location = location
@locals = locals
@module_keyword_loc = module_keyword_loc
@constant_path = constant_path
@body = body
@end_keyword_loc = end_keyword_loc
@name = name
end
def initialize: (Array locals, Location module_keyword_loc, Prism::node constant_path, Prism::node? body, Location end_keyword_loc, Symbol name, Location location) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 13254
def self.type
:module_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.4.0-preview1/lib/prism/node.rb, line 13260
def ===(other)
other.is_a?(ModuleNode) &&
(locals.length == other.locals.length) &&
locals.zip(other.locals).all? { |left, right| left === right } &&
(module_keyword_loc.nil? == other.module_keyword_loc.nil?) &&
(constant_path === other.constant_path) &&
(body === other.body) &&
(end_keyword_loc.nil? == other.end_keyword_loc.nil?) &&
(name === other.name)
end
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 13154
def accept(visitor)
visitor.visit_module_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 13159
def child_nodes
[constant_path, body]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 13172
def comment_targets
[module_keyword_loc, constant_path, *body, end_keyword_loc] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 13164
def compact_child_nodes
compact = [] #: Array[Prism::node]
compact << constant_path
compact << body if body
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 13177
def copy(locals: self.locals, module_keyword_loc: self.module_keyword_loc, constant_path: self.constant_path, body: self.body, end_keyword_loc: self.end_keyword_loc, name: self.name, location: self.location)
ModuleNode.new(source, locals, module_keyword_loc, constant_path, body, end_keyword_loc, name, location)
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 13185
def deconstruct_keys(keys)
{ locals: locals, module_keyword_loc: module_keyword_loc, constant_path: constant_path, body: body, end_keyword_loc: end_keyword_loc, name: name, location: location }
end
def deconstruct_keys: (Array keys) -> { locals: Array, module_keyword_loc: Location, constant_path: Prism::node, body: Prism::node?, end_keyword_loc: Location, name: Symbol, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 13221
def end_keyword
end_keyword_loc.slice
end
def end_keyword: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 13206
def end_keyword_loc
location = @end_keyword_loc
return location if location.is_a?(Location)
@end_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
attr_reader end_keyword_loc: Location
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 13226
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 13216
def module_keyword
module_keyword_loc.slice
end
def module_keyword: () -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 13193
def module_keyword_loc
location = @module_keyword_loc
return location if location.is_a?(Location)
@module_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
attr_reader module_keyword_loc: Location
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 13244
def type
:module_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