gem-ripper-tags 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+gemspec
+
+gem 'ripper-tags'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Tim Pope
+
+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/README.markdown

@@ -0,0 +1,82 @@
+RubyGems Automatic Ctags Generator
+==================================
+
+If you do like Vim and Ctags like I or [Tim Pope][] do, you maybe appreciate
+automatic generation of ctags for each installed gem. This small project is
+based on Tim's [gem-ctags][], but the main difference is it does *not* use
+[Exuberant Ctags][].
+
+Upstream site is at: https://github.com/lzap/gem-ripper-tags
+
+Usage
+-----
+
+Install the thing (only Ruby 1.9+):
+
+    gem install gem-ripper-tags
+
+Then generate tags for all already installed gems:
+
+    gem ripper
+
+Anytime you install a gem now, tags will be automatically created.
+
+    gem instal some_gem ...
+
+If you're using RVM, I recommend extending your global gemset by adding
+`gem-ripper-tags` to `~/.rvm/gemsets/global.gems`.  Put it at the top so the
+gems below it will be indexed.
+
+Motivation
+----------
+
+Why would you care about not using ctags in the first place? Ctags is a great
+project and it does support many (like 50) languages. But Ruby support is very
+weak, the parser is not in good condition and it has not been changed 4 years
+now.
+
+ * Ctags doesn't deal with: module A::B
+ * Ctags doesn't tag (at least some of) the operator methods like ==
+ * Ctags doesn't support qualified tags, -type=+
+ * Ctags doesn't output tags for constants or attributes.
+
+Unfortunately all the others (I found 2) Ruby ctags generators are either
+outdated (no Ruby 1.9+ support) or very slow. This project makes use of
+[ripper-tags][] that leverages built-in Ruby parser API called Ripper. It is
+fast and it works as expected.
+
+Vim Tips
+--------
+
+To easily edit a gem with your current working directory set to the
+gem's root, install [gem-browse][].
+
+If you have [rake.vim][] installed (which, by the way, is a misleading
+name), Vim will already know where to look for the tags file when
+editing a gem.
+
+If you have [bundler.vim][] installed, Vim will be aware of all tags
+files from all gems in your bundle.
+
+If you want to get crazy, add this to your vimrc to get Vim to search
+all gems in your current RVM gemset (requires [pathogen.vim][]):
+
+    autocmd FileType ruby let &l:tags = pathogen#legacyjoin(pathogen#uniq(
+          \ pathogen#split(&tags) +
+          \ map(split($GEM_PATH,':'),'v:val."/gems/*/tags"')))
+
+Tim Pope doesn't like to get crazy. ;-)
+
+License
+-------
+
+Copyright (c) Tim Pope; Lukáš Zapletal. MIT License.
+
+[Tim Pope]: http://tpo.pe/
+[Exuberant Ctags]: http://ctags.sourceforge.net/
+[gem-ctags]: https://github.com/tpope/gem-ctags
+[gem-browse]: https://github.com/tpope/gem-browse
+[bundler.vim]: https://github.com/tpope/vim-bundler
+[pathogen.vim]: https://github.com/tpope/vim-pathogen
+[rake.vim]: https://github.com/tpope/vim-rake
+[ripper-tags]: https://github.com/tmm1/ripper-tags

data/Rakefile

@@ -0,0 +1,11 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib')).uniq!
+
+begin
+  require "bundler/gem_tasks"
+rescue LoadError
+end
+
+task :default do
+  require 'rubygems/commands/ripper_tags_command'
+  Gem::Commands::RipperTagsCommand.new.execute
+end

data/gem-ripper-tags.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "gem-ripper-tags"
+  s.version     = "1.0.0"
+  s.authors     = ["Tim Pope", "Lukas Zapletal"]
+  s.email       = ["code@tpop"+'e.net', "lzap+rpm@red"+'hat.com']
+  s.homepage    = "https://github.com/lzap/gem-ripper-tags"
+  s.summary     = %q{fast and accurate ctags generator on gem install}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'ripper-tags'
+  s.add_development_dependency 'rake'
+end

