rdoc-tags 1.1 → 1.2

data/History.txt

@@ -1,3 +1,15 @@
+=== 1.2
+
+* Minor enhancements
+  * rdoc-tags can now merge with Exuberant Ctags for projects with extensions
+    or other languages.  Use <tt>--ctags-merge</tt> to enable merging.
+    rdoc-tags will discover Exuberant Ctags in your PATH by checking the
+    output of <tt>ctags --version</tt>.
+* Bug Fixes
+  * Fixed Hoe plugin to match RDoc::TagsTask arguments.
+  * Require rdoc/generator/tags first for RDoc::TagsTask.
+  * The tags generator no longer creates a create.rid file.
+
 === 1.1 / 2010-12-29
 
 * Minor enhancements

data/Rakefile

@@ -3,6 +3,8 @@
 require 'rubygems'
 require 'hoe'
 
+$:.unshift 'lib' # allow rdoc-tags to tag itself
+
 Hoe.plugin :git
 Hoe.plugin :isolate
 Hoe.plugin :minitest
@@ -12,10 +14,13 @@ Hoe.plugins.delete :rubyforge
 Hoe.spec 'rdoc-tags' do
   developer 'Eric Hodel', 'drbrain@segment7.net'
 
-  extra_deps << ['rdoc', '~> 3.2']
+  extra_deps << ['rdoc', '~> 3.4'] # don't forget to update rdoc/discover.rb
   extra_dev_deps << ['isolate', '~> 3']
+  extra_dev_deps << ['ZenTest']
 
   self.isolate_dir = 'tmp/isolate'
+  self.rdoc_locations =
+    'drbrain@rubyforge.org:/var/www/gforge-projects/rdoc/rdoc-tags'
 end
 
 # vim: syntax=Ruby

data/lib/hoe/rdoc_tags.rb

@@ -24,15 +24,23 @@ module Hoe::RDoc_tags
   # Hoe.
 
   def define_rdoc_tags_tasks
-    tags_style = 'vim'
+    ctags_merge = false
+    ctags_path  = nil
 
     with_config do |config, _|
-      tags_style = config['tags_style']
+      tag_style   = config['tag_style']
+      ctags_merge = config['ctags_merge'] if config.key? 'ctags_merge'
+      ctags_path  = config['ctags_path']
     end
 
+    tag_style ||= 'vim'
+
     RDoc::TagsTask.new do |rd|
       rd.files += spec.require_paths
-      rd.tags_style = tags_style
+
+      rd.tag_style   = tag_style
+      rd.ctags_merge = ctags_merge
+      rd.ctags_path  = ctags_path
     end
 
     task :clean   => :clobber_tags

data/lib/rdoc/discover.rb

@@ -1,6 +1,7 @@
 begin
-  gem 'rdoc', '~> 3'
+  gem 'rdoc', '~> 3.4'
+  require 'rdoc/generator'
   require 'rdoc/generator/tags'
-rescue Gem::LoadError
+rescue Gem::LoadError => e
 end
 

data/lib/rdoc/generator/tags.rb

@@ -1,15 +1,15 @@
-require 'rdoc/rdoc'
-require 'rdoc/generator'
-
 ##
 # A TAGS file generator based on http://ctags.sourceforge.net/FORMAT
+#
+# This file will be automatically loaded via rdoc/discover.rb.  If you wish to
+# load this standalone, require 'rdoc/rdoc' first.
 
 class RDoc::Generator::Tags
 
   ##
   # The version of the tags generator you are using
 
-  VERSION = '1.1'
+  VERSION = '1.2'
 
   RDoc::RDoc.add_generator self
 
@@ -23,6 +23,16 @@ class RDoc::Generator::Tags
 
     TAG_STYLES = [:vim]
 
+    ##
+    # Merge ctags-generated tags onto our own?
+
+    attr_accessor :ctags_merge
+
+    ##
+    # Path to Exuberant Ctags
+
+    attr_accessor :ctags_path
+
     ##
     # Which tag style shall we output?
 
@@ -30,12 +40,23 @@ class RDoc::Generator::Tags
 
   end
 
+  ##
+  # Merge with Exuberant Ctags if true
+
+  attr_accessor :ctags_merge
+
+  ##
+  # Path to Exuberant Ctags
+
+  attr_accessor :ctags_path
+
   ##
   # Adds tags-generator options to the RDoc::Options instance +options+
 
   def self.setup_options options
     options.force_output = true
     options.op_dir = '.'
+    options.update_output_dir = false
 
     options.extend Options
 
@@ -47,6 +68,22 @@ class RDoc::Generator::Tags
     op.separator 'tags generator options:'
     op.separator nil
 
