kyoshidajp / bundler-alive

Are your gems alive? bunder-alive checks if gems in a RubyGem's Gemfile.lock are active.

bundler-alive

bundler-alive checks if gems in a RubyGem's Gemfile.lock are active.

Currently, GitHub.com and GitLab.com are supported as a source code repository. If the source code repository is archived, then reports as not alive.

Installation

$ gem install bundler-alive

Usage

$ bundle-alive
6 gems are in Gemfile.lock
..W....
Get all source code repository URLs of gems are done!
.....

Errors:
    [bundle-alive] Not found in RubyGems.org.

Archived gems:
    Name: journey
    URL: http://github.com/rails/journey

Total: 6 (Archived: 1, Alive: 4, Unknown: 1)
Not alive gems are found!

Default Gemfile.lock location is in your current directory. You can specify it.

$ bundle-alive -G /path/to/Gemfile.lock

Access Token

You MUST set environment variables to access source code repository services.

Repository service	ENV variable
GitHub	BUNDLER_ALIVE_GITHUB_TOKEN
GitLab	BUNDLER_ALIVE_GITLAB_TOKEN

Ignore gems

You can ignore certain gems.

$ bundle-alive -i journey rubocop-junit-formatter

Following redirect on RubyGems.org

The URL for some gems in RubyGems.org may have changed. You can follow the URL (default: doesn't follow).

$ bundle-alive --follow_redirect

Specifying repository URL

In some cases, some gems cannot find the URL of their source code repositories. For this case, you can specify a mapping between the gem and its URL.

Put .bundler-alive.yml in your current directory. The following code is the sample.

---
gems:
  coffee-script-source:
    url: https://github.com/jashkenas/coffeescript/

You can also specify the file path.

$ bundle-alive -c /path/to/.bundler-alive.yml

.bundler-alive.default.yml may also be helpful. Considering that having these mappings obtained automatically in the future.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kyoshidajp/bunlder-alive.

Thanks

This gem was inspired by the following products.

• bundler-audit
• 良いコード／悪いコードで学ぶ設計入門 ―保守しやすい 成長し続けるコードの書き方

bundler-alive's Issues

Improve response from GitHub

Currently, sleep 120 seconds when exceeded rate limit, then retry. It's not good because it doesn't wait the proper amount of time.

My ideas are

1. Call GitHub GraphQL API
   • might be good in this case
2. Use GH Archive
3. Introduce cache mechanizm

Follow forked repositories

Add fork:true query.

Gem and repository URL mapping automatically update

Support bitbucket

Can't get repository from GitHub

Some repositories couldn't hit in GitHub API.

For example, rails/spring repository exists as https://github.com/rails/spring, but not in https://github.com/search?q=repo%3Arails%2Fspring. Why?

Support ignore option and settings

Support www.github.com

Support gem and source code repository mapping configuration

Turn off following redirect check option

Now, checking a URL of source code repository in RubyGems.org about redirection. It's very slow in many gems are.

Turn off following redirect check option is useful in the case.

Suggest setting `BUNDLER_ALIVE_GITHUB_TOKEN` message

Support GitLab as Source Code Repository

Support GitHub subdomain URL

For example ffi's source code repository is http://wiki.github.com/ffi/ffi

The URL is 404, but it means http://github.com/ffi/ffi

Use cache of service response

1. RubyGems.org
2. Source Code Repository
   • Searching multi repositories on GitHub.