Class: RDoc::Include

Inherits:
CodeObject show all
Defined in:
lib/rdoc/include.rb

Overview

A Module include in a class with #include

Constant Summary

Constants included from Text

Text::MARKUP_FORMAT, Text::TO_HTML_CHARACTERS

Instance Attribute Summary collapse

Attributes inherited from CodeObject

#comment, #document_children, #document_self, #done_documenting, #file, #force_documentation, #line, #metadata, #offset, #parent, #received_nodoc, #section, #store, #viewer

Instance Method Summary collapse

Methods inherited from CodeObject

#display?, #documented?, #each_parent, #file_name, #full_name=, #ignore, #ignored?, #initialize_visibility, #parent_file_name, #parent_name, #record_location, #start_doc, #stop_doc

Methods included from Generator::Markup

#aref_to, #as_href, #cvs_url, #description, #formatter

Methods included from Text

encode_fallback, #expand_tabs, #flush_left, #markup, #normalize_comment, #parse, #snippet, #strip_hashes, #strip_newlines, #strip_stars, #to_html, #wrap

Constructor Details

#initialize(name, comment) ⇒ Include

Creates a new Include for name with comment


14
15
16
17
18
19
# File 'lib/rdoc/include.rb', line 14

def initialize(name, comment)
  super()
  @name = name
  self.comment = comment
  @module = nil # cache for module if found
end

Instance Attribute Details

#nameObject

Name of included module


9
10
11
# File 'lib/rdoc/include.rb', line 9

def name
  @name
end

Instance Method Details

#<=>(other) ⇒ Object

Includes are sorted by name


24
25
26
27
28
# File 'lib/rdoc/include.rb', line 24

def <=> other
  return unless self.class === other

  name <=> other.name
end

#==(other) ⇒ Object Also known as: eql?

:nodoc:


30
31
32
# File 'lib/rdoc/include.rb', line 30

def == other # :nodoc:
  self.class === other and @name == other.name
end

#full_nameObject

Full name based on #module


39
40
41
42
# File 'lib/rdoc/include.rb', line 39

def full_name
  m = self.module
  RDoc::ClassModule === m ? m.full_name : @name
end

#hashObject

:nodoc:


44
45
46
# File 'lib/rdoc/include.rb', line 44

def hash # :nodoc:
  [@name, self.module].hash
end

#inspectObject

:nodoc:


48
49
50
51
52
53
54
# File 'lib/rdoc/include.rb', line 48

def inspect # :nodoc:
  "#<%s:0x%x %s.include %s>" % [
    self.class,
    object_id,
    parent_name, @name,
  ]
end

#moduleObject

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.


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/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
  end

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

  @name
end

#store=(store) ⇒ Object

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


108
109
110
111
112
# File 'lib/rdoc/include.rb', line 108

def store= store
  super

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

#to_sObject

:nodoc:


114
115
116
# File 'lib/rdoc/include.rb', line 114

def to_s # :nodoc:
  "include #@name in: #{parent}"
end