+    op.on('--[no-]ctags-merge',
+          'Merge exuberant ctags with our own?',
+          'Use this for projects with C extensions') do |value|
+      options.ctags_path = value
+    end
+
+    op.separator nil
+
+    op.on('--ctags-path=PATH',
+          'Path to Exuberant Ctags',
+          'This will be auto-discovered from PATH') do |value|
+      options.ctags_path = value
+    end
+
+    op.separator nil
+
     op.on('--tag-style=TAG_STYLE', Options::TAG_STYLES,
           'Which type of TAGS file to output') do |value|
       options.tag_style = value
@@ -60,10 +97,34 @@ class RDoc::Generator::Tags
 
   def initialize options
     @options = options
-    @dry_run = options.dry_run
+
+    @ctags_merge = options.ctags_merge
+    @ctags_path  = options.ctags_path
+    @dry_run     = options.dry_run
+
     @tags = Hash.new { |h, name| h[name] = [] }
   end
 
+  ##
+  # Finds the first Exuberant Ctags in ENV['PATH'] by checking <tt>ctags
+  # --version</tt>.  Other implementations are ignored.
+
+  def find_ctags
+    require 'open3'
+
+    ENV['PATH'].split(File::PATH_SEPARATOR).each do |dir|
+      ctags = File.join dir, 'ctags'
+      next unless File.exist? ctags
+
+      # other ctags implementations write to stderr, silence them
+      return ctags if Open3.popen3 ctags, '--version' do |_, out, _|
+        out.gets =~ /^Exuberant Ctags/
+      end
+    end
+
+    nil
+  end
+
   ##
   # Generates a TAGS file from +top_levels+
 
@@ -94,7 +155,7 @@ class RDoc::Generator::Tags
           'f',
           kind
         ]
-        
+
         @tags[attr.name]       << where
         @tags["#{attr.name}="] << where
       end
@@ -117,7 +178,22 @@ class RDoc::Generator::Tags
       end
     end
 
-    write_tags unless @dry_run
+    unless @dry_run then
+      write_tags
+      merge_ctags
+    end
+  end
+
+  ##
+  # Merges our tags with Exuberant Ctags' tags
+
+  def merge_ctags
+    return unless @ctags_merge
+
+    ctags_path = @ctags_path || find_ctags
+
+    system(ctags_path, '--append=yes', '--format=2', '--languages=-Ruby',
+           '--recurse=yes', *@options.files)
   end
 
   ##
@@ -126,12 +202,12 @@ class RDoc::Generator::Tags
   def write_tags
     open 'TAGS', 'w' do |io|
       io.write <<-INFO
-!_TAG_FILE_FORMAT\t2
-!_TAG_FILE_SORTED\t1
+!_TAG_FILE_FORMAT\t2\t/extended format/
+!_TAG_FILE_SORTED\t1\t/sorted/
 !_TAG_PROGRAM_AUTHOR\tEric Hodel\t/drbrain@segment7.net/
-!_TAG_PROGRAM_NAME\trdoc-tags
-!_TAG_PROGRAM_URL\thttps://github.com/rdoc/rdoc-tags
-!_TAG_PROGRAM_VERSION\t#{VERSION}
+!_TAG_PROGRAM_NAME\trdoc-tags\t//
+!_TAG_PROGRAM_URL\thttps://github.com/rdoc/rdoc-tags\t//
+!_TAG_PROGRAM_VERSION\t#{VERSION}\t//
       INFO
 
       @tags.sort.each do |name, definitions|

data/lib/rdoc/tags_task.rb

@@ -8,6 +8,12 @@ end
 require 'rake'
 require 'rake/tasklib'
 
+begin
+  gem 'rdoc'
+rescue LoadError
+end
+require 'rdoc'
+
 ##
 # Creates rake tasks for building, rebuilding and removing TAGS files.
 #
@@ -27,6 +33,17 @@ require 'rake/tasklib'
 
 class RDoc::TagsTask < Rake::TaskLib
 
+  ##
+  # Merge Exuberant Ctags output with our own.  See RDoc::Generator::Tags
+
+  attr_accessor :ctags_merge
+
+  ##
+  # Path to Exuberant Ctags.  ctags will be found automatically if this is not
+  # set.  See RDoc::Generator::Tags
+
+  attr_accessor :ctags_path
+
   ##
   # Rake::FileList of files to be used for tag generation.
   #
@@ -65,6 +82,9 @@ class RDoc::TagsTask < Rake::TaskLib
     @tags_file = 'TAGS'
     @tag_style = 'vim'
 
+    @ctags_merge = false
+    @ctags_path  = nil
+
     yield self if block_given?
 
     define
@@ -74,24 +94,34 @@ class RDoc::TagsTask < Rake::TaskLib
   # Builds the TAGS file.
 
   def build_tags
-    args = [
-      '-f', 'tags',
-      '-q',
-      '--tag-style', @tag_style,
-      '-o', @tags_dir,
-    ]
-
-    args += @files
-
-    begin
-      gem 'rdoc'
-    rescue Gem::LoadError
-    end
-
     require 'rdoc/rdoc'
