Represents a module declaration involving the ‘module` keyword.
module Foo end ^^^^^^^^^^^^^^
attr_reader constant_path: ConstantReadNode | ConstantPathNode | MissingNode
attr_reader body: StatementsNode | BeginNode | nil
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 12880
def initialize(source, node_id, location, flags, locals, module_keyword_loc, constant_path, body, end_keyword_loc, name)
@source = source
@node_id = node_id
@location = location
@flags = flags
@locals = locals
@module_keyword_loc = module_keyword_loc
@constant_path = constant_path
@body = body
@end_keyword_loc = end_keyword_loc
@name = name
end
Initialize a new ModuleNode node.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 12988
def self.type
:module_node
end
Return a symbol representation of this node type. See ‘Node::type`.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 12994
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.1/lib/prism/node.rb, line 12894
def accept(visitor)
visitor.visit_module_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 12899
def child_nodes
[constant_path, body]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 12912
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.1/lib/prism/node.rb, line 12904
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.1/lib/prism/node.rb, line 12917
def copy(node_id: self.node_id, location: self.location, flags: self.flags, 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)
ModuleNode.new(source, node_id, location, flags, locals, module_keyword_loc, constant_path, body, end_keyword_loc, name)
end
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?locals: Array, ?module_keyword_loc: Location, ?constant_path: ConstantReadNode | ConstantPathNode | MissingNode, ?body: StatementsNode | BeginNode | nil, ?end_keyword_loc: Location, ?name: Symbol) -> ModuleNode
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 12925
def deconstruct_keys(keys)
{ node_id: node_id, 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 deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, locals: Array, module_keyword_loc: Location, constant_path: ConstantReadNode | ConstantPathNode | MissingNode, body: StatementsNode | BeginNode | nil, end_keyword_loc: Location, name: Symbol }
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 12973
def end_keyword
end_keyword_loc.slice
end
def end_keyword: () -> String
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 12952
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.1/lib/prism/node.rb, line 12978
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 12968
def module_keyword
module_keyword_loc.slice
end
def module_keyword: () -> String
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 12933
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.1/lib/prism/node.rb, line 12960
def save_end_keyword_loc(repository)
repository.enter(node_id, :end_keyword_loc)
end
Save the end_keyword_loc location using the given saved source so that it can be retrieved later.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 12941
def save_module_keyword_loc(repository)
repository.enter(node_id, :module_keyword_loc)
end
Save the module_keyword_loc location using the given saved source so that it can be retrieved later.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 12983
def type
:module_node
end
Return a symbol representation of this node type. See ‘Node#type`.