Represents a module declaration involving the ‘module` keyword.
module Foo end ^^^^^^^^^^^^^^
attr_reader module_keyword_loc: Location
attr_reader constant_path: Node
attr_reader end_keyword_loc: Location
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 11995
def initialize(locals, module_keyword_loc, constant_path, body, end_keyword_loc, name, location)
@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 initialize: (locals: Array, module_keyword_loc: Location, constant_path: Node, body: Node?, end_keyword_loc: Location, name: Symbol, location: Location) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12101
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.3.0/lib/prism/node.rb, line 12006
def accept(visitor)
visitor.visit_module_node(self)
end
def accept: (visitor: Visitor) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12011
def child_nodes
[constant_path, body]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12024
def comment_targets
[module_keyword_loc, constant_path, *body, end_keyword_loc]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12016
def compact_child_nodes
compact = []
compact << constant_path
compact << body if body
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12029
def copy(**params)
ModuleNode.new(
params.fetch(:locals) { locals },
params.fetch(:module_keyword_loc) { module_keyword_loc },
params.fetch(:constant_path) { constant_path },
params.fetch(:body) { body },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:name) { name },
params.fetch(:location) { location },
)
end
def copy: (**params) -> ModuleNode
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12045
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
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12055
def end_keyword
end_keyword_loc.slice
end
def end_keyword: () -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12060
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── locals: #{locals.inspect}\n"
inspector << "├── module_keyword_loc: #{inspector.location(module_keyword_loc)}\n"
inspector << "├── constant_path:\n"
inspector << inspector.child_node(constant_path, "│ ")
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 << "└── name: #{name.inspect}\n"
inspector.to_str
end
def inspect(inspector: NodeInspector) -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12050
def module_keyword
module_keyword_loc.slice
end
def module_keyword: () -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 12091
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