rdoc-tags 1.0

data/.autotest

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = 'minitest/autorun'
+end
+

data/History.txt

@@ -0,0 +1,5 @@
+=== 1.0 / 2010-12-23
+
+* 1 major enhancement
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/rdoc/discover.rb
+lib/rdoc/generator/tags.rb
+test/test_rdoc_generator_tags.rb

data/README.txt

@@ -0,0 +1,52 @@
+= rdoc_tags
+
+* https://github.com/rdoc/rdoc-tags
+
+== 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.
+
+== FEATURES/PROBLEMS:
+
+* Much slower that Exuberant Ctags
+* Only outputs vim-format tags
+* Only works for ruby files, not Ruby/C files
+
+== SYNOPSIS:
+
+  rdoc -f tags lib
+
+== REQUIREMENTS:
+
+* RDoc 3+
+
+== INSTALL:
+
+* gem install rdoc-tags
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Eric Hodel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

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

data/lib/rdoc/discover.rb

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

data/lib/rdoc/generator/tags.rb

@@ -0,0 +1,144 @@
+require 'rdoc/rdoc'
+require 'rdoc/generator'
+
+##
+# A TAGS file generator based on http://ctags.sourceforge.net/FORMAT
+
+class RDoc::Generator::Tags
+
+  ##
+  # The version of the tags generator you are using
+
+  VERSION = '1.0'
+
+  RDoc::RDoc.add_generator self
+
+  ##
+  # Extra Tags options to be added to RDoc::Options
+
+  module Options
+
+    ##
+    # Valid tag styles
+
+    TAG_STYLES = [:vim]
+
+    ##
+    # Which tag style shall we output?
+
+    attr_accessor :tag_style
+
+  end
+
+  ##
+  # Adds tags-generator options to the RDoc::Options instance +options+
+
+  def self.setup_options options
+    options.force_output = true
+    options.op_dir = '.'
+
+    options.extend Options
+
+    options.tag_style = :vim
+
+    op = options.option_parser
+
+    op.separator nil
+    op.separator 'tags generator options:'
+    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
+    end
+
+    op.separator nil
+  end
+
+  ##
+  # Creates a new tags generator
+
+  def initialize options
+    @options = options
+    @dry_run = options.dry_run
+    @tags = {}
+  end
+
+  ##
+  # Generates a TAGS file from +top_levels+
+
+  def generate top_levels
+    top_levels.each do |top_level|
+      @tags[top_level.relative_name] = [top_level.relative_name, 0, 'F']
+    end
+
+    RDoc::TopLevel.all_classes_and_modules.each do |klass|
+      kind = "class:#{klass.full_name}"
+
+      address =
+        unless RDoc::TopLevel === klass.parent then
+          "/#{klass.type} \\(#{klass.parent.full_name}::\\)\\?#{klass.name}/"
+        else
+          "/#{klass.type} #{klass.full_name}/"
+        end
+
+      klass.in_files.each do |file|
+        @tags[klass.full_name] = [file.relative_name, address, 'c']
+        @tags[klass.name]      = [file.relative_name, address, 'c']
+      end
+
+      klass.each_attribute do |attr|
+        where = [
+          attr.file.relative_name,
+          "/attr\\w\\*\\s\\*\\[:'\"]#{attr.name}/",
+          'f',
+          kind
+        ]
+        
+        @tags[attr.name]       = where
+        @tags["#{attr.name}="] = where
+      end
+
+      klass.each_constant do |constant|
+        @tags[constant.name] = [
+          constant.file.relative_name, "/#{constant.name}\\s\\*=/", 'd', kind]
+      end
+
+      klass.each_method do |method|
+        address = if method.singleton then
+                    # \w doesn't appear to work in [] with nomagic
+                    "/def \\[A-Za-z0-9_:]\\+.#{method.name}/"
+                  else
+                    "/def #{method.name}/"
+                  end
+
+        @tags[method.name] = [
+          method.file.relative_name, address, 'f', kind]
+      end
+    end
+
+    write_tags unless @dry_run
+  end
+
+  ##
+  # Writes the TAGS file
+
+  def write_tags
+    open 'TAGS', 'w' do |io|
+      io.write <<-INFO
+!_TAG_FILE_FORMAT\t2
+!_TAG_FILE_SORTED\t1
+!_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}
+      INFO
+
+      @tags.sort.each do |name, (file, address, *field)|
+        io.write "#{name}\t#{file}\t#{address};\"\t#{field.join "\t"}\n"
+      end
+    end
+  end
+
+end
+

