Fix relative path location, allow generators to override path locations

Author: drbrain

History.txt

@@ -12,6 +12,7 @@
 * Y Minor Enhancements
   * Added a space after the commas in ri class method lists.  RubyForge
     enhancement #22182.
+  * Generators can now override generated file locations.
   * Converted to minitest.
 
 * Z Bug Fixes
@@ -22,6 +23,7 @@
     Patterson.
   * When merging ri data with a nonexistant directory, RDoc no longer crashes.
   * Fix visibility of methods in XML output.  Issue by Yehuda Katz.
+  * Fixed relative link generation.
 
 === 2.2.1 / 2008-09-24
 This version provides some minor fixes and enhancements to 2.2.0 intended

lib/rdoc/generator.rb

@@ -133,14 +133,26 @@ def self.build_indices(toplevels, options, template_cache = nil)
       classes = []
       template_cache ||= RDoc::Cache.instance
 
+      file_dir = if defined? options.generator::FILE_DIR then
+                   options.generator::FILE_DIR
+                 else
+                   RDoc::Generator::FILE_DIR
+                 end
+
       toplevels.each do |toplevel|
         files << RDoc::Generator::File.new(template_cache, toplevel, options,
-                                           RDoc::Generator::FILE_DIR)
+                                           file_dir)
       end
 
+      class_dir = if defined? options.generator::CLASS_DIR then
+                   options.generator::CLASS_DIR
+                 else
+                   RDoc::Generator::CLASS_DIR
+                 end
+
       RDoc::TopLevel.all_classes_and_modules.each do |cls|
         build_class_list(template_cache, classes, options, cls, files[0], 
-                         RDoc::Generator::CLASS_DIR)
+                         class_dir)
       end
 
       return files, classes
@@ -517,7 +529,9 @@ def http_url(full_name, prefix)
 
       path.gsub!(/<<\s*(\w*)/, 'from-\1') if path['<<']
 
-      ::File.join(prefix, path.split("::")) + ".html"
+      path = [prefix] + path.split('::')
+
+      ::File.join(*path.compact) + ".html"
     end
 
     def name
@@ -670,6 +684,32 @@ def <=>(other)
       self.name <=> other.name
     end
 
+    def inspect
+      "#<#{self.class} name: #{name} path: #{@path}>"
+    end
+
+    def pretty_print(q)
+      q.group 1, "#<#{self.class} ", '>' do
+        q.text 'name: '
+        q.pp name
+        q.text ','
+        q.breakable
+
+        q.text 'path: '
+        q.pp @path
+        q.text ','
+        q.breakable
+
+        q.text 'values: '
+        q.pp @values
+        q.text ','
+        q.breakable
+
+        q.text 'methods: '
+        q.pp @methods
+      end
+    end
+
   end
 
   ##
@@ -704,7 +744,9 @@ def initialize(template_cache, context, options, file_dir)
     end
 
     def http_url(file_dir)
-      ::File.join file_dir, "#{@context.file_relative_name.tr '.', '_'}.html"
+      path = [file_dir, "#{@context.file_relative_name.tr '.', '_'}.html"]
+
+      ::File.join path.compact
     end
 
     def filename_to_label
@@ -811,6 +853,27 @@ def <=>(other)
       self.name <=> other.name
     end
 
+    def inspect
+      "#<#{self.class} name: #{@name} path: #{@path}>"
+    end
+
+    def pretty_print(q)
+      q.group 1, "#<#{self.class} ", '>' do
+        q.text 'name: '
+        q.pp @name
+        q.text ','
+        q.breakable
+
+        q.text 'path: '
+        q.pp @path
+        q.text ','
+        q.breakable
+
+        q.text 'values: '
+        q.pp @values
+      end
+    end
+
   end
 
   class Method

lib/rdoc/markup/to_html.rb

@@ -44,6 +44,9 @@ def self.gen_relative_url(path, target)
     from = from.split "/"
     to   = to.split "/"
 
+    from.delete '.'
+    to.delete '.'
+
     while from.size > 0 and to.size > 0 and from[0] == to[0] do
       from.shift
       to.shift

test/test_rdoc_markup_to_html.rb

@@ -10,6 +10,19 @@ def setup
     @th = RDoc::Markup::ToHtml.new
   end
 
+  def test_class_gen_relative_url
+    def gen(from, to)
+      RDoc::Markup::ToHtml.gen_relative_url from, to
+    end
+
+    assert_equal 'a.html',    gen('a.html',   'a.html')
+    assert_equal 'b.html',    gen('a.html',   'b.html')
+
+    assert_equal 'd.html',    gen('a/c.html', 'a/d.html')
+    assert_equal '../a.html', gen('a/c.html', 'a.html')
+    assert_equal 'a/c.html',  gen('a.html',   'a/c.html')
+  end
+
   def test_tt_formatting
     assert_equal "<p>\n<tt>--</tt> &#8212; <tt>cats'</tt> cats&#8217;\n</p>\n",
                  util_format("<tt>--</tt> -- <tt>cats'</tt> cats'")