RDoc::CrossReference can now look up pages by name

Author: drbrain

TODO.rdoc

@@ -1,9 +1,5 @@
 Some file contains some things that might happen in RDoc, or might not
 
-=== 3.10
-
-* Figure out why README@Bugs does not work here
-
 === 3.11
 
 * Reload the RDoc tree from an RI store

lib/rdoc/cross_reference.rb

@@ -116,16 +116,6 @@ def initialize context
   def resolve name, text
     return @seen[name] if @seen.include? name
 
-    # Find class, module, or method in class or module.
-    #
-    # Do not, however, use an if/elsif/else chain to do so.  Instead, test
-    # each possible pattern until one matches.  The reason for this is that a
-    # string like "YAML.txt" could be the txt() class method of class YAML (in
-    # which case it would match the first pattern, which splits the string
-    # into container and method components and looks up both) or a filename
-    # (in which case it would match the last pattern, which just checks
-    # whether the string as a whole is a known symbol).
-
     if /#{CLASS_REGEXP_STR}([.#]|::)#{METHOD_REGEXP_STR}/o =~ name then
       type = $2
       type = '' if type == '.'  # will find either #method or ::method
@@ -150,12 +140,15 @@ def resolve name, text
 
     ref = case name
           when /^\\(#{CLASS_REGEXP_STR})$/o then
-            ref = @context.find_symbol $1
+            @context.find_symbol $1
           else
-            ref = @context.find_symbol name
+            @context.find_symbol name
           end unless ref
 
-    ref = nil if RDoc::Alias === ref # external alias: can't link to it
+    # Try a page name
+    ref = RDoc::TopLevel.page name if not ref and name =~ /^\w+$/
+
+    ref = nil if RDoc::Alias === ref # external alias, can't link to it
 
     out = if name == '\\' then
             name

lib/rdoc/top_level.rb

@@ -231,6 +231,12 @@ def self.new file_name
     end
   end
 
+  def self.page page
+    @all_files_hash.each_value.find do |file|
+      file.text? and file.page_name == page
+    end
+  end
+
   ##
   # Removes from +all_hash+ the contexts that are nodoc or have no content.
   #
@@ -495,7 +501,7 @@ def search_record
   # Is this TopLevel from a text file instead of a source code file?
 
   def text?
-    @parser.ancestors.include? RDoc::Parser::Text
+    @parser and @parser.ancestors.include? RDoc::Parser::Text
   end
 
   def to_s # :nodoc:

test/test_rdoc_cross_reference.rb

@@ -16,6 +16,13 @@ def refute_ref name
     assert_equal name, @xref.resolve(name, name)
   end
 
+  def test_resolve_page
+    page = RDoc::TopLevel.new 'README.txt'
+    page.parser = RDoc::Parser::Simple
+
+    assert_ref page, 'README'
+  end
+
   def test_resolve_C2
     @xref = RDoc::CrossReference.new @c2
 

test/test_rdoc_top_level.rb

@@ -89,6 +89,15 @@ def test_class_new
     refute_same tl1, tl3
   end
 
+  def test_class_page
+    page = RDoc::TopLevel.new 'PAGE.txt'
+    page.parser = RDoc::Parser::Simple
+
+    assert_nil RDoc::TopLevel.page 'no such page'
+
+    assert_equal page, RDoc::TopLevel.page('PAGE')
+  end
+
   def test_class_reset
     RDoc::TopLevel.reset
 
@@ -283,5 +292,13 @@ def test_text_eh
     assert simple.text?
   end
 
+  def test_text_eh_no_parser
+    refute @xref_data.text?
+
+    rd = RDoc::TopLevel.new 'rd_format.rd'
+
+    refute rd.text?
+  end
+
 end