-    $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
+    require 'rdoc/generator/tags'
+
+    options = RDoc::Options.new
+    options.setup_generator 'tags'
+
+    options.tag_style = @tag_style
+
+    options.ctags_merge = @ctags_merge
+    options.ctags_path  = @ctags_path
+
+    options.files = @files
+
+    options.op_dir = @tags_dir
+    options.verbosity = 0
+
+    if Rake.application.options.trace then
+      options.verbosity = 1
+
+      # TODO RDoc::Options#to_argv?
+      ctags_merge = " --ctags-merge" if @ctags_merge
+      ctags_path = " --ctags_path=#{@ctags_path}" if @ctags_path
+      ctags = "#{ctags_merge}#{ctags_path}"
+
+      $stderr.puts "rdoc -o #{@tags_dir} -f tags#{ctags} #{@files}"
+    end
 
-    RDoc::RDoc.new.document args
+    RDoc::RDoc.new.document options
   end
 
   ##
@@ -106,7 +136,7 @@ class RDoc::TagsTask < Rake::TaskLib
 
     desc 'Clobber TAGS file'
     task @clobber_task do
-      rm_f tags_path
+      rm_f tags_path, :verbose => Rake.application.options.trace
     end
 
     directory @tags_dir

data/test/test_rdoc_generator_tags.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-gem 'rdoc', '~> 3'
+gem 'rdoc', '~> 3.4'
 
 require 'minitest/autorun'
 require 'rdoc/rdoc'
@@ -76,7 +76,14 @@ class TestRDocGeneratorTags < MiniTest::Unit::TestCase
 
     assert_equal :vim, options.tag_style
 
+    assert_includes op.top.long, 'ctags-path'
+    assert_includes op.top.long, 'ctags-merge'
     assert_includes op.top.long, 'tag-style'
+    refute options.update_output_dir
+  end
+
+  def test_find_ctags
+    assert_equal '/usr/local/bin/ctags', @g.find_ctags
   end
 
   def test_generate_emacs
@@ -139,14 +146,14 @@ class TestRDocGeneratorTags < MiniTest::Unit::TestCase
 
     tags = File.read(tags_file).lines
 
-    assert_equal "!_TAG_FILE_FORMAT\t2\n", tags.next
-    assert_equal "!_TAG_FILE_SORTED\t1\n", tags.next
+    assert_equal "!_TAG_FILE_FORMAT\t2\t/extended format/\n", tags.next
+    assert_equal "!_TAG_FILE_SORTED\t1\t/sorted/\n", tags.next
     assert_equal "!_TAG_PROGRAM_AUTHOR\tEric Hodel\t/drbrain@segment7.net/\n",
                  tags.next
-    assert_equal "!_TAG_PROGRAM_NAME\trdoc-tags\n", tags.next
-    assert_equal "!_TAG_PROGRAM_URL\thttps://github.com/rdoc/rdoc-tags\n",
+    assert_equal "!_TAG_PROGRAM_NAME\trdoc-tags\t//\n", tags.next
+    assert_equal "!_TAG_PROGRAM_URL\thttps://github.com/rdoc/rdoc-tags\t//\n",
                  tags.next
-    assert_equal "!_TAG_PROGRAM_VERSION\t#{RDoc::Generator::Tags::VERSION}\n",
+    assert_equal "!_TAG_PROGRAM_VERSION\t#{RDoc::Generator::Tags::VERSION}\t//\n",
                  tags.next
 
     assert_equal "A\tfile.rb\t/class A/;\"\tc\n",                  tags.next
@@ -188,5 +195,29 @@ class TestRDocGeneratorTags < MiniTest::Unit::TestCase
     refute File.exist? File.join(@tmpdir, 'TAGS')
   end
 
+  def test_merge_ctags
+    def @g.system(*args)
+      @system = args
+    end
+
+    @g.instance_variable_set :@system, nil
+
+    @g.merge_ctags
+
+    assert_nil @g.instance_variable_get :@system
+
+    @g.ctags_merge = true
+    @g.ctags_path = 'ctags'
+    @options.files = '.'
+
+    @g.merge_ctags
+
+    args = @g.instance_variable_get :@system
+
+    assert_equal %w[ctags
+                    --append=yes --format=2 --languages=-Ruby --recurse=yes
+                    .], args
+  end
+
 end
 

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc-tags
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 1
-  - 1
-  version: "1.1"
+  - 2
+  version: "1.2"
 platform: ruby
 authors: 
 - Eric Hodel
@@ -35,7 +35,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2010-12-29 00:00:00 -08:00
+date: 2011-01-06 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,11 +46,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 15
         segments: 
         - 3
-        - 2
-        version: "3.2"
+        - 4
+        version: "3.4"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -84,9 +84,23 @@ dependencies:
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: ZenTest
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -98,7 +112,7 @@ dependencies:
         - 0
         version: 2.7.0
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 description: |-
   A TAGS file generator based on http://ctags.sourceforge.net/FORMAT.  rdoc-tags
   handles namespaced classes and modules, ! and ? methods, constants and