Merge pull request ruby#115 from erikh/superclass_report

Methods that use super are now shown in rdoc HTML view

Author: drbrain

lib/rdoc/any_method.rb

@@ -25,6 +25,11 @@ class RDoc::AnyMethod < RDoc::MethodAttr
 
   attr_accessor :params
 
+  ##
+  # Uses superclass implementation
+
+  attr_accessor :uses_superclass
+
   include RDoc::TokenStream
 
   ##
@@ -36,6 +41,27 @@ def initialize text, name
     @c_function = nil
     @dont_rename_initialize = false
     @token_stream = nil
+    @uses_superclass = false
+  end
+
+  ##
+  # For methods that use the superclass, find the next superclass method that
+  # would be called.
+
+  def find_superclass_method
+    return nil unless uses_superclass
+
+    method = nil
+    next_superclass = parent.superclass
+
+    until next_superclass.kind_of?(String) or !next_superclass
+      if method = next_superclass.method_list.find { |x| x == self }
+        break
+      end
+      next_superclass = next_superclass.superclass
+    end
+
+    return method
   end
 
   ##

lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml

@@ -5,7 +5,7 @@
 
   <ul class="link-list">
     <% klass.each_method do |meth| %>
-    <li><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= h meth.name %></a>
+    <li <% if meth.uses_superclass %> class="superclass" <% end %>><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= h meth.name %></a>
     <% end %>
   </ul>
 </nav>

lib/rdoc/generator/template/darkfish/class.rhtml

@@ -130,6 +130,16 @@
           <% else %>
           <p class="missing-docs">(Not documented)
           <% end %>
+          <% if method.uses_superclass %>
+            <div class="method-superclass">
+              Calls superclass method
+              <%=
+                  method.find_superclass_method ?
+                  method.formatter.link(method.find_superclass_method.full_name, method.find_superclass_method.full_name) :
+                  method.parent.superclass
+              %>
+            </div>
+          <% end %>
 
           <% if method.token_stream then %>
           <div class="method-source-code" id="<%= method.html_name %>-source">

lib/rdoc/generator/template/darkfish/images/arrow_up.png

@@ -6,6 +6,7 @@
  *
  */
 
+/* vim: ft=css et sw=2 ts=2 sts=2 */
 /* Base Green is: #6C8C22 */
 
 * { padding: 0; margin: 0; }
@@ -212,7 +213,9 @@ dl.svninfo dt {
 
 ul.link-list li {
   white-space: nowrap;
+  line-height: 20px;
 }
+
 ul.link-list .type {
   font-size: 8px;
   text-transform: uppercase;
@@ -222,6 +225,10 @@ ul.link-list .type {
   -webkit-border-radius: 5px;
 }
 
+ul.link-list li.superclass {
+  background: url(images/arrow_up.png) no-repeat right center;
+}
+
 /* @end */
 
 /* @group Class Metadata Section */
@@ -394,6 +401,11 @@ ul.link-list .type {
   display: none;
 }
 
+#documentation .method-description .method-superclass {
+  color: #333;
+  font-weight: bolder;
+}
+
 #documentation .method-detail {
   margin: 0.5em 0;
   padding: 0.5em 0;

lib/rdoc/generator/template/darkfish/rdoc.css

@@ -1388,6 +1388,9 @@ def parse_statements(container, single = NORMAL, current_method = nil,
       when TkCASE, TkDO, TkIF, TkUNLESS, TkBEGIN then
         nest += 1
 
+      when TkSUPER then
+        current_method.uses_superclass = true
+
       when TkIDENTIFIER then
         if nest == 1 and current_method.nil? then
           case tk.name

lib/rdoc/parser/ruby.rb

@@ -244,5 +244,34 @@ def test_parent_name
     assert_equal 'C1', @c1.method_list.last.parent_name
   end
 
+  def test_find_superclass_method
+    k3 = RDoc::NormalClass.new "RDoc::CodeObject", nil
+    k2 = RDoc::NormalClass.new "RDoc::MethodAttr", k3
+    k = RDoc::NormalClass.new "RDoc::AnyMethod", k2
+
+    m = RDoc::AnyMethod.new "def test_super", "test_super"
+    m2 = RDoc::AnyMethod.new "def test_super", "test_super"
+    m3 = RDoc::AnyMethod.new "def test_no_super", "test_no_super"
+  
+    m.uses_superclass = true
+    k.add_method m
+    k.add_method m3
+
+    k2.add_method m2
+
+    assert_nil(m3.find_superclass_method, 'no superclass method for "test_no_super"')
+    assert_equal(m2, m.find_superclass_method, 'superclass method found for "test_super"')
+    
+    k2 = RDoc::NormalClass.new "RDoc::MethodAttr", k3
+    k = RDoc::NormalClass.new "RDoc::AnyMethod", k2
+    
+    m.uses_superclass = true
+    k.add_method m
+    k.add_method m3
+
+    k3.add_method m2
+
+    assert_equal(m2, m.find_superclass_method, 'superclass method found two levels up')
+  end
 end
 

test/test_rdoc_any_method.rb

@@ -2456,6 +2456,32 @@ class Baz
     assert_equal 'there', baz.comment.text
   end
 
+  def test_uses_superclass
+    util_parser <<-EOS
+      class Bar
+        def bar
+        end
+      end
+      class Foo < Bar
+        def bar
+          super
+        end
+      end
+    EOS
+
+    @parser.parse_statements @top_level
+
+    bar = @top_level.classes.first
+    foo = @top_level.classes.last
+
+    foo_bar = foo.method_list.first
+    bar_bar = bar.method_list.first
+
+    assert(foo_bar.uses_superclass)
+    assert_equal(bar_bar, foo_bar.find_superclass_method)
+    refute(bar_bar.uses_superclass)
+  end
+
   def tk(klass, line, char, name, text)
     klass = RDoc::RubyToken.const_get "Tk#{klass.to_s.upcase}"