Add autolink_excluded_words option to ignore cross-references

This config will be handy when the project name is the same as a class or
module name, which is often the case for most of the projects.

Author: st0012

Diff for: lib/rdoc/markup/to_html_crossref.rb

@@ -151,6 +151,8 @@ def link name, text, code = true, rdoc_ref: false
       label = $'
     end
 
+    return name if name == text && @options.autolink_excluded_words&.include?(name)
+
     ref = @cross_reference.resolve name, text if name
 
     case ref

Diff for: lib/rdoc/options.rb

@@ -359,6 +359,10 @@ class RDoc::Options
   # Exclude the default patterns as well if true.
   attr_reader :apply_default_exclude
 
+  ##
+  # Words to be ignored in autolink cross-references
+  attr_accessor :autolink_excluded_words
+
   def initialize loaded_options = nil # :nodoc:
     init_ivars
     override loaded_options if loaded_options
@@ -370,6 +374,7 @@ def initialize loaded_options = nil # :nodoc:
   ]
 
   def init_ivars # :nodoc:
+    @autolink_excluded_words = []
     @dry_run = false
     @embed_mixins = false
     @exclude = []
@@ -437,7 +442,9 @@ def init_with map # :nodoc:
     @title          = map['title']
     @visibility     = map['visibility']
     @webcvs         = map['webcvs']
-    @apply_default_exclude = map['apply_default_exclude']
+
+    @apply_default_exclude   = map['apply_default_exclude']
+    @autolink_excluded_words = map['autolink_excluded_words']
 
     @rdoc_include = sanitize_path map['rdoc_include']
     @static_path  = sanitize_path map['static_path']
@@ -471,6 +478,7 @@ def override map # :nodoc:
     @title          = map['title']          if map.has_key?('title')
     @visibility     = map['visibility']     if map.has_key?('visibility')
     @webcvs         = map['webcvs']         if map.has_key?('webcvs')
+    @autolink_excluded_words = map['autolink_excluded_words'] if map.has_key?('autolink_excluded_words')
     @apply_default_exclude = map['apply_default_exclude'] if map.has_key?('apply_default_exclude')
 
     @warn_missing_rdoc_ref = map['warn_missing_rdoc_ref'] if map.has_key?('warn_missing_rdoc_ref')
@@ -503,7 +511,8 @@ def == other # :nodoc:
       @title          == other.title          and
       @visibility     == other.visibility     and
       @webcvs         == other.webcvs         and
-      @apply_default_exclude == other.apply_default_exclude
+      @apply_default_exclude == other.apply_default_exclude and
+      @autolink_excluded_words == other.autolink_excluded_words
   end
 
   ##
@@ -989,6 +998,13 @@ def parse argv
 
       opt.separator nil
 
+      opt.on("--autolink-excluded-words=WORDS", Array,
+             "Words to be ignored in autolink cross-references") do |value|
+        @autolink_excluded_words = value
+      end
+
+      opt.separator nil
+
       opt.on("--hyperlink-all", "-A",
              "Generate hyperlinks for all words that",
              "correspond to known methods, even if they",

Diff for: test/rdoc/test_rdoc_markup_to_html_crossref.rb

@@ -20,6 +20,9 @@ def test_convert_CROSSREF
     result = @to.convert '+C1+'
     assert_equal para("<a href=\"C1.html\"><code>C1</code></a>"), result
 
+    result = @to.convert 'Constant[rdoc-ref:C1]'
+    assert_equal para("<a href=\"C1.html\">Constant</a>"), result
+
     result = @to.convert 'FOO'
     assert_equal para("FOO"), result
 
@@ -30,6 +33,21 @@ def test_convert_CROSSREF
     assert_equal para("<code># :stopdoc:</code>:"), result
   end
 
+  def test_convert_CROSSREF_ignored_excluded_words
+    @options.autolink_excluded_words = ['C1']
+
+    result = @to.convert 'C1'
+
+    assert_equal para("C1"), result
+
+    result = @to.convert '+C1+'
+    assert_equal para("<code>C1</code>"), result
+
+    # Explicit linking with rdoc-ref is not ignored
+    result = @to.convert 'Constant[rdoc-ref:C1]'
+    assert_equal para("<a href=\"C1.html\">Constant</a>"), result
+  end
+
   def test_convert_CROSSREF_method
     result = @to.convert 'C1#m(foo, bar, baz)'
 

Diff for: test/rdoc/test_rdoc_options.rb

@@ -86,6 +86,7 @@ def test_to_yaml
       'webcvs'                => nil,
       'skip_tests'            => true,
       'apply_default_exclude' => true,
+      'autolink_excluded_words' => [],
     }
 
     assert_equal expected, coder