class RDoc::Mixin

A Mixin adds features from a module into another context. RDoc::Include and RDoc::Extend are both mixins.

Public Class Methods

Source

# File lib/rdoc/code_object/mixin.rb, line 16
def initialize(name, comment)
  super()
  @name = name
  self.comment = comment
  @module = nil # cache for module if found
end

Creates a new Mixin for name with comment

Calls superclass method RDoc::CodeObject::new

Public Instance Methods

<=> (other)

Source

# File lib/rdoc/code_object/mixin.rb, line 26
def <=>(other)
  return unless self.class === other

  name <=> other.name
end

Mixins are sorted by name

full_name ()

Source

# File lib/rdoc/code_object/mixin.rb, line 41
def full_name
  m = self.module
  RDoc::ClassModule === m ? m.full_name : @name
end

Full name based on module

module ()

Source

# File lib/rdoc/code_object/mixin.rb, line 78
def module
  return @module if @module
  return @name unless parent

  @module = @store&.resolve_mixin(@name, parent, self) || @name
end

Attempts to locate the included module object. Returns the name if not known.

The scoping rules of Ruby to resolve the name of an included module are:

first look into the children of the current context;
if not found, look into the children of included modules, in reverse inclusion order;
if still not found, go up the hierarchy of names.

This method has O(n!) behavior when the module calling include is referencing nonexistent modules. Avoid calling module until after all the files are parsed. This behavior is due to ruby’s constant lookup behavior.

As of the beginning of October, 2011, no gem includes nonexistent modules.

When mixin is created from RDoc::Parser::PrismRuby, module name is already a resolved full-path name.