rdoc-tags 1.3.pre → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: d302f42dceca0175405ab44866d7aac30a3368b8
-  data.tar.gz: 498704da8d37c899b33dcc62c3430e3f8bfac109
-!binary "U0hBNTEy":
-  metadata.gz: bc80283b168ad70d0dc1a72a8853aac859e97c8a0c825ec272360f6cb5266b25a40b93d161dc5e60b4f243618b1ff51c3a67f83c71a80600ed7989477314939d
-  data.tar.gz: 2dde955c834186b5e570a7f5ecea7bf845da62588b6e48225dbbb72db582bdca289df59e94508a30bc7ba0b0f5c4ef10a6b1fd0f065923f1acc8d0ae19452532
+SHA1:
+  metadata.gz: b637e967af2f123d9f8d8907f9a9e0dcb23c802a
+  data.tar.gz: 0dbbea9a16df2f18d940bb4f0761c8d8fcba9ed9
+SHA512:
+  metadata.gz: 48b458e225b7fcbb86374b1760c397a76c5a32c0c9febc303565917f6ea093a804d3f5175903b53a14a3d0033c121b96a0fd205709e45c1f5d1304136c79c029
+  data.tar.gz: 569aa48031bb322ba2adeee5d73793527d2a7ee7b4c69e0980385431fbd2df80601b21617186c2cf4ea1a70b4e5c7a8e3a24ccae937968b9a1805548d5e0d148

data/History.txt

@@ -1,8 +1,10 @@
-=== 1.3
+=== 1.3 / 2013-06-27
 
 * Minor enhancements
+  * rdoc-tags will now only re-parse files that have changed.
   * rdoc-tags now supports outputting emacs-style tags.  <tt>rdoc -f tags
     --tag-style=emacs .</tt> will write an emacs-style tags file.
+
 * Bug fixes
   * Set ctags_merge option correctly in option parser
   * Hoe task no longer removes TAGS on clean
@@ -17,7 +19,7 @@
 * 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.
+  * The tags generator no longer creates a created.rid file.
 
 === 1.1 / 2010-12-29
 

data/Rakefile

@@ -7,14 +7,13 @@ $:.unshift 'lib' # allow rdoc-tags to tag itself
 
 Hoe.plugin :git
 Hoe.plugin :minitest
-Hoe.plugin :rdoc_tags
-Hoe.plugins.delete :rubyforge
+Hoe.plugin :rdoc_tags unless ENV['TRAVIS']
+Hoe.plugin :travis
 
 Hoe.spec 'rdoc-tags' do
   developer 'Eric Hodel', 'drbrain@segment7.net'
 
-  extra_deps << ['rdoc', '>= 4.0.0.preview2', '< 5']
-  extra_dev_deps << ['ZenTest']
+  dependency 'rdoc', '~> 4'
 
   rdoc_locations <<
     'drbrain@rubyforge.org:/var/www/gforge-projects/rdoc/rdoc-tags'

data/lib/rdoc/generator/tags.rb

@@ -11,7 +11,7 @@ class RDoc::Generator::Tags
   ##
   # The version of the tags generator you are using
 
-  VERSION = '1.3.pre'
+  VERSION = '1.3'
 
   RDoc::RDoc.add_generator self
 
@@ -64,9 +64,10 @@ class RDoc::Generator::Tags
   # 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.force_output = !File.exist?('TAGS')
+    options.force_update = false
+    options.op_dir = File.expand_path './.rdoc'
+    options.update_output_dir = true
 
     options.extend Options
 
@@ -136,25 +137,27 @@ class RDoc::Generator::Tags
   end
 
   ##
-  # Generates a TAGS file from +top_levels+
+  # Generates a TAGS file
+
+  def generate
+    @store.save unless @dry_run
 
-  def generate top_levels
     case @tag_style
-    when :vim   then generate_vim top_levels
-    when :emacs then generate_emacs top_levels
+    when 'vim',   :vim   then generate_vim
+    when 'emacs', :emacs then generate_emacs
     else
-      raise RDoc::Error, "Unkown tag format #{@tag_style.inspect}"
+      raise RDoc::Error, "Unkown tag style #{@tag_style.inspect}"
     end
   end
 
   ##
-  # Generates a TAGS file from +top_levels+ for emacs
+  # Generates an emacs TAGS file
 
