gem-ripper-tags-optional 1.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40daf008565e59498df0a4aadc391c0a933f11f324b0dd6004cf5708f6462a36
+  data.tar.gz: 69d929c7f968d802bfe51ace4f95badb2e9aaa0fa52283865c169b5352214b96
+SHA512:
+  metadata.gz: a29f0cf9b1ab6a5ee44db79ebef6512e21fb0273774faa359167bfb132425da664d3fcc3395a557ee4bcba3ce5739fd7cf373b27a78868aebf67a2e29f71a8ca
+  data.tar.gz: 30a750cc5f95c863b17f04a38e9f9d6d2a8bc86f7fdbf74f7a3ce31adaa751a9c9e499516b4559163402cd7e59600bc32aff0047a05a0eaf2ec996bed3c2c902

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,111 @@
+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/RobertAudi/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_tags
+
+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.
+
+You can use the gem even with 1.8 gemsets, but since Ruby 1.8 is not
+supported, it will (silently) not register the gem hook.
+
+### Skip tags generation
+
+Set the `SKIP_RIPPER_TAGS` environment variable to skip tags generation:
+
+    SKIP_RIPPER_TAGS=1 gem instal some_gem ...
+
+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.
+
+Regeneration
+------------
+
+If you want to regenerate all tagfiles from scratch, use:
+
+    gem ripper_tags --reindex
+
+Emacs support
+-------------
+
+To support Emacs, you need two steps. First, reindex everything with Emacs
+enabled:
+
+    gem ripper_tags --reindex --emacs
+
+And make sure this environment variable is set to all shells where you use
+"gem install" command so new gems are generated with Emacs TAGS files.
+
+    RIPPER_TAGS_EMACS=1
+
+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-optional.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "gem-ripper-tags-optional"
+  s.version     = `git describe --abbrev=0 --tags`
+  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.license     = 'MIT'
+
+  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', '>= 0.1.2'
+  s.add_development_dependency 'rake'
+end

data/lib/rubygems/commands/ripper_tags_command.rb

@@ -0,0 +1,69 @@
+require 'rubygems/command'
+require 'ripper-tags'
+
+class Gem::Commands::RipperTagsCommand < Gem::Command
+  def initialize
+    super 'ripper_tags', 'Generate ctags for gems with Ruby/Ripper parser'
+
+    add_option("--emacs", "Generate Emacs TAGS instead Vim tags") do |value, options|
+      options[:emacs] = true
+    end
+    add_option("--reindex", "Reindex all tags again") do |value, options|
+      options[:reindex] = true
+    end
+    add_option("--debug", "Enable debugging output") do |value, options|
+      options[:debug] = true
+    end
+  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, options[:reindex], options[:emacs]) do |message|
+        say message
+      end
+    end
+  rescue Exception => e
+    if options[:debug] || ENV['RIPPER_TAGS_DEBUG']
+      puts e.message
+      puts e.backtrace.join("\n")
+    end
+    raise e
+  end
+
+  def self.index(spec, reindex, emacs)
+    return unless File.directory?(spec.full_gem_path)
+
+    if emacs
+      tag_filename = 'TAGS'
+      format = "emacs"
+    else
+      tag_filename = 'tags'
+      format = "vim"
+    end
+
+    Dir.chdir(spec.full_gem_path) do
+      if (!File.directory?(tag_filename) && reindex) || (!File.file?(tag_filename) && !File.directory?(tag_filename))
+        yield "Ripper is generating ctags for #{spec.full_name}" if block_given?
+        riopt = RipperTags.default_options
+        riopt.tag_file_name = "./#{tag_filename}"
+        riopt.format = format
+        riopt.recursive = true
+        riopt.force = true
+        RipperTags.run riopt
+      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,16 @@
+require 'rubygems/command_manager'
+begin
+  require 'rubygems/commands/ripper_tags_command'
+rescue LoadError => e
+  old_ruby = true
+end
+
+unless old_ruby
+  Gem::CommandManager.instance.register_command :ripper_tags
+
+  Gem.post_install do |installer|
+    unless ENV['SKIP_RIPPER_TAGS']
+      Gem::Commands::RipperTagsCommand.index(installer.spec, false, !ENV['RIPPER_TAGS_EMACS'].nil?)
+    end
+  end
+end

data/release.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+#
+# Before running this make sure you tagged and pushed!
+#
+
+VERSION=$(git describe --abbrev=0 --tags)
+
+git checkout $VERSION && \
+  gem build gem-ripper-tags-optional.gemspec && \
+  gem push gem-ripper-tags-optional-$VERSION.gem
+
+git checkout master

data/test.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+rm gem-ripper-tags-optinal*.gem
+
+gem build gem-ripper-tags-optional.gemspec \
+  && gem uninstall gem-ripper-tags-optional \
+  && gem install gem-ripper-tags-optional-*.gem \
+  && gem ripper-tags --debug

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: gem-ripper-tags-optional
+version: !ruby/object:Gem::Version
+  version: 1.0.7
+platform: ruby
+authors:
+- Tim Pope
+- Lukas Zapletal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ripper-tags
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    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-optional.gemspec
+- lib/rubygems/commands/ripper_tags_command.rb
+- lib/rubygems_plugin.rb
+- release.sh
+- test.sh
+homepage: https://github.com/lzap/gem-ripper-tags
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: fast and accurate ctags generator on gem install
+test_files: []