123456789_123456789_123456789_123456789_123456789_

Class: Prism::ModuleNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PrismNode
Instance Chain:
self, PrismNode
Inherits: PrismNode
Defined in: lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents a module declaration involving the module keyword.

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

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, locals, module_keyword_loc, constant_path, body, end_keyword_loc, name) ⇒ ModuleNode

Initialize a new ModuleNode node.

[ GitHub ] 

  


# File 'lib/prism/node.rb', line 11340



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


  







Class Method Details



  

    .type  
  



  

    
Return a symbol representation of this node type. See Node::type.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11432



def self.type
  :module_node
end


  







Instance Attribute Details



  

    #body   (readonly)
  



  

    
attr_reader body: Prism.node?

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11401



attr_reader :body


  








  

    #constant_path   (readonly)
  



  

    
attr_reader constant_path: Prism.node

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11399



attr_reader :constant_path


  








  

    #locals   (readonly)
  



  

    
attr_reader locals: Array

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11390



attr_reader :locals


  








  

    #name   (readonly)
  



  

    
attr_reader name: Symbol

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11410



attr_reader :name


  







Instance Method Details



  

    #===(other)  
  



  

    
Implements case-equality for the node. This is effectively == but without
comparing the value of locations. Locations are checked only for presence.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11438



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)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11354



def accept(visitor)
  visitor.visit_module_node(self)
end


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11359



def child_nodes
  [constant_path, body]
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11372



def comment_targets
  [module_keyword_loc, constant_path, *body, end_keyword_loc] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11364



def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << constant_path
  compact << body if body
  compact
end


  








  

    #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)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11377



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


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11382



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, locals: Array, module_keyword_loc: Location, constant_path: Prism.node, body: Prism.node?, end_keyword_loc: Location, name: Symbol }

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11385



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


  








  

    #end_keyword  
  



  

    
def end_keyword: () -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11417



def end_keyword
  end_keyword_loc.slice
end


  








  

    #end_keyword_loc  
  



  

    
attr_reader end_keyword_loc: Location

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11403



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  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11422



def inspect
  InspectVisitor.compose(self)
end


  








  

    #module_keyword  
  



  

    
def module_keyword: () -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11412



def module_keyword
  module_keyword_loc.slice
end


  








  

    #module_keyword_loc  
  



  

    
attr_reader module_keyword_loc: Location

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11392



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  
  



  

    
Return a symbol representation of this node type. See Node#type.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 11427



def type
  :module_node
end