bundler-gtags 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f118fee6d5a7c86a2d16a2ca66b7c987be063b1b
+  data.tar.gz: 7a941d12a04864478c183e0391c7d48b8bce226c
+SHA512:
+  metadata.gz: 54ca261904470ff4c43da646ddf83d0a887bd1024ffd351839a71cdad8f27f4d5d497428bfcda41df570a77e0a1366fbf73634ced850198df4b95fec5f180aec
+  data.tar.gz: 3777b79e17582748a961c328ab1722e6bb171726e5024dfaae03387f8d0d8f3d1f5bab0e2eaedde85d3100d757332925856aa6ff920bc5ae2f62bb562aa573bd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kayhide@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bundler-gtags.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 kayhide
+
+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.md

@@ -0,0 +1,102 @@
+# Bundler::Gtags
+
+GNU Global (gtags) utility.
+
+`bundler-gtags` command creates gtags for all bundled gems.
+And also manages direnv settings exporting GTAGSLIBPATH so that editors can tag-jump
+directly to any gems source code from the bundler application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bundler-gtags'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bundler-gtags
+
+## Usage
+
+To use tag-jump functionality to the utmost extent,
+3 things are needed before go to your project.
+
+**First**, [GNU Global](https://www.gnu.org/software/global/) is required.
+
+Pymgments option is recommended.
+
+On OSX:
+
+    $ install global --with-ctags --with-pygments
+
+**Next**, `direnv` command is required.
+
+Go and follow the install instruction of
+[direnv](https://github.com/direnv/direnv).
+
+**And lastly**, your editor would need some setting.
+
+On Emacs, `projectile-direnv` package works nicely.
+
+```lisp
+(use-package projectile-direnv
+  :commands (projectile-direnv-export-variables)
+  :init
+  (add-hook 'projectile-mode-hook 'projectile-direnv-export-variables)
+  )
+```
+
+
+Now, you are ready to generate gtags for your project's gems.
+
+Go to your project root dir (there must be a Gemfile), and hit:
+
+    $ bundler-gtags
+
+After some time, GTAGS files are created at the every gem root dir.
+
+And also `.envrc` file, which is direnv settings file, is to be at your project root dir.
+
+If you are already using direnv and having `.envrc` file,
+`bundler-gtags` command will just append a line to the end of the existing one.
+
+Note that `.envrc` should be excluded from git management, because it includes some system specific settings.
+Putting it into the user-local `.gitignore` might be a good idea.
+To do so:
+
+    $ git config --global core.excludesfile ~/.gitignore
+    $ echo .envrc >> ~/.gitignore
+
+
+Thats it.
+Finally, you are ready to jump around the codes of gems.
+Enjoy code reading :)
+
+## Thanks
+
+Original idea came from here.
+[Emacs での Rails 開発を GNU GLOBAL でだいぶ快適にする](http://qiita.com/5t111111/items/5e854f6047d187ea21c7)
+
+Thanks for @5t111111
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec bundler-gtags` to use the gem in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kayhide/bundler-gtags. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bundler-gtags"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bundler-gtags.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bundler-gtags/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bundler-gtags'
+  spec.version       = Bundler::Gtags::VERSION
+  spec.authors       = ['kayhide']
+  spec.email         = ['kayhide@gmail.com']
+
+  spec.summary       = 'GNU Global (gtags) utility.'
+  spec.description   = 'GNU Global (gtags) utility. Create gtags for all bundled gems and manage direnv settings exporting GTAGSLIBPATH.'
+  spec.homepage      = 'https://github.com/kayhide/bundler-gtags'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'bundler', '~> 1.11'
+  spec.add_runtime_dependency 'colored'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+end

data/exe/bundler-gtags

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "bundler-gtags"
+
+Bundler::Gtags::CLI.start(ARGV, debug: true)

data/lib/bundler-gtags.rb

@@ -0,0 +1,4 @@
+require 'bundler'
+
+require 'bundler-gtags/version'
+require 'bundler-gtags/cli'

data/lib/bundler-gtags/cli.rb

@@ -0,0 +1,25 @@
+require 'bundler'
+require 'thor'
+
+require 'bundler-gtags'
+require 'bundler-gtags/utils'
+
+module Bundler::Gtags
+  class CLI < Thor
+    include Thor::Actions
+
+    default_task :gtags
+
+    desc 'gtags', 'Create gtags and manage direnv settings'
+    method_option :gtagslabel, type: :string, default: 'pygments'
+    long_desc <<-D
+      Creates GNU Global (gtags) for all bundled gems. And also manages direnv
+      settings for current project exporting GTAGSLIBPATH with project path and
+      all gem paths.
+    D
+    def gtags(*args)
+      require 'bundler-gtags/cli/gtags'
+      Gtags.new(options, args).run
+    end
+  end
+end

data/lib/bundler-gtags/cli/gtags.rb

@@ -0,0 +1,95 @@
+require 'colored'
+
+module Bundler::Gtags
+  class CLI::Gtags
+    attr_reader :options, :args
+
+    def initialize(options, args)
+      @options = options
+      @cmd = args.shift
+      @args = args
+    end
+
+    def run
+      generate_gtags
+      update_envrc
+    end
+
+    def gtagslabel
+      @options[:gtagslabel]
+    end
+
+    def gem_dirs
+      @gem_dirs ||=
+        `bundle show --paths`.lines.map(&:chomp).
+        select { |dir| Dir.exist? dir }
+    end
+
+    def envrc
+      '.envrc'
+    end
+
+    private
+
+    def generate_gtags
+      gem_dirs.select { |dir| Dir.exist? dir }.each do |dir|
+        Dir.chdir dir do
+          if File.exist? File.join(dir, 'GTAGS')
+            say 'exist', File.basename(dir), :yellow
+          else
+            say 'gtags', File.basename(dir), :green
+            `gtags --gtagslabel=#{gtagslabel}`
+          end
+        end
+      end
+    end
+
+    def update_envrc
+      original =
+        if File.exist? envrc
+          open(envrc) { |f| f.read }
+        end
+
+      paths = [Dir.pwd, *gem_dirs]
+      new_line = "export GTAGSLIBPATH=#{paths.join(':')}\n"
+
+      updated =
+        if original
+          replaced = false
+          original.lines.inject([]) do |res, line|
+            if line =~ /^export GTAGSLIBPATH=/
+              if replaced
+                res
+              else
+                replaced = true
+                res << new_line
+              end
+            else
+              res << line
+            end
+          end.join
+        end
+
+      if updated && !updated.include?(new_line)
+        updated << "\n" if updated[-1] != "\n"
+        updated << new_line
+      end
+
+      updated ||= new_line
+
+      if original == updated
+        say 'identical', '.envrc', :blue
+      else
+        open(envrc, 'w') do |f|
+          if original
+            say 'update', '.envrc', :magenta
+          else
+            say 'create', '.envrc', :green
+          end
+          f << updated
+        end
+        `direnv allow`
+      end
+    end
+  end
+end

data/lib/bundler-gtags/utils.rb

@@ -0,0 +1,14 @@
+require 'colored'
+
+module Bundler::Gtags
+  module Utils
+    def say status, message, color
+      puts [
+        Colored.colorize('%12s' % status, foreground: color),
+        message
+      ].join(' ')
+    end
+  end
+end
+
+Object.include Bundler::Gtags::Utils

data/lib/bundler-gtags/version.rb

@@ -0,0 +1,5 @@
+module Bundler
+  module Gtags
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: bundler-gtags
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kayhide
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: GNU Global (gtags) utility. Create gtags for all bundled gems and manage
+  direnv settings exporting GTAGSLIBPATH.
+email:
+- kayhide@gmail.com
+executables:
+- bundler-gtags
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bundler-gtags.gemspec
+- exe/bundler-gtags
+- lib/bundler-gtags.rb
+- lib/bundler-gtags/cli.rb
+- lib/bundler-gtags/cli/gtags.rb
+- lib/bundler-gtags/utils.rb
+- lib/bundler-gtags/version.rb
+homepage: https://github.com/kayhide/bundler-gtags
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: GNU Global (gtags) utility.
+test_files: []
+has_rdoc: