ri now walks the ancestors looking for a method definition

Author: drbrain

History.txt

@@ -3,6 +3,7 @@
 * 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
 * N Minor Enhancements:
   * Allow links to files
   * Default options now taken from RDOCOPT environment variable

lib/rdoc/code_objects.rb

@@ -609,6 +609,15 @@ def find_module_named(name)
       find_class_or_module_named(name) || find_enclosing_module_named(name)
     end
 
+    def inspect
+      "#<%s:0x%x %p modules: %p classes: %p>" % [
+        self.class, object_id,
+        file_base_name,
+        @modules.map { |n,m| m },
+        @classes.map { |n,c| c }
+      ]
+    end
+
   end
 
   ##
@@ -617,7 +626,6 @@ def find_module_named(name)
 
   class ClassModule < Context
 
-    attr_reader   :superclass
     attr_accessor :diagram
 
     def initialize(name, superclass = nil)
@@ -628,7 +636,15 @@ def initialize(name, superclass = nil)
       super()
     end
 
+    def find_class_named(name)
+      return self if full_name == name
+      @classes.each_value {|c| return c if c.find_class_named(name) }
+      nil
+    end
+
+    ##
     # Return the fully qualified name of this class or module
+
     def full_name
       if @parent && @parent.full_name
         @parent.full_name + "::" + @name
@@ -642,24 +658,35 @@ def http_url(prefix)
       File.join(prefix, *path) + ".html"
     end
 
-    # Return +true+ if this object represents a module
-    def is_module?
+    ##
+    # Does this object represent a module?
+
+    def module?
       false
     end
 
-    # to_s is simply for debugging
-    def to_s
-      res = self.class.name + ": " + @name 
-      res << @comment.to_s
-      res << super
-      res
+    ##
+    # The superclass of this class
+
+    def superclass
+      raise NoMethodError, "#{full_name} is a module" if module?
+
+      scope = self
+
+      until TopLevel === scope do
+        superclass = scope.classes.find { |c| c.name == @superclass }
+
+        return superclass.full_name if superclass
+        scope = scope.parent
+      end
+
+      @superclass
     end
 
-    def find_class_named(name)
-      return self if full_name == name
-      @classes.each_value {|c| return c if c.find_class_named(name) }
-      nil
+    def to_s
+      "#{self.class}: #{@name} #{@comment} #{super}"
     end
+
   end
 
   ##
@@ -708,7 +735,7 @@ def inspect
       ]
     end
 
-    def is_module?
+    def module?
       true
     end
 

lib/rdoc/generator.rb

@@ -489,7 +489,7 @@ def initialize(context, html_file, prefix, options)
 
       @html_file = html_file
       @html_class = self
-      @is_module = context.is_module?
+      @is_module = context.module?
       @values    = {}
 
       context.viewer = self
@@ -619,16 +619,16 @@ def class_attribute_values
       @values["title"]     = "#{@values['classmod']}: #{h_name}"
 
       c = @context
-      c = c.parent while c and !c.diagram
-      if c && c.diagram
+      c = c.parent while c and not c.diagram
+
+      if c and c.diagram then
         @values["diagram"] = diagram_reference(c.diagram)
       end
 
       @values["full_name"] = h_name
 
-      parent_class = @context.superclass
-
-      if parent_class
+      if not @context.module? and @context.superclass then
+        parent_class = @context.superclass
         @values["parent"] = CGI.escapeHTML(parent_class)
 
         if parent_name

lib/rdoc/generator/ri.rb

@@ -16,12 +16,8 @@ def self.for(options)
     new(options)
   end
 
-  class << self
-    protected :new
-  end
-
   ##
-  # Set up a new RDoc::Generator::RI.
+  # Set up a new ri generator
 
   def initialize(options) #:not-new:
     @options   = options
@@ -52,11 +48,12 @@ def process_class(from_class)
   end
 
   def generate_class_info(cls)
-    if cls === RDoc::NormalModule
+    case cls
+    when RDoc::NormalModule then
       cls_desc = RDoc::RI::ModuleDescription.new
     else
       cls_desc = RDoc::RI::ClassDescription.new
-      cls_desc.superclass  = cls.superclass
+      cls_desc.superclass = cls.superclass
     end
 
     cls_desc.name        = cls.name

lib/rdoc/parser/ruby.rb

@@ -1872,7 +1872,7 @@ def parse_call_parameters(tk)
     res
   end
 
-  def parse_class(container, single, tk, comment, &block)
+  def parse_class(container, single, tk, comment)
     progress("c")
 
     @stats.num_classes += 1
@@ -1891,22 +1891,19 @@ def parse_class(container, single, tk, comment, &block)
         superclass = "<unknown>" if superclass.empty?
       end
 
-      if single == SINGLE
-        cls_type = RDoc::SingleClass
-      else
-        cls_type = RDoc::NormalClass
-      end
-
+      cls_type = single == SINGLE ? RDoc::SingleClass : RDoc::NormalClass
       cls = container.add_class cls_type, name, superclass
+
       read_documentation_modifiers cls, RDoc::CLASS_MODIFIERS
-      cls.record_location(@top_level)
-      parse_statements(cls)
+      cls.record_location @top_level
+
+      parse_statements cls
       cls.comment = comment
 
     when TkLSHFT
       case name = get_class_specification
       when "self", container.name
-        parse_statements(container, SINGLE, &block)
+        parse_statements(container, SINGLE)
       else
         other = RDoc::TopLevel.find_class_named(name)
         unless other
@@ -1916,7 +1913,7 @@ def parse_class(container, single, tk, comment, &block)
           other = RDoc::NormalClass.new "Dummy", nil
         end
         read_documentation_modifiers other, RDoc::CLASS_MODIFIERS
-        parse_statements(other, SINGLE, &block)
+        parse_statements(other, SINGLE)
       end
 
     else
@@ -2293,7 +2290,7 @@ def parse_module(container, single, tk, comment)
     progress("m")
     @stats.num_modules += 1
     container, name_t = get_class_or_module(container)
-#      skip_tkspace
+
     name = name_t.name
 
     mod = container.add_module RDoc::NormalModule, name

lib/rdoc/ri/driver.rb

@@ -335,13 +335,13 @@ def load_cache_for(klassname)
 
     if File.exist? path and
        File.mtime(path) >= File.mtime(class_cache_file_path) then
-      File.open path, 'rb' do |fp|
+      open path, 'rb' do |fp|
         cache = Marshal.load fp.read
       end
     else
       class_cache = nil
 
-      File.open class_cache_file_path, 'rb' do |fp|
+      open class_cache_file_path, 'rb' do |fp|
         class_cache = Marshal.load fp.read
       end
 
@@ -372,17 +372,34 @@ def load_cache_for(klassname)
     RDoc::RI::Driver::Hash.convert cache
   end
 
+  ##
+  # Finds the next ancestor of +orig_klass+ after +klass+.
+
+  def lookup_ancestor(klass, orig_klass, ancestor = nil)
+    cache = class_cache[orig_klass]
+
+    return nil unless cache
+
+    ancestors ||= [orig_klass]
+    ancestors.push(*cache.includes.map { |inc| inc['name'] })
+    ancestors << cache.superclass
+
+    ancestor = ancestors[ancestors.index(klass) + 1]
+
+    return ancestor if ancestor
+
+    lookup_ancestor klass, cache.superclass
+  end
+
   ##
   # Finds the method
 
   def lookup_method(name, klass)
     cache = load_cache_for klass
-    raise NotFoundError, name unless cache
+    return nil unless cache
 
     method = cache[name.gsub('.', '#')]
     method = cache[name.gsub('.', '::')] unless method
-    raise NotFoundError, name unless method
-
     method
   end
 
@@ -459,11 +476,25 @@ def run
           if class_cache.key? name then
             display_class name
           else
-            meth = nil
+            klass, = parse_name name
+
+            orig_klass = klass
+            orig_name = name
+
+            until klass == 'Kernel' do
+              method = lookup_method name, klass
+
+              break method if method
 
-            klass, meth = parse_name name
+              ancestor = lookup_ancestor klass, orig_klass
 
-            method = lookup_method name, klass
+              break unless ancestor
+
+              name = name.sub klass, ancestor
+              klass = ancestor
+            end
+
+            raise NotFoundError, orig_name unless method
 
             @display.display_method_info method
           end
@@ -472,6 +503,7 @@ def run
             display_class name
           else
             methods = select_methods(/^#{name}/)
+
             if methods.size == 0
               raise NotFoundError, name
             elsif methods.size == 1

test/test_rdoc_info_formatting.rb

@@ -1,29 +1,25 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib/'
 require 'fileutils'
+require 'tmpdir'
 require 'test/unit'
+
 require 'rdoc/generator/texinfo'
-require 'yaml'
 
 # From chapter 18 of the Pickaxe 3rd ed. and the TexInfo manual.
 class TestRdocInfoFormatting < Test::Unit::TestCase
-  OUTPUT_DIR = "/tmp/rdoc-#{$$}"
-
   def setup
-    # supress stdout
-    $stdout = File.new('/dev/null','w')
-    $stderr = File.new('/dev/null','w')
+    @output_dir = File.join Dir.tmpdir, "test_rdoc_info_formatting_#{$$}"
+    @output_file = File.join @output_dir, 'rdoc.texinfo'
 
-    RDoc::RDoc.new.document(['--fmt=texinfo',
+    RDoc::RDoc.new.document(['--fmt=texinfo', '--quiet',
                              File.expand_path(__FILE__),
-                             "--op=#{OUTPUT_DIR}"])
-    @text = File.read(OUTPUT_DIR + '/rdoc.texinfo')
+                             "--op=#{@output_dir}"])
+    @text = File.read @output_file
+
     # File.open('rdoc.texinfo', 'w') { |f| f.puts @text }
   end
 
   def teardown
-    $stdout = STDOUT
-    $stderr = STDERR
-    FileUtils.rm_rf OUTPUT_DIR
+    FileUtils.rm_rf @output_dir
   end
 
   # Make sure tags like *this* do not make HTML

test/test_rdoc_info_sections.rb

@@ -76,8 +76,8 @@ def test_methods_are_shown_only_once
 
 #   if system "makeinfo --version > /dev/null"
 #     def test_compiles_to_info
-#       makeinfo_output = `cd #{OUTPUT_DIR} && makeinfo rdoc.texinfo`
-#       assert(File.exist?(File.join(OUTPUT_DIR, 'rdoc.info')),
+#       makeinfo_output = `cd #{@output_dir} && makeinfo rdoc.texinfo`
+#       assert(File.exist?(File.join(@output_dir, 'rdoc.info')),
 #              "Info file was not compiled: #{makeinfo_output}")
 #     end
 #   end