method

module

v1_9_3_392 - Show latest stable - 0 notes - Class: RDoc::Include

1_8_6_287
1_8_7_72
1_8_7_330
1_9_1_378
1_9_2_180 (0)
1_9_3_125 (30)
1_9_3_392 (0)
2_1_10
2_2_9
2_4_6
2_5_5
2_6_3
What's this?

module() public

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.

Show source

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

    # search the current context
    return @name unless parent
    full_name = parent.child_name(@name)
    @module = RDoc::TopLevel.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 = RDoc::TopLevel.modules_hash[full_name]
      return @module if @module
    end

    # go up the hierarchy of names
    p = parent.parent
    while p
      full_name = p.child_name(@name)
      @module = RDoc::TopLevel.modules_hash[full_name]
      return @module if @module
      p = p.parent
    end

    @name
  end

module

Related methods