Don't auto-link lowercase single words w/o #

Author: drbrain

History.txt

@@ -15,6 +15,10 @@
   * Fixed "unitialized constant RDoc::Markup::ToHtml::HTML"
   * Fixed generation of relative links
   * Fixed various diagram generation issues
+  * Fixed templates broken by switch to erb
+  * Fixed issue with <!-- --> style comments
+  * Lowercase words are no longer rdoc'd as methods without leading #, as
+    described in the documentation
 
 === 2.0.0 / 2008-04-10
 

lib/rdoc/code_objects.rb

@@ -408,26 +408,30 @@ def <=>(other)
       name <=> other.name
     end
 
-    # Look up the given symbol. If method is non-nil, then
-    # we assume the symbol references a module that
-    # contains that method
-    def find_symbol(symbol, method=nil)
+    ##
+    # Look up +symbol+.  If +method+ is non-nil, then we assume the symbol
+    # references a module that contains that method.
+
+    def find_symbol(symbol, method = nil)
       result = nil
+
       case symbol
-      when /^::(.*)/
+      when /^::(.*)/ then
         result = toplevel.find_symbol($1)
-      when /::/
+      when /::/ then
         modules = symbol.split(/::/)
-        unless modules.empty?
+
+        unless modules.empty? then
           module_name = modules.shift
           result = find_module_named(module_name)
-          if result
+          if result then
             modules.each do |name|
               result = result.find_module_named(name)
               break unless result
             end
           end
         end
+
       else
         # if a method is specified, then we're definitely looking for
         # a module, otherwise it could be any symbol
@@ -445,14 +449,12 @@ def find_symbol(symbol, method=nil)
           end
         end
       end
-      if result && method
-        if !result.respond_to?(:find_local_symbol)
-          #p result.name
-          #p method
-          fail
-        end
+
+      if result and method then
+        fail unless result.respond_to? :find_local_symbol
         result = result.find_local_symbol(method)
       end
+
       result
     end
 

lib/rdoc/markup/to_html_crossref.rb

@@ -48,41 +48,42 @@ def initialize(from_path, context, show_hash)
   def handle_special_CROSSREF(special)
     name = special.text
 
+    return name if name =~ /\A[a-z]*\z/
+
     return @seen[name] if @seen.include? name
 
-    if name[0,1] == '#' then
+    if name[0, 1] == '#' then
       lookup = name[1..-1]
       name = lookup unless @show_hash
     else
       lookup = name
     end
 
-    #
+
     # Find class, module, or method in class or module.
-    # Do not, however, use an if/elsif/else chain to do so.  Instead, test
-    # each possible pattern until one matches.  The reason for this is that
-    # a string like "YAML.txt" could be the txt() class method of class YAML
-    # (in which case it would match the first pattern, which splits the
-    # string into container and method components and looks up both) or a
-    # filename (in which case it would match the last pattern, which just
-    # checks whether the string as a whole is a known symbol).
     #
+    # Do not, however, use an if/elsif/else chain to do so.  Instead, test
+    # each possible pattern until one matches.  The reason for this is that a
+    # string like "YAML.txt" could be the txt() class method of class YAML (in
+    # which case it would match the first pattern, which splits the string
+    # into container and method components and looks up both) or a filename
+    # (in which case it would match the last pattern, which just checks
+    # whether the string as a whole is a known symbol).
+
     if /([A-Z][\w:]*)[.\#](\w+[!?=]?)/ =~ lookup then
       container = $1
       method = $2
       ref = @context.find_symbol container, method
     end
 
-    if (!ref &&
-        /([A-Za-z][\w:]*)[.\#](\w+(\([\.\w+\*\/\+\-\=\<\>]+\))?)/ =~ lookup) then
+    if !ref and
+       /([A-Za-z][\w:]*)[.\#](\w+(\([\.\w+\*\/\+\-\=\<\>]+\))?)/ =~ lookup then
       container = $1
       method = $2
       ref = @context.find_symbol container, method
     end
 
-    if(!ref)
-      ref = @context.find_symbol lookup
-    end
+    ref = @context.find_symbol lookup unless ref
 
     out = if lookup =~ /^\\/ then
             $'

test/test_rdoc_markup_to_html_crossref.rb

@@ -0,0 +1,18 @@
+require 'test/unit'
+require 'rdoc/generator'
+require 'rdoc/markup/to_html_crossref'
+
+class TestRdocMarkupToHtmlCrossref < Test::Unit::TestCase
+
+  def setup
+    @xref = RDoc::Markup::ToHtmlCrossref.new 'from_path', nil, nil
+  end
+
+  def test_handle_special_CROSSREF_no_underscore
+    out = @xref.convert 'foo'
+
+    assert_equal "<p>\nfoo\n</p>\n", out
+  end
+
+end
+