RDoc::CrossReference should not create HTML links

Author: drbrain

History.txt

@@ -8,7 +8,7 @@
     the <tt>link:</tt> scheme which is dependent upon the exact file name.
     Issue #53 by Simon Chiang
   * Pulled RDoc::CrossReference out of RDoc::Markup::ToHtmlCrossref.
-    Cross-references can now be created without cut-and-paste.
+    Cross-references can now be created easily for non-HTML formatters.
 * Bug fixes
   * `ri []` and other special methods now work properly.  Issue #52 by
     ddebernardy.

lib/rdoc/cross_reference.rb

@@ -88,36 +88,21 @@ class RDoc::CrossReference
   attr_accessor :seen
 
   ##
-  # Sets up the cross-reference for the given +context+ (RDoc::Context).
-  # +from_path+ is used to create HTML links from #link.
+  # Allows cross-references to be created based on the given +context+
+  # (RDoc::Context).
 
-  def initialize context, from_path = nil
+  def initialize context
     @context = context
-    @from_path = from_path
 
     @seen = {}
   end
 
-  ##
-  # Creates an HTML link to +name+ with the given +text+.  +from_path+ must be
-  # set.
-
-  def link name, text
-    ref = resolve name, text
-
-    case ref
-    when String then
-      ref
-    else
-      "<a href=\"#{ref.as_href @from_path}\">#{text}</a>"
-    end
-  end
-
   ##
   # Returns a reference to +name+.
   #
   # If the reference is found and +name+ is not documented +text+ will be
-  # returned.  If +name+ is escaped +name+ is returned.
+  # returned.  If +name+ is escaped +name+ is returned.  If +name+ is not
+  # found +text+ is returned.
 
   def resolve name, text
     return @seen[name] if @seen.include? name

lib/rdoc/markup/to_html_crossref.rb

@@ -2,8 +2,9 @@
 require 'rdoc/cross_reference'
 
 ##
-# Subclass of the RDoc::Markup::ToHtml class that supports looking up words
-# from a context.  Those that are found will be linked.
+# Subclass of the RDoc::Markup::ToHtml class that supports looking up method
+# names, classes, etc to create links.  RDoc::CrossReference is used to
+# generate those links based on the current context.
 
 class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
 
@@ -37,13 +38,14 @@ def initialize(from_path, context, show_hash, hyperlink_all = false,
 
     crossref_re = hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP
 
-    @cross_reference = RDoc::CrossReference.new context, from_path
+    @cross_reference = RDoc::CrossReference.new context
 
     @markup.add_special crossref_re, :CROSSREF
     @markup.add_special /rdoc:\S+\w/, :HYPERLINK
 
-    @show_hash = show_hash
+    @from_path     = from_path
     @hyperlink_all = hyperlink_all
+    @show_hash     = show_hash
   end
 
   ##
@@ -57,7 +59,7 @@ def cross_reference name, text = nil
 
     text = name unless text
 
-    @cross_reference.link lookup, text
+    link lookup, text
   end
 
   ##
@@ -100,5 +102,19 @@ def gen_url url, text
     cross_reference $', text
   end
 
+  ##
+  # Creates an HTML link to +name+ with the given +text+.
+
+  def link name, text
+    ref = @cross_reference.resolve name, text
+
+    case ref
+    when String then
+      ref
+    else
+      "<a href=\"#{ref.as_href @from_path}\">#{text}</a>"
+    end
+  end
+
 end
 

test/test_rdoc_cross_reference.rb

@@ -7,7 +7,7 @@ class TestRDocCrossReference < XrefTestCase
   def setup
     super
 
-    @xref = RDoc::CrossReference.new @c1, 'index.html'
+    @xref = RDoc::CrossReference.new @c1
   end
 
   def assert_ref expected, name
@@ -18,14 +18,8 @@ def refute_ref name
     assert_equal name, @xref.resolve(name, name)
   end
 
-  def test_link
-    assert_equal 'n', @xref.link('n', 'n')
-
-    assert_equal '<a href="C1.html#method-c-m">m</a>', @xref.link('m', 'm')
-  end
-
   def test_resolve_C2
-    @xref = RDoc::CrossReference.new @c2, 'classes/C2.html'
+    @xref = RDoc::CrossReference.new @c2
 
     refute_ref '#m'
 
@@ -40,7 +34,7 @@ def test_resolve_C2
   end
 
   def test_resolve_C2_C3
-    @xref = RDoc::CrossReference.new @c2_c3, 'classes/C2/C3.html'
+    @xref = RDoc::CrossReference.new @c2_c3
 
     assert_ref @c2_c3_m, '#m'
 
@@ -56,7 +50,7 @@ def test_resolve_C2_C3
   end
 
   def test_resolve_C3
-    @xref = RDoc::CrossReference.new @c3, 'classes/C3.html'
+    @xref = RDoc::CrossReference.new @c3
 
     assert_ref @c3, 'C3'
 
@@ -72,14 +66,14 @@ def test_resolve_C3
   end
 
   def test_resolve_C4
-    @xref = RDoc::CrossReference.new @c4, 'classes/C4.html'
+    @xref = RDoc::CrossReference.new @c4
 
     # C4 ref inside a C4 containing a C4 should resolve to the contained class
     assert_ref @c4_c4, 'C4'
   end
 
   def test_resolve_C4_C4
-    @xref = RDoc::CrossReference.new @c4_c4, 'classes/C4/C4.html'
+    @xref = RDoc::CrossReference.new @c4_c4
 
     # A C4 reference inside a C4 class contained within a C4 class should
     # resolve to the inner C4 class.

test/test_rdoc_markup_to_html_crossref.rb

@@ -58,6 +58,12 @@ def test_handle_special_TIDYLINK_rdoc
     assert_equal '<a href="README_txt.html">tidy</a>', link
   end
 
+  def test_link
+    assert_equal 'n', @to.link('n', 'n')
+
+    assert_equal '<a href="C1.html#method-c-m">m</a>', @to.link('m', 'm')
+  end
+
   def SPECIAL text
     @to.handle_special_CROSSREF special text
   end