-  def generate_emacs top_levels
+  def generate_emacs
     # file_name => [definition, tag_name, line_number, byte_offset]
     tags = Hash.new { |h, file| h[file] = [] }
 
-    top_levels.each do |top_level|
+    @store.all_files.each do |top_level|
       tags[top_level.relative_name] << ['', top_level.relative_name, 0, 0]
     end
 
@@ -191,12 +194,12 @@ class RDoc::Generator::Tags
   end
 
   ##
-  # Generates a TAGS file from +top_levels+ for vim
+  # Generates a vim TAGS file
 
-  def generate_vim top_levels
+  def generate_vim
     tags = Hash.new { |h, name| h[name] = [] }
 
-    top_levels.each do |top_level|
+    @store.all_files.each do |top_level|
       tags[top_level.relative_name] << [top_level.relative_name, 0, 'F']
     end
 
@@ -275,14 +278,16 @@ class RDoc::Generator::Tags
       puts "#{ctags_path} #{ctags_args.join ' '}"
     end
 
-    system ctags_path, *ctags_args
+    Dir.chdir '..' do
+      system ctags_path, *ctags_args
+    end
   end
 
   ##
   # Writes the TAGS file in emacs style using the data in +tags+
 
   def write_tags_emacs tags
-    open 'TAGS', 'wb' do |io|
+    open '../TAGS', 'wb' do |io|
       tags.sort.each do |file, definitions|
         section = []
 
@@ -301,7 +306,7 @@ class RDoc::Generator::Tags
   # Writes the TAGS file in vim style using the data in +tags+
 
   def write_tags_vim tags
-    open 'TAGS', 'w' do |io|
+    open '../TAGS', 'w' do |io|
       io.write <<-INFO
 !_TAG_FILE_FORMAT\t2\t/extended format/
 !_TAG_FILE_SORTED\t1\t/sorted/
@@ -312,7 +317,13 @@ class RDoc::Generator::Tags
       INFO
 
       tags.sort.each do |name, definitions|
-        definitions.uniq.each do |(file, address, *field)|
+        definitions = definitions.uniq
+
+        definitions = definitions.sort_by do |(file, address,*_)|
+          [file, address]
+        end
+
+        definitions.each do |(file, address, *field)|
           io.write "#{name}\t#{file}\t#{address};\"\t#{field.join "\t"}\n"
         end
       end

data/lib/rdoc/tags_task.rb

@@ -62,7 +62,7 @@ class RDoc::TagsTask < Rake::TaskLib
   attr_accessor :tags_file
 
   ##
-  # Tag style to output.  Defaults to vim.
+  # Tag style to output.  Defaults to vim, emacs is also supported.
 
   attr_accessor :tag_style
 
@@ -77,8 +77,8 @@ class RDoc::TagsTask < Rake::TaskLib
     @retag_task   = names[:retag]   || 'retag'
     @tags_task    = names[:tags]    || 'tags'
 
-    @files     = Rake::FileList.new
-    @tags_dir  = '.'
+    @files     = Rake::FileList.new 'lib/**/*.rb'
+    @tags_dir  = './.rdoc'
     @tags_file = 'TAGS'
     @tag_style = 'vim'
 
@@ -141,7 +141,7 @@ class RDoc::TagsTask < Rake::TaskLib
 
     directory @tags_dir
 
-    file @tags_file => [@tags_dir, Rake.application.rakefile, @files] do
+    file @tags_file => [@tags_dir, Rake.application.rakefile, *@files] do
       build_tags
     end
 

data/test/test_rdoc_generator_tags.rb

@@ -15,11 +15,12 @@ class TestRDocGeneratorTags < MiniTest::Unit::TestCase
 
     @pwd = Dir.pwd
 
-    @tmpdir = File.join Dir.tmpdir, "test_rdoc_generator_tags_#{$$}"
+    @tmpdir = File.join Dir.tmpdir, "test_rdoc_generator_tags_#{$$}/.rdoc"
     FileUtils.mkdir_p @tmpdir
     Dir.chdir @tmpdir
 
     @store = RDoc::Store.new
+    @store.path = @tmpdir
     @g = RDoc::Generator::Tags.new @store, @options
 
     @top_level = @store.add_file 'file.rb'
@@ -79,21 +80,24 @@ class TestRDocGeneratorTags < MiniTest::Unit::TestCase
     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
+    assert options.update_output_dir
   end
 
   def test_find_ctags
-    assert_equal '/usr/local/bin/ctags', @g.find_ctags
+    skip 'no ctags on travis' if ENV['TRAVIS']
+
+    assert_match 'ctags', @g.find_ctags
   end
 
   def test_generate_emacs
     @g.tag_style = :emacs
 
-    @g.generate [@top_level]
+    @g.generate
 
-    tags_file = File.join @tmpdir, 'TAGS'
+    tags_file = File.join @tmpdir, '../TAGS'
 
     assert File.file? tags_file
+    assert File.file? File.join(@tmpdir, 'cache.ri')
 
     tags = open tags_file, 'rb' do |io| io.read end.each_line
 
@@ -125,11 +129,12 @@ class TestRDocGeneratorTags < MiniTest::Unit::TestCase
   def test_generate_vim
     @g.tag_style = :vim
 
-    @g.generate [@top_level]
+    @g.generate
 
-    tags_file = File.join @tmpdir, 'TAGS'
+    tags_file = File.join @tmpdir, '../TAGS'
 
     assert File.file? tags_file
+    assert File.file? File.join(@tmpdir, 'cache.ri')
 
     tags = File.read(tags_file).each_line
 
@@ -178,7 +183,7 @@ class TestRDocGeneratorTags < MiniTest::Unit::TestCase
     @options.dry_run = true
     @g = RDoc::Generator::Tags.new @store, @options
 
-    @g.generate [@top_level]
+    @g.generate
 
     refute File.exist? File.join(@tmpdir, 'TAGS')
   end

metadata

@@ -1,107 +1,79 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-tags
 version: !ruby/object:Gem::Version
-  version: 1.3.pre
+  version: '1.3'
 platform: ruby
 authors:
 - Eric Hodel
 autorequire: 
 bindir: bin
 cert_chain:
