Added RDoc::MethodAttr#output_name to reduce the occurances of SomeClass::method in output. This should help prevent people from using :: to call class methods, even though that works

Author: drbrain

History.rdoc

@@ -52,9 +52,9 @@
     <tt>RDoc::Markup@Links</tt>
 
     See RDoc::Markup@Links for further details.
-  * RDoc now looks for a <tt>markup: parser_name</tt> magic comment to choose
-    alternate documentation formats.  The format comment must be in the first
-    three lines of the file (to allow for a shebang or modeline).
+  * For HTML output RDoc uses +SomeClass.method_name+ and
+    +SomeClass#method_name+ for remote methods and attributes and
+    +::method_name+ and +#method_name+ for local methods.
   * RDoc makes an effort to syntax-highlight ruby code in verbatim sections.
     See RDoc::Markup@Paragraphs+and+Verbatim
   * Added RDoc::TopLevel#text? and RDoc::Parser::Text to indicate a

lib/rdoc/markup/to_html_crossref.rb

@@ -131,6 +131,8 @@ def link name, text
 
     ref = @cross_reference.resolve name, text
 
+    text = ref.output_name @context if RDoc::MethodAttr === ref and not label
+
     case ref
     when String then
       ref

lib/rdoc/method_attr.rb

@@ -268,14 +268,27 @@ def html_name
   # Full method/attribute name including namespace
 
   def full_name
-    @full_name || "#{parent_name}#{pretty_name}"
+    @full_name ||= "#{parent_name}#{pretty_name}"
   end
 
   ##
   # '::' for a class method/attribute, '#' for an instance method.
 
   def name_prefix
-    singleton ? '::' : '#'
+    @singleton ? '::' : '#'
+  end
+
+  ##
+  # Name for output to HTML.  For class methods the full name with a "." is
+  # used like +SomeClass.method_name+.  For instance methods the class name is
+  # used if +context+ does not match the parent.
+  #
+  # This is to help prevent people from using :: to call class methods.
+
+  def output_name context
+    return "#{name_prefix}#{@name}" if context == parent
+
+    "#{parent_name}#{@singleton ? '.' : '#'}#{@name}"
   end
 
   ##

test/test_rdoc_attr.rb

@@ -65,6 +65,16 @@ def test_marshal_dump
     assert_equal 'RW',         loaded.rw
     assert_equal false,        loaded.singleton
     assert_equal :public,      loaded.visibility
+  end
+
+  def test_marshal_dump_singleton
+    tl = RDoc::TopLevel.new 'file.rb'
+
+    @a.comment = 'this is a comment'
+    @a.record_location tl
+
+    cm = RDoc::ClassModule.new 'Klass'
+    cm.add_attribute @a
 
     @a.rw = 'R'
     @a.singleton = true
@@ -74,6 +84,9 @@ def test_marshal_dump
 
     assert_equal @a, loaded
 
+    comment = RDoc::Markup::Document.new(
+                RDoc::Markup::Paragraph.new('this is a comment'))
+
     assert_equal comment,       loaded.comment
     assert_equal 'Klass::attr', loaded.full_name
     assert_equal 'attr',        loaded.name

test/test_rdoc_markup_to_html_crossref.rb

@@ -43,7 +43,7 @@ def test_convert_RDOCLINK_rdoc_ref
   def test_convert_RDOCLINK_rdoc_ref_method
     result = @to.convert 'rdoc-ref:C1#m'
 
-    assert_equal para("<a href=\"C1.html#method-i-m\">C1#m</a>"), result
+    assert_equal para("<a href=\"C1.html#method-i-m\">#m</a>"), result
   end
 
   def test_convert_RDOCLINK_rdoc_ref_method_label
@@ -59,14 +59,13 @@ def test_convert_RDOCLINK_rdoc_ref_method_percent
 
     result = @to.convert 'rdoc-ref:C1#%'
 
-    assert_equal para("<a href=\"C1.html#method-i-25\">C1#%</a>"), result
+    assert_equal para("<a href=\"C1.html#method-i-25\">#%</a>"), result
 
     m.singleton = true
 
     result = @to.convert 'rdoc-ref:C1::%'
 
-    assert_equal para("<a href=\"C1.html#method-c-25\">C1::%</a>"), result
-
+    assert_equal para("<a href=\"C1.html#method-c-25\">::%</a>"), result
   end
 
   def test_convert_RDOCLINK_rdoc_ref_method_percent_label
@@ -113,7 +112,7 @@ def test_handle_special_CROSSREF_label
   def test_handle_special_CROSSREF_show_hash_false
     @to.show_hash = false
 
-    assert_equal "<a href=\"C1.html#method-i-m\">m</a>",
+    assert_equal "<a href=\"C1.html#method-i-m\">#m</a>",
                  SPECIAL('#m')
   end
 
@@ -165,7 +164,12 @@ def test_handle_special_TIDYLINK_label
   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')
+    assert_equal '<a href="C1.html#method-c-m">::m</a>', @to.link('m', 'm')
+  end
+
+  def test_link_class_method_full
+    assert_equal '<a href="Parent.html#method-c-m">Parent.m</a>',
+                 @to.link('Parent::m', 'Parent::m')
   end
 
   def para text

test/test_rdoc_method_attr.rb

@@ -111,6 +111,19 @@ def test_find_method_or_attribute_recursive
     assert_nil @m1_m.find_method_or_attribute 'm'
   end
 
+  def test_full_name
+    assert_equal 'C1#m',  @c1_m.full_name
+    assert_equal 'C1::m', @c1__m.full_name
+  end
+
+  def test_output_name
+    assert_equal '#m',  @c1_m.output_name(@c1)
+    assert_equal '::m', @c1__m.output_name(@c1)
+
+    assert_equal 'C1#m', @c1_m.output_name(@c2)
+    assert_equal 'C1.m', @c1__m.output_name(@c2)
+  end
+
   def test_search_record
     @c1_m.comment = 'This is a comment.'