Exclude TAGS files that may have been included in gems from parsing. Issue #81

Author: drbrain

History.rdoc

@@ -1,4 +1,10 @@
-=== 3.10 / ??
+=== 3.11 / 2011/10-17
+
+* Bug fixes
+  * Avoid parsing TAGS files included in gems.  Issue #81 by Santiago
+    Pastorino.
+
+=== 3.10 / 2011-10-08
 
 * Major enhancements
   * RDoc HTML output has been improved:

TODO.rdoc

@@ -30,3 +30,7 @@ API changes to RDoc
   * Rename Context to Container
   * Rename NormalClass to Class
 
+=== Crazy Ideas
+
+  * Auto-normalize heading levels to look OK.  It's weird to see an <h1> in
+    the middle of a method section.

lib/rdoc/rdoc.rb

@@ -402,11 +402,16 @@ def parse_files files
   end
 
   ##
-  # Removes file extensions known to be unparseable from +files+
+  # Removes file extensions known to be unparseable from +files+ and TAGS
+  # files for emacs and vim.
 
   def remove_unparseable files
     files.reject do |file|
-      file =~ /\.(?:class|eps|erb|scpt\.txt|ttf|yml)$/i
+      file =~ /\.(?:class|eps|erb|scpt\.txt|ttf|yml)$/i or
+        (file =~ /tags$/i and
+         open(file, 'rb') { |io|
+           io.read(100) =~ /\A(\f\n[^,]+,\d+$|!_TAG_)/
+         })
     end
   end
 

test/test_rdoc_rdoc.rb

@@ -122,6 +122,34 @@ def test_remove_unparseable
     assert_empty @rdoc.remove_unparseable file_list
   end
 
+  def test_remove_unparseable_tags_emacs
+    temp_dir do
+      open 'TAGS', 'w' do |io| # emacs
+        io.write "\f\nlib/foo.rb,43\n"
+      end
+
+      file_list = %w[
+        TAGS
+      ]
+
+      assert_empty @rdoc.remove_unparseable file_list
+    end
+  end
+
+  def test_remove_unparseable_tags_vim
+    temp_dir do
+      open 'TAGS', 'w' do |io| # emacs
+        io.write "!_TAG_"
+      end
+
+      file_list = %w[
+        TAGS
+      ]
+
+      assert_empty @rdoc.remove_unparseable file_list
+    end
+  end
+
   def test_setup_output_dir
     Dir.mktmpdir {|d|
       path = File.join d, 'testdir'