class Prism::ModuleNode

Represents a module declaration involving the ‘module` keyword.

module Foo end
^^^^^^^^^^^^^^

Attributes

body[R]

attr_reader body: Prism::node?

constant_path[R]

attr_reader constant_path: Prism::node

locals[R]

attr_reader locals: Array

name[R]

attr_reader name: Symbol

Public Class Methods

new(source, locals, module_keyword_loc, constant_path, body, end_keyword_loc, name, location) click to toggle source

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 lib/prism/node.rb, line 13226
def initialize(source, locals, module_keyword_loc, constant_path, body, end_keyword_loc, name, location)
  @source = source
  @newline = false
  @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

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 13339
def self.type
  :module_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 13345
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

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

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

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 13244
def child_nodes
  [constant_path, body]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 13257
def comment_targets
  [module_keyword_loc, constant_path, *body, 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 13249
def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << constant_path
  compact << body if body
  compact
end

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) click to toggle source

def copy: (?locals: Array, ?module_keyword_loc: Location, ?constant_path: Prism::node, ?body: Prism::node?, ?end_keyword_loc: Location, ?name: Symbol, ?location: Location) -> ModuleNode

# File lib/prism/node.rb, line 13262
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

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

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 lib/prism/node.rb, line 13270
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

end_keyword() click to toggle source

def end_keyword: () -> String

# File lib/prism/node.rb, line 13306
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 13291
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

inspect() click to toggle source

def inspect -> String

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

module_keyword() click to toggle source

def module_keyword: () -> String

# File lib/prism/node.rb, line 13301
def module_keyword
  module_keyword_loc.slice
end

module_keyword_loc() click to toggle source

attr_reader module_keyword_loc: Location

# File lib/prism/node.rb, line 13278
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

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 13329
def type
  :module_node
end