rdoc-tags 1.0 → 1.1

data/History.txt

@@ -1,3 +1,12 @@
+=== 1.1 / 2010-12-29
+
+* Minor enhancements
+  * Added RDoc::TagsTask which generates a TAGS file
+  * Added +:rdoc_tags+ plugin for Hoe
+* Bug fix
+  * Multiple tags are now generated for definitions across more than one file.
+    Bug #1 by postmodern.
+
 === 1.0 / 2010-12-23
 
 * 1 major enhancement

data/Manifest.txt

@@ -3,6 +3,8 @@ History.txt
 Manifest.txt
 README.txt
 Rakefile
+lib/hoe/rdoc_tags.rb
 lib/rdoc/discover.rb
 lib/rdoc/generator/tags.rb
+lib/rdoc/tags_task.rb
 test/test_rdoc_generator_tags.rb

data/README.txt

@@ -1,4 +1,4 @@
-= rdoc_tags
+= rdoc-tags
 
 * https://github.com/rdoc/rdoc-tags
 
@@ -8,6 +8,10 @@ A TAGS file generator based on http://ctags.sourceforge.net/FORMAT.  rdoc-tags
 handles namespaced classes and modules, ! and ? methods, constants and
 attributes better than Exuberant Ctags.
 
+rdoc-tags includes a Hoe plugin +:rdoc_tags+ making it easy to add tag support
+to your ruby project.  If you don't use Hoe you can instead use RDoc::TagsTask
+to add rake tasks for building TAGS to your ruby project.
+
 == FEATURES/PROBLEMS:
 
 * Much slower that Exuberant Ctags

data/Rakefile

@@ -6,15 +6,16 @@ require 'hoe'
 Hoe.plugin :git
 Hoe.plugin :isolate
 Hoe.plugin :minitest
+Hoe.plugin :rdoc_tags
 Hoe.plugins.delete :rubyforge
 
 Hoe.spec 'rdoc-tags' do
   developer 'Eric Hodel', 'drbrain@segment7.net'
 
-  extra_deps << ['rdoc', '~> 3']
+  extra_deps << ['rdoc', '~> 3.2']
   extra_dev_deps << ['isolate', '~> 3']
 
-  self.isolate_dir = 'tmp/isolated'
+  self.isolate_dir = 'tmp/isolate'
 end
 
 # vim: syntax=Ruby

data/lib/hoe/rdoc_tags.rb

@@ -0,0 +1,44 @@
+require 'rdoc/tags_task'
+
+##
+# The RDoc tags plugin for Hoe uses the standard names +tags+, +retag+ and
+# +clobber_tags+ from RDoc::TagsTask.  The plugin also integrates with the
+# +clean+, +clobber+ and +newb+ tasks Hoe provides to add automatic cleanup.
+#
+# The +tags+ task automatically builds tags using all files in your
+# specification's require paths (defaults to the lib directory).
+#
+# When the +newb+ task is run the plugin will automatically build a TAGS file.
+#
+# When the +clean+ or +clobber+ task is run the plugin will automatically
+# remove the TAGS file.
+#
+# The plugin defaults to generating vim-style tags.  You can override this by
+# setting a value for <tt>'tags_style'</tt> in ~/.hoerc.  Be sure to check
+# <tt>rdoc --help</tt> for valid values.
+
+module Hoe::RDoc_tags
+
+  ##
+  # Defines tasks for building and removing TAGS files that integrate with
+  # Hoe.
+
+  def define_rdoc_tags_tasks
+    tags_style = 'vim'
+
+    with_config do |config, _|
+      tags_style = config['tags_style']
+    end
+
+    RDoc::TagsTask.new do |rd|
+      rd.files += spec.require_paths
+      rd.tags_style = tags_style
+    end
+
+    task :clean   => :clobber_tags
+    task :clobber => :clobber_tags
+    task :newb    => :tags
+  end
+
+end
+

data/lib/rdoc/generator/tags.rb

@@ -9,7 +9,7 @@ class RDoc::Generator::Tags
   ##
   # The version of the tags generator you are using
 
-  VERSION = '1.0'
+  VERSION = '1.1'
 
   RDoc::RDoc.add_generator self
 
@@ -61,7 +61,7 @@ class RDoc::Generator::Tags
   def initialize options
     @options = options
     @dry_run = options.dry_run
-    @tags = {}
+    @tags = Hash.new { |h, name| h[name] = [] }
   end
 
   ##
@@ -69,7 +69,7 @@ class RDoc::Generator::Tags
 
   def generate top_levels
     top_levels.each do |top_level|
-      @tags[top_level.relative_name] = [top_level.relative_name, 0, 'F']
+      @tags[top_level.relative_name] << [top_level.relative_name, 0, 'F']
     end
 
     RDoc::TopLevel.all_classes_and_modules.each do |klass|
@@ -83,8 +83,8 @@ class RDoc::Generator::Tags
         end
 
       klass.in_files.each do |file|
-        @tags[klass.full_name] = [file.relative_name, address, 'c']
-        @tags[klass.name]      = [file.relative_name, address, 'c']
+        @tags[klass.full_name] << [file.relative_name, address, 'c']
+        @tags[klass.name]      << [file.relative_name, address, 'c']
       end
 
       klass.each_attribute do |attr|
@@ -95,12 +95,12 @@ class RDoc::Generator::Tags
           kind
         ]
         
-        @tags[attr.name]       = where
-        @tags["#{attr.name}="] = where
+        @tags[attr.name]       << where
+        @tags["#{attr.name}="] << where
       end
 
       klass.each_constant do |constant|
-        @tags[constant.name] = [
+        @tags[constant.name] << [
           constant.file.relative_name, "/#{constant.name}\\s\\*=/", 'd', kind]
       end
 
@@ -112,7 +112,7 @@ class RDoc::Generator::Tags
                     "/def #{method.name}/"
                   end
 
-        @tags[method.name] = [
+        @tags[method.name] << [
           method.file.relative_name, address, 'f', kind]
       end
     end
@@ -134,8 +134,10 @@ class RDoc::Generator::Tags
 !_TAG_PROGRAM_VERSION\t#{VERSION}
       INFO
 
-      @tags.sort.each do |name, (file, address, *field)|
-        io.write "#{name}\t#{file}\t#{address};\"\t#{field.join "\t"}\n"
+      @tags.sort.each do |name, definitions|
+        definitions.uniq.each do |(file, address, *field)|
+          io.write "#{name}\t#{file}\t#{address};\"\t#{field.join "\t"}\n"
+        end
       end
     end
   end

data/lib/rdoc/tags_task.rb

@@ -0,0 +1,129 @@
+require 'rubygems'
+
+begin
+  gem 'rake'
+rescue Gem::LoadError
+end
+
+require 'rake'
+require 'rake/tasklib'
+
+##
+# Creates rake tasks for building, rebuilding and removing TAGS files.
+#
+# In your Rakefile add:
+#
+#   require 'rdoc/tags_task'
+#
+#   RDoc::TagsTask.new
+#
+# Then run from the commandline:
+#
+#   $ rake tags         # build
+#   $ rake retag        # rebuild
+#   $ rake clobber_tags # remove
+#
+# Use the Hoe::RDoc_tags plugin instead if you're using Hoe.
+
+class RDoc::TagsTask < Rake::TaskLib
+
+  ##
+  # Rake::FileList of files to be used for tag generation.
+  #
+  # Your gem's require paths are probably sufficient.
+
+  attr_accessor :files
+
+  ##
+  # Directory to generate tags into.  Defaults to '.'
+
+  attr_accessor :tags_dir
+
+  ##
+  # Name of the TAGS file.  Defaults to 'TAGS'
+
+  attr_accessor :tags_file
+
+  ##
+  # Tag style to output.  Defaults to vim.
+
+  attr_accessor :tag_style
+
+  ##
+  # Creates a new RDoc task that will build a TAGS file.  Default task names
+  # are +tags+ to build, +retag+ to rebuild and +clobber_tags+ to remove.
+  # These may be overridden using the +names+ hash with the +:tags+,
+  # +:retag+ and +:clobber+ keys respectively.
+
+  def initialize names = {} # :yield: self
+    @clobber_task = names[:clobber] || 'clobber_tags'
+    @retag_task   = names[:retag]   || 'retag'
+    @tags_task    = names[:tags]    || 'tags'
+
+    @files     = Rake::FileList.new
+    @tags_dir  = '.'
+    @tags_file = 'TAGS'
+    @tag_style = 'vim'
+
+    yield self if block_given?
+
+    define
+  end
+
+  ##
+  # 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
+
+    RDoc::RDoc.new.document args
+  end
+
+  ##
+  # Defines tasks for building, rebuilding and clobbering the TAGS file
+
+  def define
+    desc 'Build TAGS file'
+    task @tags_task => @tags_file
+
+    desc 'Rebuild TAGS file'
+    task @retag_task => [@clobber_task, @tags_task]
+
+    desc 'Clobber TAGS file'
+    task @clobber_task do
+      rm_f tags_path
+    end
+
+    directory @tags_dir
+
+    file @tags_file => [@tags_dir, Rake.application.rakefile, @files] do
+      build_tags
+    end
+
+    self
+  end
+
+  ##
+  # Path to the tags file
+
+  def tags_path
+    File.join @tags_dir, @tags_file
+  end
+
+end
+

data/test/test_rdoc_generator_tags.rb

@@ -54,6 +54,10 @@ class TestRDocGeneratorTags < MiniTest::Unit::TestCase
     @klass.add_method @meth_bang
     @klass.add_attribute @attr
     @klass.add_constant @const
+
+    @top_level_2 = RDoc::TopLevel.new 'file_2.rb'
+    @A_B_A = @B.add_class RDoc::NormalClass, 'A'
+    @A_B_A.record_location @top_level_2
   end
 
   def teardown
@@ -145,11 +149,15 @@ class TestRDocGeneratorTags < MiniTest::Unit::TestCase
     assert_equal "!_TAG_PROGRAM_VERSION\t#{RDoc::Generator::Tags::VERSION}\n",
                  tags.next
 
-    assert_equal "A\tfile.rb\t/class A/;\"\tc\n",                tags.next
-    assert_equal "A::B\tfile.rb\t/class \\(A::\\)\\?B/;\"\tc\n", tags.next
-    assert_equal "B\tfile.rb\t/class \\(A::\\)\\?B/;\"\tc\n",    tags.next
+    assert_equal "A\tfile.rb\t/class A/;\"\tc\n",                  tags.next
+    assert_equal "A\tfile_2.rb\t/class \\(A::B::\\)\\?A/;\"\tc\n", tags.next
+    assert_equal "A::B\tfile.rb\t/class \\(A::\\)\\?B/;\"\tc\n",   tags.next
+    assert_equal "A::B::A\tfile_2.rb\t/class \\(A::B::\\)\\?A/;\"\tc\n",
+                 tags.next
+    assert_equal "B\tfile.rb\t/class \\(A::\\)\\?B/;\"\tc\n",      tags.next
 
-    assert_equal "CONST\tfile.rb\t/CONST\\s\\*=/;\"\td\tclass:Object\n", tags.next
+    assert_equal "CONST\tfile.rb\t/CONST\\s\\*=/;\"\td\tclass:Object\n",
+                 tags.next
 
     assert_equal "Object\tfile.rb\t/class Object/;\"\tc\n", tags.next
 

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc-tags
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 1
-  - 0
-  version: "1.0"
+  - 1
+  version: "1.1"
 platform: ruby
 authors: 
 - Eric Hodel
@@ -35,7 +35,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2010-12-23 00:00:00 -08:00
+date: 2010-12-29 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,10 +46,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 3
         segments: 
         - 3
-        version: "3"
+        - 2
+        version: "3.2"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -60,12 +61,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 11
         segments: 
         - 2
         - 0
-        - 0
-        version: 2.0.0
+        - 2
+        version: 2.0.2
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -102,6 +103,10 @@ description: |-
   A TAGS file generator based on http://ctags.sourceforge.net/FORMAT.  rdoc-tags
   handles namespaced classes and modules, ! and ? methods, constants and
   attributes better than Exuberant Ctags.
+  
+  rdoc-tags includes a Hoe plugin +:rdoc_tags+ making it easy to add tag support
+  to your ruby project.  If you don't use Hoe you can instead use RDoc::TagsTask
+  to add rake tasks for building TAGS to your ruby project.
 email: 
 - drbrain@segment7.net
 executables: []
@@ -118,8 +123,10 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
+- lib/hoe/rdoc_tags.rb
 - lib/rdoc/discover.rb
 - lib/rdoc/generator/tags.rb
+- lib/rdoc/tags_task.rb
 - test/test_rdoc_generator_tags.rb
 has_rdoc: true
 homepage: https://github.com/rdoc/rdoc-tags