data/test/test_rdoc_generator_tags.rb

@@ -0,0 +1,184 @@
+require 'rubygems'
+gem 'rdoc', '~> 3'
+
+require 'minitest/autorun'
+require 'rdoc/rdoc'
+require 'rdoc/generator/tags'
+require 'tmpdir'
+require 'fileutils'
+
+class TestRDocGeneratorTags < MiniTest::Unit::TestCase
+
+  def setup
+    @options = RDoc::Options.new
+    @options.extend RDoc::Generator::Tags::Options
+
+    @pwd = Dir.pwd
+    RDoc::TopLevel.reset
+
+    @tmpdir = File.join Dir.tmpdir, "test_rdoc_generator_tags_#{$$}"
+    FileUtils.mkdir_p @tmpdir
+    Dir.chdir @tmpdir
+
+    @g = RDoc::Generator::Tags.new @options
+
+    @top_level = RDoc::TopLevel.new 'file.rb'
+
+    @klass = @top_level.add_class RDoc::NormalClass, 'Object'
+    @klass.record_location @top_level
+
+    @A = @top_level.add_class RDoc::NormalClass, 'A'
+    @A.record_location @top_level
+
+    @B = @A.add_class RDoc::NormalClass, 'B'
+    @B.record_location @top_level
+
+    @meth = RDoc::AnyMethod.new nil, 'method'
+    @meth.record_location @top_level
+
+    @meth_bang = RDoc::AnyMethod.new nil, 'method!'
+    @meth_bang.record_location @top_level
+
+    @attr = RDoc::Attr.new nil, 'attr', 'RW', ''
+    @attr.record_location @top_level
+
+    @smeth = RDoc::AnyMethod.new nil, 's_method'
+    @smeth.singleton = true
+    @smeth.record_location @top_level
+
+    @const = RDoc::Constant.new 'CONST', '', ''
+    @const.record_location @top_level
+
+    @klass.add_method @meth
+    @klass.add_method @smeth
+    @klass.add_method @meth_bang
+    @klass.add_attribute @attr
+    @klass.add_constant @const
+  end
+
+  def teardown
+    Dir.chdir @pwd
+    FileUtils.rm_rf @tmpdir
+  end
+
+  def test_class_setup_options
+    options = RDoc::Options.new
+
+    op = OptionParser.new
+
+    options.option_parser = op
+
+    RDoc::Generator::Tags.setup_options options
+
+    assert_equal :vim, options.tag_style
+
+    assert_includes op.top.long, 'tag-style'
+  end
+
+  def test_generate_emacs
+    skip "test incomplete"
+
+    @options.tag_style = :emacs
+
+    @g.generate [@top_level]
+
+    tags_file = File.join @tmpdir, 'TAGS'
+
+    assert File.file? tags_file
+
+    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_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\thttp://rdoc.rubyforge.org/rdoc-tags\n",
+                 tags.next
+    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 "CONST\tfile.rb\t/CONST\\s\\*=/;\"\td\tclass:Object\n", tags.next
+
+    assert_equal "Object\tfile.rb\t/class Object/;\"\tc\n", tags.next
+
+    assert_equal "attr\tfile.rb\t/attr\\w\\*\\s\\*\\[:'\"]attr/;\"\tf\tclass:Object\n",
+                 tags.next
+    assert_equal "attr=\tfile.rb\t/attr\\w\\*\\s\\*\\[:'\"]attr/;\"\tf\tclass:Object\n",
+                 tags.next
+
+    assert_equal "file.rb\tfile.rb\t0;\"\tF\n", tags.next
+
+    assert_equal "method\tfile.rb\t/def method/;\"\tf\tclass:Object\n",
+                 tags.next
+    assert_equal "method!\tfile.rb\t/def method!/;\"\tf\tclass:Object\n",
+                 tags.next
+
+    assert_equal "s_method\tfile.rb\t/def \\[A-Za-z0-9_:]\\+.s_method/;\"\tf\tclass:Object\n",
+                 tags.next
+
+    assert_raises StopIteration do line = tags.next; flunk line end
+  end
+
+  def test_generate_vim
+    @options.tag_style = :vim
+
+    @g.generate [@top_level]
+
+    tags_file = File.join @tmpdir, 'TAGS'
+
+    assert File.file? tags_file
+
+    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_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",
+                 tags.next
+    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 "CONST\tfile.rb\t/CONST\\s\\*=/;\"\td\tclass:Object\n", tags.next
+
+    assert_equal "Object\tfile.rb\t/class Object/;\"\tc\n", tags.next
+
+    assert_equal "attr\tfile.rb\t/attr\\w\\*\\s\\*\\[:'\"]attr/;\"\tf\tclass:Object\n",
+                 tags.next
+    assert_equal "attr=\tfile.rb\t/attr\\w\\*\\s\\*\\[:'\"]attr/;\"\tf\tclass:Object\n",
+                 tags.next
+
+    assert_equal "file.rb\tfile.rb\t0;\"\tF\n", tags.next
+
+    assert_equal "method\tfile.rb\t/def method/;\"\tf\tclass:Object\n",
+                 tags.next
+    assert_equal "method!\tfile.rb\t/def method!/;\"\tf\tclass:Object\n",
+                 tags.next
+
+    assert_equal "s_method\tfile.rb\t/def \\[A-Za-z0-9_:]\\+.s_method/;\"\tf\tclass:Object\n",
+                 tags.next
+
+    assert_raises StopIteration do line = tags.next; flunk line end
+  end
+
+  def test_generate_dry_run
+    @options.dry_run = true
+    @g = RDoc::Generator::Tags.new @options
+
+    @g.generate [@top_level]
+
+    refute File.exist? File.join(@tmpdir, 'TAGS')
+  end
+
+end
+

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification 
+name: rdoc-tags
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Eric Hodel
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
+  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
+  ZXQwHhcNMDcxMjIxMDIwNDE0WhcNMDgxMjIwMDIwNDE0WjBBMRAwDgYDVQQDDAdk
+  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
+  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
+  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
+  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
+  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
+  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
+  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
+  sCANiQ8BAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DANBgkqhkiG9w0BAQUFAAOCAQEAHagT4lfX
+  kP/hDaiwGct7XPuVGbrOsKRVD59FF5kETBxEc9UQ1clKWngf8JoVuEoKD774dW19
+  bU0GOVWO+J6FMmT/Cp7nuFJ79egMf/gy4gfUfQMuvfcr6DvZUPIs9P/TlK59iMYF
+  DIOQ3DxdF3rMzztNUCizN4taVscEsjCcgW6WkUJnGdqlu3OHWpQxZBJkBTjPCoc6
+  UW6on70SFPmAy/5Cq0OJNGEWBfgD9q7rrs/X8GGwUWqXb85RXnUVi/P8Up75E0ag
+  14jEc90kN+C7oI/AGCBN0j6JnEtYIEJZibjjDJTSMWlUKKkj30kq7hlUC2CepJ4v
+  x52qPcexcYZR7w==
+  -----END CERTIFICATE-----
+
+date: 2010-12-23 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        version: "3"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: isolate
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        version: "3"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 7
+        - 0
+        version: 2.7.0
+  type: :development
+  version_requirements: *id004
+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.
+email: 
+- drbrain@segment7.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/rdoc/discover.rb
+- lib/rdoc/generator/tags.rb
+- test/test_rdoc_generator_tags.rb
+has_rdoc: true
+homepage: https://github.com/rdoc/rdoc-tags
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rdoc-tags
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A TAGS file generator based on http://ctags.sourceforge.net/FORMAT
+test_files: 
+- test/test_rdoc_generator_tags.rb