-- !binary |-
-  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURlRENDQW1DZ0F3SUJB
-  Z0lCQVRBTkJna3Foa2lHOXcwQkFRVUZBREJCTVJBd0RnWURWUVFEREFka2Nt
-  SnkKWVdsdU1SZ3dGZ1lLQ1pJbWlaUHlMR1FCR1JZSWMyVm5iV1Z1ZERjeEV6
-  QVJCZ29Ka2lhSmsvSXNaQUVaRmdOdQpaWFF3SGhjTk1USXdNakk0TVRjMU5E
-  STFXaGNOTVRNd01qSTNNVGMxTkRJMVdqQkJNUkF3RGdZRFZRUUREQWRrCmNt
-  SnlZV2x1TVJnd0ZnWUtDWkltaVpQeUxHUUJHUllJYzJWbmJXVnVkRGN4RXpB
-  UkJnb0praWFKay9Jc1pBRVoKRmdOdVpYUXdnZ0VpTUEwR0NTcUdTSWIzRFFF
-  QkFRVUFBNElCRHdBd2dnRUtBb0lCQVFDYmJnTHJHTEdJREU3NgpMVi9jdnhk
-  RXpDdVl1UzNvRzlQclNabnVEd2V5U1VmZHAvc28wY0RxK2o4YnF5Nk96WlN3
-  MDdnZGp3Rk1TZDZKClU1ZGRaQ1Z5d241bm5BUStVaTdqTVc1NENZdDUvSDZm
-  MlVTNlUwaFFPakpSNmNwZml5bWd4R2RmeVRpVmN2VG0KR2ovb2tXclFsME5q
-  WU9ZQnBEaSs5UFBtYUgyUm1MSnUwZEIvTnlsc0RuVzVqNnlOMUJFSThNZkpS
-  UitIUktaWQptVXRnekJ3RjFWNEtJWlE4RXVMNkkvbkhWdTA3aTZJa3JwQWd4
-  cFhVZmRKUUppMG9aQXFYdXJBVjN5VHhrRndkCmc2MllyclcyNm1EZStwWkJ6
-  UjZicExFK1BtWEN6ejdVeFVxM0FFMGdQSGJpTVhpZTNFRkUwb3huc1UzbElk
-  dWgKc0NBTmlROEJBZ01CQUFHamV6QjVNQWtHQTFVZEV3UUNNQUF3Q3dZRFZS
-  MFBCQVFEQWdTd01CMEdBMVVkRGdRVwpCQlM1azRaNzVWU3BkTTBBY2xHMlV2
-  ekZBL1ZXNURBZkJnTlZIUkVFR0RBV2dSUmtjbUp5WVdsdVFITmxaMjFsCmJu
-  UTNMbTVsZERBZkJnTlZIUklFR0RBV2dSUmtjbUp5WVdsdVFITmxaMjFsYm5R
-  M0xtNWxkREFOQmdrcWhraUcKOXcwQkFRVUZBQU9DQVFFQVBlV3pGbnJjdkM2
-  ZVZ6ZGxobWpVdWIyczZxaWVCa29uZ0tSREhRejVNRWVRdjRMUwpTQVJub0hZ
-  K3VDQVZMLzF4R0FobXB6cVEzZkpHV0s5ZUJhY1cvZThFNUdGOXhRY1YzbUUx
-  YkEwV05haURsWDVqClUyYUkrWkdTYmxxdkhVQ3hLQkhSMXM3VU1Ic2J6MXNh
-  T21nZFJUeVB4MGp1SnM2OG9jYlVUZVlCTFd1OVY0S1AKemRHQUcySlhPMmdP
-  TmczYjR0WUR2cEJMYnJ5K0tPWDI3aUFKdWxVYUg5VGlUT1VMTDRJVEpWRnNL
-  MG1ZVnFtUgpROFRubzlTM2U0WEdHUDFaV2ZMclRXRUpiYXZGZmhHSHV0MmlN
-  UndmQzdzL1lJTEFITkFUb3BhSmRIOUROcGQxClU4MXpHSE1VQk92ei9WR1Q2
-  d0p3WUozZW1TMm5mQTJOT0hGZmdBPT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUt
-  LS0tLQo=
-date: 2012-12-22 00:00:00.000000000 Z
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
+  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
+  ZXQwHhcNMTMwMjI4MDUyMjA4WhcNMTQwMjI4MDUyMjA4WjBBMRAwDgYDVQQDDAdk
+  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
+  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
+  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
+  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
+  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
+  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
+  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
+  sCANiQ8BAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DAfBgNVHREEGDAWgRRkcmJyYWluQHNlZ21l
+  bnQ3Lm5ldDAfBgNVHRIEGDAWgRRkcmJyYWluQHNlZ21lbnQ3Lm5ldDANBgkqhkiG
+  9w0BAQUFAAOCAQEAOflo4Md5aJF//EetzXIGZ2EI5PzKWX/mMpp7cxFyDcVPtTv0
+  js/6zWrWSbd60W9Kn4ch3nYiATFKhisgeYotDDz2/pb/x1ivJn4vEvs9kYKVvbF8
+  V7MV/O5HDW8Q0pA1SljI6GzcOgejtUMxZCyyyDdbUpyAMdt9UpqTZkZ5z1sicgQk
+  5o2XJ+OhceOIUVqVh1r6DNY5tLVaGJabtBmJAYFVznDcHiSFybGKBa5n25Egql1t
+  KDyY1VIazVgoC8XvR4h/95/iScPiuglzA+DBG1hip1xScAtw05BrXyUNrc9CEMYU
+  wgF94UVoHRp6ywo8I7NP3HcwFQDFNEZPNGXsng==
+  -----END CERTIFICATE-----
+date: 2013-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 4.0.0.preview2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0.preview2
-    - - "<"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.3'
-- !ruby/object:Gem::Dependency
-  name: ZenTest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.5'
 description: |-
   A TAGS file generator that builds both vim and emacs style tags files. Vim
   tags are based on http://ctags.sourceforge.net/FORMAT).  rdoc-tags is
@@ -119,7 +91,7 @@ extra_rdoc_files:
 - Manifest.txt
 - README.txt
 files:
-- ".autotest"
+- .autotest
 - History.txt
 - Manifest.txt
 - README.txt
@@ -129,29 +101,29 @@ files:
 - lib/rdoc/generator/tags.rb
 - lib/rdoc/tags_task.rb
 - test/test_rdoc_generator_tags.rb
-- ".gemtest"
+- .gemtest
 homepage: https://github.com/rdoc/rdoc-tags
 licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options:
-- "--main"
+- --main
 - README.txt
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: rdoc-tags
-rubygems_version: 2.0.0.preview2.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A TAGS file generator that builds both vim and emacs style tags files