Maintenance of Ruby 2.0.0 will end on February 24, 2016. Read more

In Files

  • rdoc/include.rb

Class/Module Index [+]



A Module include in a class with #include



Name of included module

Public Class Methods

new(name, comment) click to toggle source

Creates a new Include for name with comment

               # File rdoc/include.rb, line 14
def initialize(name, comment)
  @name = name
  self.comment = comment
  @module = nil # cache for module if found

Public Instance Methods

<=>(other) click to toggle source

Includes are sorted by name

               # File rdoc/include.rb, line 24
def <=> other
  return unless self.class === other

  name <=>
full_name() click to toggle source

Full name based on module

               # File rdoc/include.rb, line 39
def full_name
  m = self.module
  RDoc::ClassModule === m ? m.full_name : @name
module() click to toggle source

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.

               # File rdoc/include.rb, line 73
def module
  return @module if @module

  # search the current context
  return @name unless parent
  full_name = parent.child_name(@name)
  @module = @store.modules_hash[full_name]
  return @module if @module
  return @name if @name =~ /^::/

  # search the includes before this one, in reverse order
  searched = parent.includes.take_while { |i| i != self }.reverse
  searched.each do |i|
    inc = i.module
    next if String === inc
    full_name = inc.child_name(@name)
    @module = @store.modules_hash[full_name]
    return @module if @module

  # go up the hierarchy of names
  up = parent.parent
  while up
    full_name = up.child_name(@name)
    @module = @store.modules_hash[full_name]
    return @module if @module
    up = up.parent

store=(store) click to toggle source

Sets the store for this class or module and its contained code objects.

               # File rdoc/include.rb, line 108
def store= store

  @file = @store.add_file @file.full_name if @file

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit