Fix a bug in which RDoc would not generate correct cross-reference links for

a class contained within a module of the same name (RDoc::RDoc, for instance).

Author: DesigningPatterns

History.txt

@@ -33,7 +33,7 @@ documentation about ri.
   * Provided an ri command-line option to control its caching behavior.
   * Improved RDoc's documentation.  Added RI.txt to document ri.
 
-* 24 Bug fixes:
+* 25 Bug fixes:
   * Fixed prototype detection in C parser.  Can process ruby 1.8 C files
     again.
   * Fixed the main page for frameless template.  Patch by Marcin Raczkowski.
@@ -45,6 +45,8 @@ documentation about ri.
   * Fixed a case where RDoc first would encounter Foo::Bar and then would
     encounter class Foo.  Previously, RDoc erroneously would have considered
     that both a Foo class and a Foo module existed.
+  * Fix a clase where RDoc would not generate correct cross-reference links
+    to a class contained within a module of the same name (i.e. RDoc::RDoc)
   * Prevented RDoc from trying to parse binary files, which would produce
     garbage output.
   * RDoc now correctly converts ' characters to apostrophes, opening single

lib/rdoc/code_objects.rb

@@ -406,9 +406,12 @@ def initialize_classes_and_modules
 
     # Find a named module
     def find_module_named(name)
-      return self if self.name == name
+      # First check the enclosed modules, then check the module itself,
+      # then check the enclosing modules (this mirrors the check done by
+      # the Ruby parser)
       res = @modules[name] || @classes[name]
       return res if res
+      return self if self.name == name
       find_enclosing_module_named(name)
     end
 
@@ -467,6 +470,7 @@ def find_symbol(symbol, method = nil)
         unless modules.empty? then
           module_name = modules.shift
           result = find_module_named(module_name)
+
           if result then
             modules.each do |name|
               result = result.find_module_named(name)

test/rdoc_markup_to_html_crossref_reference.rb

@@ -24,3 +24,8 @@ class Helper1
   class Helper2
   end
 end
+
+class Ref_Class4
+  class Ref_Class4
+  end
+end

test/test_rdoc_markup_to_html_crossref.rb

@@ -199,6 +199,10 @@ def verify_invariant_crossrefs(xref)
 
     # A link always should be generated for a file name.
     verify_file_crossref xref, @source_file_name, @source_file_name
+
+    # References should be generated correctly for a class scoped within
+    # a class of the same name.
+    verify_class_crossref xref, "Ref_Class4::Ref_Class4", "Ref_Class4::Ref_Class4"
   end
 
   def test_handle_special_CROSSREF_no_underscore
@@ -224,6 +228,7 @@ def test_handle_special_CROSSREF_no_underscore
     verify_class_crossref xref, "Ref_Class3::Helper1", "Ref_Class3::Helper1"
     verify_class_crossref xref, "Ref_Class3::Helper2", "Ref_Class3::Helper2"
     verify_no_crossref xref, "Helper1"
+    verify_class_crossref xref, "Ref_Class4", "Ref_Class4"
 
     klass = class_hash["Ref_Class2"]
     xref = RDoc::Markup::ToHtmlCrossref.new 'from_path', klass, true
@@ -232,6 +237,7 @@ def test_handle_special_CROSSREF_no_underscore
     verify_method_crossref xref, "Ref_Class3#method", "Ref_Class2::Ref_Class3", "M000001"
     verify_no_crossref xref, "#method"
     verify_class_crossref xref, "Ref_Class3::Helper1", "Ref_Class2::Ref_Class3::Helper1"
+    verify_class_crossref xref, "Ref_Class4", "Ref_Class4"
 
     # This one possibly is an rdoc bug...
     # Ref_Class2 has a nested Ref_Class3, but
@@ -251,6 +257,7 @@ def test_handle_special_CROSSREF_no_underscore
     verify_class_crossref xref, "Ref_Class3::Helper1", "Ref_Class2::Ref_Class3::Helper1"
     verify_no_crossref xref, "Ref_Class3::Helper2"
     verify_class_crossref xref, "Helper1", "Ref_Class2::Ref_Class3::Helper1"
+    verify_class_crossref xref, "Ref_Class4", "Ref_Class4"
 
     klass = class_hash["Ref_Class3"]
     xref = RDoc::Markup::ToHtmlCrossref.new 'from_path', klass, true
@@ -261,5 +268,20 @@ def test_handle_special_CROSSREF_no_underscore
     verify_class_crossref xref, "Ref_Class3::Helper1", "Ref_Class3::Helper1"
     verify_class_crossref xref, "Ref_Class3::Helper2", "Ref_Class3::Helper2"
     verify_class_crossref xref, "Helper1", "Ref_Class3::Helper1"
+    verify_class_crossref xref, "Ref_Class4", "Ref_Class4"
+
+    klass = class_hash["Ref_Class4"]
+    xref = RDoc::Markup::ToHtmlCrossref.new 'from_path', klass, true
+    verify_invariant_crossrefs xref
+    # A Ref_Class4 reference inside a Ref_Class4 class containing a
+    # Ref_Class4 class should resolve to the contained class.
+    verify_class_crossref xref, "Ref_Class4", "Ref_Class4::Ref_Class4"
+
+    klass = class_hash["Ref_Class4::Ref_Class4"]
+    xref = RDoc::Markup::ToHtmlCrossref.new 'from_path', klass, true
+    verify_invariant_crossrefs xref
+    # A Ref_Class4 reference inside a Ref_Class4 class contained within
+    # a Ref_Class4 class should resolve to the inner Ref_Class4 class.
+    verify_class_crossref xref, "Ref_Class4", "Ref_Class4::Ref_Class4"
   end
 end