Walk the ancestors of a class looking for a method in ri

Author: drbrain

History.txt

@@ -3,7 +3,9 @@
 * N Major Enhancements:
   * RDoc now knows about meta-programmed methods, see RDoc::Parser::Ruby
   * Reorganized parsers under RDoc::Parser base class
-  * ri now walks the ancestors of a class looking for a method
+  * ri now walks the ancestors of a class looking for a method e.g. ri
+    File#read displays documentation for IO#read (may require regeneration of
+    ri data)
 * N Minor Enhancements:
   * Allow links to files
   * Default options now taken from RDOCOPT environment variable

lib/rdoc/code_objects.rb

@@ -315,7 +315,9 @@ def add_require(a_require)
 
     def add_class_or_module(collection, class_type, name, superclass=nil)
       cls = collection[name]
-      if cls
+
+      if cls then
+        cls.superclass = superclass unless cls.module?
         puts "Reusing class/module #{name}" if $DEBUG_RDOC
       else
         cls = class_type.new(name, superclass)
@@ -551,7 +553,8 @@ def add_class_or_module(collection, class_type, name, superclass)
       cls = collection[name]
 
       if cls then
-        puts "Reusing class/module #{name}" #if $DEBUG_RDOC
+        cls.superclass = superclass unless cls.module?
+        puts "Reusing class/module #{cls.full_name}" if $DEBUG_RDOC
       else
         if class_type == NormalModule then
           all = @@all_modules
@@ -562,15 +565,11 @@ def add_class_or_module(collection, class_type, name, superclass)
         cls = all[name]
 
         unless cls then
-          cls = class_type.new(name, superclass)
+          cls = class_type.new name, superclass
           all[name] = cls unless @done_documenting
         end
 
-        if NormalClass === cls and cls.superclass.nil? then
-          cls.superclass = superclass
-        end
-
-        puts "Adding class/module #{name} to #{@name}" if $DEBUG_RDOC
+        puts "Adding class/module #{name} to #{full_name}" if $DEBUG_RDOC
 
         collection[name] = cls unless @done_documenting
 
@@ -632,8 +631,6 @@ class ClassModule < Context
 
     attr_accessor :diagram
 
-    attr_writer :superclass
-
     def initialize(name, superclass = nil)
       @name       = name
       @diagram    = nil
@@ -672,7 +669,8 @@ def module?
     end
 
     ##
-    # The superclass of this class
+    # Get the superclass of this class.  Attempts to retrieve the superclass'
+    # real name by following module nesting.
 
     def superclass
       raise NoMethodError, "#{full_name} is a module" if module?
@@ -689,6 +687,17 @@ def superclass
       @superclass
     end
 
+    ##
+    # Set the superclass of this class
+
+    def superclass=(superclass)
+      raise NoMethodError, "#{full_name} is a module" if module?
+
+      if @superclass.nil? or @superclass == 'Object' then
+        @superclass = superclass 
+      end
+    end
+
     def to_s
       "#{self.class}: #{@name} #{@comment} #{super}"
     end
@@ -806,23 +815,24 @@ def inspect
     end
 
     def param_seq
-      p = params.gsub(/\s*\#.*/, '')
-      p = p.tr("\n", " ").squeeze(" ")
-      p = "(" + p + ")" unless p[0] == ?(
+      params = params.gsub(/\s*\#.*/, '')
+      params = params.tr("\n", " ").squeeze(" ")
+      params = "(#{params})" unless p[0] == ?(
 
-      if (block = block_params)
-        # If this method has explicit block parameters, remove any
-        # explicit &block
-        p.sub!(/,?\s*&\w+/)
+      if block = block_params then # yes, =
+        # If this method has explicit block parameters, remove any explicit
+        # &block
+        params.sub!(/,?\s*&\w+/)
 
         block.gsub!(/\s*\#.*/, '')
         block = block.tr("\n", " ").squeeze(" ")
         if block[0] == ?(
           block.sub!(/^\(/, '').sub!(/\)/, '')
         end
-        p << " {|#{block}| ...}"
+        params << " { |#{block}| ... }"
       end
-      p
+
+      params
     end
 
     def to_s

lib/rdoc/ri/driver.rb

@@ -303,6 +303,9 @@ def class_cache
                      populate_class_cache class_cache, classes, true
                      write_cache class_cache, class_cache_file_path
                    end
+
+    @class_cache = RDoc::RI::Driver::Hash.convert @class_cache
+    @class_cache
   end
 
   def class_cache_file_path
@@ -375,12 +378,12 @@ def load_cache_for(klassname)
   ##
   # Finds the next ancestor of +orig_klass+ after +klass+.
 
-  def lookup_ancestor(klass, orig_klass, ancestor = nil)
+  def lookup_ancestor(klass, orig_klass)
     cache = class_cache[orig_klass]
 
     return nil unless cache
 
-    ancestors ||= [orig_klass]
+    ancestors = [orig_klass]
     ancestors.push(*cache.includes.map { |inc| inc['name'] })
     ancestors << cache.superclass
 
@@ -452,6 +455,8 @@ def populate_class_cache(class_cache, classes, extension = false)
           desc["class_method_extensions"] = desc.delete "class_methods"
         end
 
+        klass = RDoc::RI::Driver::Hash.convert klass
+
         klass.merge_enums desc
         klass["sources"] << cdesc
       end