data/lib/rubygems/commands/ripper_tags_command.rb

@@ -0,0 +1,87 @@
+require 'rubygems/command'
+require 'tag_ripper'
+
+class Gem::Commands::RipperTagsCommand < Gem::Command
+  def initialize
+    super 'ripper', 'Generate ctags for gems with Ruby/Ripper parser'
+  end
+
+  def execute
+    if Gem::Specification.respond_to?(:each)
+      Gem::Specification
+    else
+      Gem.source_index.gems.values
+    end.each do |spec|
+      self.class.index(spec) do |message|
+        say message
+      end
+    end
+  end
+
+  def self.ctags(paths)
+    # this bit is taken from ripper-tags/bin
+    all_tags = []
+    paths.each do |file|
+      begin
+        if File.directory?(file)
+          Dir.foreach(file){ |f| paths << File.expand_path(File.join(file, f)) if f !~ /^\.\.?/ }
+          next
+        else
+          next if file !~ /\.rb$/
+          data = File.read(file)
+        end
+        sexp = TagRipper.new(data, file).parse
+        v = TagRipper::Visitor.new(sexp, file, data)
+        all_tags += v.tags
+      rescue Exception => e
+        #STDERR.puts "Skipping invalid file #{file}"
+      end
+    end
+
+    File.open('tags', 'w') do |file|
+      file.puts <<-EOC
+!_TAG_FILE_FORMAT\t2\t/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED\t1\t/0=unsorted, 1=sorted, 2=foldcase/
+      EOC
+
+      all_tags.sort_by!{ |t| t[:name] }
+      all_tags.each do |tag|
+        kwargs = ''
+        kwargs << "\tclass:#{tag[:class].gsub('::','.')}" if tag[:class]
+        kwargs << "\tinherits:#{tag[:inherits].gsub('::','.')}" if tag[:inherits]
+
+        kind = case tag[:kind]
+               when 'method' then 'f'
+               when 'singleton method' then 'F'
+               when 'constant' then 'C'
+               else tag[:kind].slice(0,1)
+               end
+
+        code = tag[:pattern].gsub('\\','\\\\\\\\').gsub('/','\\/')
+        file.puts "%s\t%s\t/^%s$/;\"\t%c%s" % [tag[:name], tag[:path], code, kind, kwargs]
+      end
+    end
+  end
+
+  def self.index(spec)
+    return unless File.directory?(spec.full_gem_path)
+
+    Dir.chdir(spec.full_gem_path) do
+
+      #if !(File.file?('tags') && File.read('tags', 1) == '!') && !File.directory?('tags')
+      if !File.directory?('tags')
+        yield "Generating ctags for #{spec.full_name}" if block_given?
+        ctags(spec.require_paths.select { |p| File.directory?(p) })
+      end
+
+      target = 'lib/bundler/cli.rb'
+      if File.writable?(target) && !File.read(target).include?('load_plugins')
+        yield "Injecting gem-ripper-tags into #{spec.full_name}" if block_given?
+        File.open(target, 'a') do |f|
+          f.write "\nGem.load_plugins rescue nil\n"
+        end
+      end
+
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,8 @@
+require 'rubygems/command_manager'
+require 'rubygems/commands/ripper_tags_command'
+
+Gem::CommandManager.instance.register_command :ripper
+
+Gem.post_install do |installer|
+  Gem::Commands::RipperTagsCommand.index(installer.spec)
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: gem-ripper-tags
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tim Pope
+- Lukas Zapletal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ripper-tags
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- code@tpope.net
+- lzap+rpm@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- gem-ripper-tags.gemspec
+- lib/rubygems/commands/ripper_tags_command.rb
+- lib/rubygems_plugin.rb
+homepage: https://github.com/lzap/gem-ripper-tags
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: fast and accurate ctags generator on gem install
+test_files: []
+has_rdoc: