bundler-gtags 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rspec +2 -0
- data/.travis.yml +4 -0
- data/CODE_OF_CONDUCT.md +49 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +102 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/bundler-gtags.gemspec +26 -0
- data/exe/bundler-gtags +5 -0
- data/lib/bundler-gtags.rb +4 -0
- data/lib/bundler-gtags/cli.rb +25 -0
- data/lib/bundler-gtags/cli/gtags.rb +95 -0
- data/lib/bundler-gtags/utils.rb +14 -0
- data/lib/bundler-gtags/version.rb +5 -0
- metadata +134 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: f118fee6d5a7c86a2d16a2ca66b7c987be063b1b
|
4
|
+
data.tar.gz: 7a941d12a04864478c183e0391c7d48b8bce226c
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 54ca261904470ff4c43da646ddf83d0a887bd1024ffd351839a71cdad8f27f4d5d497428bfcda41df570a77e0a1366fbf73634ced850198df4b95fec5f180aec
|
7
|
+
data.tar.gz: 3777b79e17582748a961c328ab1722e6bb171726e5024dfaae03387f8d0d8f3d1f5bab0e2eaedde85d3100d757332925856aa6ff920bc5ae2f62bb562aa573bd
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
# Contributor Code of Conduct
|
2
|
+
|
3
|
+
As contributors and maintainers of this project, and in the interest of
|
4
|
+
fostering an open and welcoming community, we pledge to respect all people who
|
5
|
+
contribute through reporting issues, posting feature requests, updating
|
6
|
+
documentation, submitting pull requests or patches, and other activities.
|
7
|
+
|
8
|
+
We are committed to making participation in this project a harassment-free
|
9
|
+
experience for everyone, regardless of level of experience, gender, gender
|
10
|
+
identity and expression, sexual orientation, disability, personal appearance,
|
11
|
+
body size, race, ethnicity, age, religion, or nationality.
|
12
|
+
|
13
|
+
Examples of unacceptable behavior by participants include:
|
14
|
+
|
15
|
+
* The use of sexualized language or imagery
|
16
|
+
* Personal attacks
|
17
|
+
* Trolling or insulting/derogatory comments
|
18
|
+
* Public or private harassment
|
19
|
+
* Publishing other's private information, such as physical or electronic
|
20
|
+
addresses, without explicit permission
|
21
|
+
* Other unethical or unprofessional conduct
|
22
|
+
|
23
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
24
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
25
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
26
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
27
|
+
threatening, offensive, or harmful.
|
28
|
+
|
29
|
+
By adopting this Code of Conduct, project maintainers commit themselves to
|
30
|
+
fairly and consistently applying these principles to every aspect of managing
|
31
|
+
this project. Project maintainers who do not follow or enforce the Code of
|
32
|
+
Conduct may be permanently removed from the project team.
|
33
|
+
|
34
|
+
This code of conduct applies both within project spaces and in public spaces
|
35
|
+
when an individual is representing the project or its community.
|
36
|
+
|
37
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
38
|
+
reported by contacting a project maintainer at kayhide@gmail.com. All
|
39
|
+
complaints will be reviewed and investigated and will result in a response that
|
40
|
+
is deemed necessary and appropriate to the circumstances. Maintainers are
|
41
|
+
obligated to maintain confidentiality with regard to the reporter of an
|
42
|
+
incident.
|
43
|
+
|
44
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
45
|
+
version 1.3.0, available at
|
46
|
+
[http://contributor-covenant.org/version/1/3/0/][version]
|
47
|
+
|
48
|
+
[homepage]: http://contributor-covenant.org
|
49
|
+
[version]: http://contributor-covenant.org/version/1/3/0/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2016 kayhide
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,102 @@
|
|
1
|
+
# Bundler::Gtags
|
2
|
+
|
3
|
+
GNU Global (gtags) utility.
|
4
|
+
|
5
|
+
`bundler-gtags` command creates gtags for all bundled gems.
|
6
|
+
And also manages direnv settings exporting GTAGSLIBPATH so that editors can tag-jump
|
7
|
+
directly to any gems source code from the bundler application.
|
8
|
+
|
9
|
+
## Installation
|
10
|
+
|
11
|
+
Add this line to your application's Gemfile:
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
gem 'bundler-gtags'
|
15
|
+
```
|
16
|
+
|
17
|
+
And then execute:
|
18
|
+
|
19
|
+
$ bundle
|
20
|
+
|
21
|
+
Or install it yourself as:
|
22
|
+
|
23
|
+
$ gem install bundler-gtags
|
24
|
+
|
25
|
+
## Usage
|
26
|
+
|
27
|
+
To use tag-jump functionality to the utmost extent,
|
28
|
+
3 things are needed before go to your project.
|
29
|
+
|
30
|
+
**First**, [GNU Global](https://www.gnu.org/software/global/) is required.
|
31
|
+
|
32
|
+
Pymgments option is recommended.
|
33
|
+
|
34
|
+
On OSX:
|
35
|
+
|
36
|
+
$ install global --with-ctags --with-pygments
|
37
|
+
|
38
|
+
**Next**, `direnv` command is required.
|
39
|
+
|
40
|
+
Go and follow the install instruction of
|
41
|
+
[direnv](https://github.com/direnv/direnv).
|
42
|
+
|
43
|
+
**And lastly**, your editor would need some setting.
|
44
|
+
|
45
|
+
On Emacs, `projectile-direnv` package works nicely.
|
46
|
+
|
47
|
+
```lisp
|
48
|
+
(use-package projectile-direnv
|
49
|
+
:commands (projectile-direnv-export-variables)
|
50
|
+
:init
|
51
|
+
(add-hook 'projectile-mode-hook 'projectile-direnv-export-variables)
|
52
|
+
)
|
53
|
+
```
|
54
|
+
|
55
|
+
|
56
|
+
Now, you are ready to generate gtags for your project's gems.
|
57
|
+
|
58
|
+
Go to your project root dir (there must be a Gemfile), and hit:
|
59
|
+
|
60
|
+
$ bundler-gtags
|
61
|
+
|
62
|
+
After some time, GTAGS files are created at the every gem root dir.
|
63
|
+
|
64
|
+
And also `.envrc` file, which is direnv settings file, is to be at your project root dir.
|
65
|
+
|
66
|
+
If you are already using direnv and having `.envrc` file,
|
67
|
+
`bundler-gtags` command will just append a line to the end of the existing one.
|
68
|
+
|
69
|
+
Note that `.envrc` should be excluded from git management, because it includes some system specific settings.
|
70
|
+
Putting it into the user-local `.gitignore` might be a good idea.
|
71
|
+
To do so:
|
72
|
+
|
73
|
+
$ git config --global core.excludesfile ~/.gitignore
|
74
|
+
$ echo .envrc >> ~/.gitignore
|
75
|
+
|
76
|
+
|
77
|
+
Thats it.
|
78
|
+
Finally, you are ready to jump around the codes of gems.
|
79
|
+
Enjoy code reading :)
|
80
|
+
|
81
|
+
## Thanks
|
82
|
+
|
83
|
+
Original idea came from here.
|
84
|
+
[Emacs での Rails 開発を GNU GLOBAL でだいぶ快適にする](http://qiita.com/5t111111/items/5e854f6047d187ea21c7)
|
85
|
+
|
86
|
+
Thanks for @5t111111
|
87
|
+
|
88
|
+
## Development
|
89
|
+
|
90
|
+
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.
|
91
|
+
|
92
|
+
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).
|
93
|
+
|
94
|
+
## Contributing
|
95
|
+
|
96
|
+
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.
|
97
|
+
|
98
|
+
|
99
|
+
## License
|
100
|
+
|
101
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
102
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "bundler-gtags"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
lib = File.expand_path('../lib', __FILE__)
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
3
|
+
require 'bundler-gtags/version'
|
4
|
+
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = 'bundler-gtags'
|
7
|
+
spec.version = Bundler::Gtags::VERSION
|
8
|
+
spec.authors = ['kayhide']
|
9
|
+
spec.email = ['kayhide@gmail.com']
|
10
|
+
|
11
|
+
spec.summary = 'GNU Global (gtags) utility.'
|
12
|
+
spec.description = 'GNU Global (gtags) utility. Create gtags for all bundled gems and manage direnv settings exporting GTAGSLIBPATH.'
|
13
|
+
spec.homepage = 'https://github.com/kayhide/bundler-gtags'
|
14
|
+
spec.license = 'MIT'
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
17
|
+
spec.bindir = 'exe'
|
18
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
19
|
+
spec.require_paths = ['lib']
|
20
|
+
|
21
|
+
spec.add_runtime_dependency 'bundler', '~> 1.11'
|
22
|
+
spec.add_runtime_dependency 'colored'
|
23
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
24
|
+
spec.add_development_dependency 'rspec', '~> 3.0'
|
25
|
+
spec.add_development_dependency 'pry'
|
26
|
+
end
|
data/exe/bundler-gtags
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
require 'bundler'
|
2
|
+
require 'thor'
|
3
|
+
|
4
|
+
require 'bundler-gtags'
|
5
|
+
require 'bundler-gtags/utils'
|
6
|
+
|
7
|
+
module Bundler::Gtags
|
8
|
+
class CLI < Thor
|
9
|
+
include Thor::Actions
|
10
|
+
|
11
|
+
default_task :gtags
|
12
|
+
|
13
|
+
desc 'gtags', 'Create gtags and manage direnv settings'
|
14
|
+
method_option :gtagslabel, type: :string, default: 'pygments'
|
15
|
+
long_desc <<-D
|
16
|
+
Creates GNU Global (gtags) for all bundled gems. And also manages direnv
|
17
|
+
settings for current project exporting GTAGSLIBPATH with project path and
|
18
|
+
all gem paths.
|
19
|
+
D
|
20
|
+
def gtags(*args)
|
21
|
+
require 'bundler-gtags/cli/gtags'
|
22
|
+
Gtags.new(options, args).run
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,95 @@
|
|
1
|
+
require 'colored'
|
2
|
+
|
3
|
+
module Bundler::Gtags
|
4
|
+
class CLI::Gtags
|
5
|
+
attr_reader :options, :args
|
6
|
+
|
7
|
+
def initialize(options, args)
|
8
|
+
@options = options
|
9
|
+
@cmd = args.shift
|
10
|
+
@args = args
|
11
|
+
end
|
12
|
+
|
13
|
+
def run
|
14
|
+
generate_gtags
|
15
|
+
update_envrc
|
16
|
+
end
|
17
|
+
|
18
|
+
def gtagslabel
|
19
|
+
@options[:gtagslabel]
|
20
|
+
end
|
21
|
+
|
22
|
+
def gem_dirs
|
23
|
+
@gem_dirs ||=
|
24
|
+
`bundle show --paths`.lines.map(&:chomp).
|
25
|
+
select { |dir| Dir.exist? dir }
|
26
|
+
end
|
27
|
+
|
28
|
+
def envrc
|
29
|
+
'.envrc'
|
30
|
+
end
|
31
|
+
|
32
|
+
private
|
33
|
+
|
34
|
+
def generate_gtags
|
35
|
+
gem_dirs.select { |dir| Dir.exist? dir }.each do |dir|
|
36
|
+
Dir.chdir dir do
|
37
|
+
if File.exist? File.join(dir, 'GTAGS')
|
38
|
+
say 'exist', File.basename(dir), :yellow
|
39
|
+
else
|
40
|
+
say 'gtags', File.basename(dir), :green
|
41
|
+
`gtags --gtagslabel=#{gtagslabel}`
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
def update_envrc
|
48
|
+
original =
|
49
|
+
if File.exist? envrc
|
50
|
+
open(envrc) { |f| f.read }
|
51
|
+
end
|
52
|
+
|
53
|
+
paths = [Dir.pwd, *gem_dirs]
|
54
|
+
new_line = "export GTAGSLIBPATH=#{paths.join(':')}\n"
|
55
|
+
|
56
|
+
updated =
|
57
|
+
if original
|
58
|
+
replaced = false
|
59
|
+
original.lines.inject([]) do |res, line|
|
60
|
+
if line =~ /^export GTAGSLIBPATH=/
|
61
|
+
if replaced
|
62
|
+
res
|
63
|
+
else
|
64
|
+
replaced = true
|
65
|
+
res << new_line
|
66
|
+
end
|
67
|
+
else
|
68
|
+
res << line
|
69
|
+
end
|
70
|
+
end.join
|
71
|
+
end
|
72
|
+
|
73
|
+
if updated && !updated.include?(new_line)
|
74
|
+
updated << "\n" if updated[-1] != "\n"
|
75
|
+
updated << new_line
|
76
|
+
end
|
77
|
+
|
78
|
+
updated ||= new_line
|
79
|
+
|
80
|
+
if original == updated
|
81
|
+
say 'identical', '.envrc', :blue
|
82
|
+
else
|
83
|
+
open(envrc, 'w') do |f|
|
84
|
+
if original
|
85
|
+
say 'update', '.envrc', :magenta
|
86
|
+
else
|
87
|
+
say 'create', '.envrc', :green
|
88
|
+
end
|
89
|
+
f << updated
|
90
|
+
end
|
91
|
+
`direnv allow`
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|
metadata
ADDED
@@ -0,0 +1,134 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: bundler-gtags
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- kayhide
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-04-26 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.11'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.11'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: colored
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '10.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '10.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '3.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '3.0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: pry
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
description: GNU Global (gtags) utility. Create gtags for all bundled gems and manage
|
84
|
+
direnv settings exporting GTAGSLIBPATH.
|
85
|
+
email:
|
86
|
+
- kayhide@gmail.com
|
87
|
+
executables:
|
88
|
+
- bundler-gtags
|
89
|
+
extensions: []
|
90
|
+
extra_rdoc_files: []
|
91
|
+
files:
|
92
|
+
- ".gitignore"
|
93
|
+
- ".rspec"
|
94
|
+
- ".travis.yml"
|
95
|
+
- CODE_OF_CONDUCT.md
|
96
|
+
- Gemfile
|
97
|
+
- LICENSE.txt
|
98
|
+
- README.md
|
99
|
+
- Rakefile
|
100
|
+
- bin/console
|
101
|
+
- bin/setup
|
102
|
+
- bundler-gtags.gemspec
|
103
|
+
- exe/bundler-gtags
|
104
|
+
- lib/bundler-gtags.rb
|
105
|
+
- lib/bundler-gtags/cli.rb
|
106
|
+
- lib/bundler-gtags/cli/gtags.rb
|
107
|
+
- lib/bundler-gtags/utils.rb
|
108
|
+
- lib/bundler-gtags/version.rb
|
109
|
+
homepage: https://github.com/kayhide/bundler-gtags
|
110
|
+
licenses:
|
111
|
+
- MIT
|
112
|
+
metadata: {}
|
113
|
+
post_install_message:
|
114
|
+
rdoc_options: []
|
115
|
+
require_paths:
|
116
|
+
- lib
|
117
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
118
|
+
requirements:
|
119
|
+
- - ">="
|
120
|
+
- !ruby/object:Gem::Version
|
121
|
+
version: '0'
|
122
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
123
|
+
requirements:
|
124
|
+
- - ">="
|
125
|
+
- !ruby/object:Gem::Version
|
126
|
+
version: '0'
|
127
|
+
requirements: []
|
128
|
+
rubyforge_project:
|
129
|
+
rubygems_version: 2.4.5.1
|
130
|
+
signing_key:
|
131
|
+
specification_version: 4
|
132
|
+
summary: GNU Global (gtags) utility.
|
133
|
+
test_files: []
|
134
|
+
has_rdoc:
|