Class: Prism::ModuleNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `Node`
Instance Chain: self, `Node`
Inherits:	Prism::Node `::Object` Prism::Node Prism::ModuleNode
Defined in:	lib/prism/node.rb, prism/api_node.c

Overview

Represents a module declaration involving the module keyword.

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

Class Method Summary

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

Initialize a new ModuleNode node.
.type

Return a symbol representation of this node type.

`Node` - Inherited

.fields	Returns a list of the fields that exist for this node class.
.type	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.

Instance Attribute Summary

#body readonly

attr_reader body: StatementsNode | BeginNode | nil.
#constant_path readonly

attr_reader constant_path: ConstantReadNode | ConstantPathNode | MissingNode.
#locals readonly

attr_reader locals: Array.
#name readonly

attr_reader name: Symbol.

`Node` - Inherited

#newline?	Returns true if the node has the newline flag set.
#node_id	A unique identifier for this node.
#static_literal?	Returns true if the node has the static literal flag set.
#flags	An bitset of flags for this node.
#source	A pointer to the source that this node was created from.
#newline_flag?

Instance Method Summary

#===(other)

Implements case-equality for the node.
#accept(visitor)

def accept: (Visitor visitor) -> void.
#child_nodes (also: #deconstruct)

def child_nodes: () -> Array.
#comment_targets

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

def compact_child_nodes: () -> Array.
#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: ConstantReadNode | ConstantPathNode | MissingNode, ?body: StatementsNode | BeginNode | nil, ?end_keyword_loc: Location, ?name: Symbol) -> ModuleNode.
#deconstruct

Alias for #child_nodes.
#deconstruct_keys(keys)

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 }
#each_child_node {|constant_path| ... }

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator.
#end_keyword

def end_keyword: () -> String.
#end_keyword_loc

attr_reader end_keyword_loc: Location.
#inspect

def inspect -> String.
#module_keyword

def module_keyword: () -> String.
#module_keyword_loc

attr_reader module_keyword_loc: Location.
#save_end_keyword_loc(repository)

Save the end_keyword_loc location using the given saved source so that it can be retrieved later.
#save_module_keyword_loc(repository)

Save the module_keyword_loc location using the given saved source so that it can be retrieved later.
#type

Return a symbol representation of this node type.

`Node` - Inherited

#accept	Accepts a visitor and calls back into the specialized visit function.
#breadth_first_search	Returns the first node that matches the given block when visited in a depth-first search.
#cached_end_code_units_column	Delegates to the cached_end_code_units_column of the associated location object.
#cached_end_code_units_offset	Delegates to the cached_end_code_units_offset of the associated location object.
#cached_start_code_units_column	Delegates to the cached_start_code_units_column of the associated location object.
#cached_start_code_units_offset	Delegates to the cached_start_code_units_offset of the associated location object.
#child_nodes	Returns an array of child nodes, including `nil`s in the place of optional nodes that were not present.
#comment_targets	Returns an array of child nodes and locations that could potentially have comments attached to them.
#comments	Delegates to the comments of the associated location object.
#compact_child_nodes	Returns an array of child nodes, excluding any `nil`s in the place of optional nodes that were not present.
#deconstruct	Alias for Node#child_nodes.
#each_child_node	With a block given, yields each child node.
#end_character_column	Delegates to the end_character_column of the associated location object.
#end_character_offset	Delegates to the end_character_offset of the associated location object.
#end_column	Delegates to the end_column of the associated location object.
#end_line	Delegates to the end_line of the associated location object.
#end_offset	The end offset of the node in the source.
#inspect	Returns a string representation of the node.
#leading_comments	Delegates to the leading_comments of the associated location object.
#location	A Location instance that represents the location of this node in the source.
#pretty_print	Similar to inspect, but respects the current level of indentation given by the pretty print object.
#save	Save this node using a saved source so that it can be retrieved later.
#save_location	Save the location using a saved source so that it can be retrieved later.
#script_lines	Alias for Node#source_lines.
#slice	Slice the location of the node from the source.
#slice_lines	Slice the location of the node from the source, starting at the beginning of the line that the location starts on, ending at the end of the line that the location ends on.
#source_lines	Returns all of the lines of the source code associated with this node.
#start_character_column	Delegates to the start_character_column of the associated location object.
#start_character_offset	Delegates to the start_character_offset of the associated location object.
#start_column	Delegates to the start_column of the associated location object.
#start_line	Delegates to the start_line of the associated location object.
#start_offset	The start offset of the node in the source.
#to_dot	Convert this node into a graphviz dot graph string.
#trailing_comments	Delegates to the trailing_comments of the associated location object.
#tunnel	Returns a list of nodes that are descendants of this node that contain the given line and column.
#type	Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform.
#deprecated, #newline_flag!

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 13820


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 13936


def self.type
  :module_node
end

Instance Attribute Details

#body (readonly)

attr_reader body: StatementsNode | BeginNode | nil

[ GitHub ]

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


attr_reader :body

#constant_path (readonly)

attr_reader constant_path: ConstantReadNode | ConstantPathNode | MissingNode

[ GitHub ]

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


attr_reader :constant_path

#locals (readonly)

attr_reader locals: Array

[ GitHub ]

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


attr_reader :locals

#name (readonly)

attr_reader name: Symbol

[ GitHub ]

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


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 13942


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 13834


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

#child_nodes Also known as: #deconstruct

def child_nodes: () -> Array

[ GitHub ]

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


def child_nodes
  [constant_path, body]
end

#comment_targets

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

[ GitHub ]

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


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 13852


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: ConstantReadNode | ConstantPathNode | MissingNode, ?body: StatementsNode | BeginNode | nil, ?end_keyword_loc: Location, ?name: Symbol) -> ModuleNode

[ GitHub ]

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


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 13870


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: ConstantReadNode | ConstantPathNode | MissingNode, body: StatementsNode | BeginNode | nil, end_keyword_loc: Location, name: Symbol }

[ GitHub ]

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


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

#each_child_node {|constant_path| ... }

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator

Yields:

(constant_path)

[ GitHub ]

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


def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield constant_path
  yield body if body
end

#end_keyword

def end_keyword: () -> String

[ GitHub ]

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


def end_keyword
  end_keyword_loc.slice
end

#end_keyword_loc

attr_reader end_keyword_loc: Location

[ GitHub ]

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


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 13926


def inspect
  InspectVisitor.compose(self)
end

#module_keyword

def module_keyword: () -> String

[ GitHub ]

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


def module_keyword
  module_keyword_loc.slice
end

#module_keyword_loc

attr_reader module_keyword_loc: Location

[ GitHub ]

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


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

#save_end_keyword_loc(repository)

Save the end_keyword_loc location using the given saved source so that it can be retrieved later.

[ GitHub ]

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


def save_end_keyword_loc(repository)
  repository.enter(node_id, :end_keyword_loc)
end

#save_module_keyword_loc(repository)

Save the module_keyword_loc location using the given saved source so that it can be retrieved later.

[ GitHub ]

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


def save_module_keyword_loc(repository)
  repository.enter(node_id, :module_keyword_loc)
end

#type

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

[ GitHub ]

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


def type
  :module_node
end

Class: Prism::ModuleNode

Overview

Class Method Summary

Node - Inherited

Instance Attribute Summary

Node - Inherited

Instance Method Summary

Node - Inherited

Constructor Details

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

Class Method Details

.type

Instance Attribute Details

#body (readonly)

#constant_path (readonly)

#locals (readonly)

#name (readonly)

Instance Method Details

#===(other)

#accept(visitor)

#child_nodes Also known as: #deconstruct

#comment_targets

#compact_child_nodes

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

#deconstruct

#deconstruct_keys(keys)

#each_child_node {|constant_path| ... }

#end_keyword

#end_keyword_loc

#inspect

#module_keyword

#module_keyword_loc

#save_end_keyword_loc(repository)

#save_module_keyword_loc(repository)

#type

`Node` - Inherited

`Node` - Inherited

`Node` - Inherited

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