diff options
Diffstat (limited to 'plugins/bundler')
| -rw-r--r-- | plugins/bundler/README.md | 79 | ||||
| -rw-r--r-- | plugins/bundler/bundler.plugin.zsh | 116 |
2 files changed, 110 insertions, 85 deletions
diff --git a/plugins/bundler/README.md b/plugins/bundler/README.md index a3bceb0ae..7b79cbcdc 100644 --- a/plugins/bundler/README.md +++ b/plugins/bundler/README.md @@ -1,34 +1,48 @@ # Bundler -- Adds completion for basic bundler commands - -- Adds short aliases for common bundler commands - - `ba` aliased to `bundle add` - - `be` aliased to `bundle exec`. - It also supports aliases (if `rs` is `rails server`, `be rs` will bundle-exec `rails server`). - - `bl` aliased to `bundle list` - - `bp` aliased to `bundle package` - - `bo` aliased to `bundle open` - - `bout` aliased to `bundle outdated` - - `bu` aliased to `bundle update` - - `bi` aliased to `bundle install --jobs=<cpu core count>` (only for bundler `>= 1.4.0`) - - `bcn` aliased to `bundle clean` - - `bck` aliased to `bundle check` - -- Adds a wrapper for common gems: - - Looks for a binstub under `./bin/` and executes it (if present) - - Calls `bundle exec <gem executable>` otherwise +This plugin adds completion for basic bundler commands, as well as aliases and helper functions for +an easier experience with bundler. + +To use it, add `bundler` to the plugins array in your zshrc file: + +```zsh +plugins=(... bundler) +``` + +## Aliases + +| Alias | Command | Description | +|--------|--------------------------------------|------------------------------------------------------------------------------------------| +| `ba` | `bundle add` | Add gem to the Gemfile and run bundle install | +| `bck` | `bundle check` | Verifies if dependencies are satisfied by installed gems | +| `bcn` | `bundle clean` | Cleans up unused gems in your bundler directory | +| `be` | `bundle exec` | Execute a command in the context of the bundle | +| `bi` | `bundle install --jobs=<core_count>` | Install the dependencies specified in your Gemfile (using all cores in bundler >= 1.4.0) | +| `bl` | `bundle list` | List all the gems in the bundle | +| `bo` | `bundle open` | Opens the source directory for a gem in your bundle | +| `bout` | `bundle outdated` | List installed gems with newer versions available | +| `bp` | `bundle package` | Package your needed .gem files into your application | +| `bu` | `bundle update` | Update your gems to the latest available versions | + +## Gem wrapper + +The plugin adds a wrapper for common gems, which: + +- Looks for a binstub under `./bin/` and executes it if present. +- Calls `bundle exec <gem>` otherwise. Common gems wrapped by default (by name of the executable): + `annotate`, `cap`, `capify`, `cucumber`, `foodcritic`, `guard`, `hanami`, `irb`, `jekyll`, `kitchen`, `knife`, `middleman`, `nanoc`, `pry`, `puma`, `rackup`, `rainbows`, `rake`, `rspec`, `rubocop`, `shotgun`, `sidekiq`, `spec`, `spork`, `spring`, `strainer`, `tailor`, `taps`, `thin`, `thor`, `unicorn` and `unicorn_rails`. -## Configuration +### Settings -Please use the exact name of the executable and not the gem name. +You can add or remove gems from the list of wrapped commands. +Please **use the exact name of the executable** and not the gem name. -### Add additional gems to be wrapped +#### Include gems to be wrapped (`BUNDLED_COMMANDS`) -Add this before the plugin-list in your `.zshrc`: +Add this before the plugin list in your `.zshrc`: ```sh BUNDLED_COMMANDS=(rubocop) @@ -37,10 +51,9 @@ plugins=(... bundler ...) This will add the wrapper for the `rubocop` gem (i.e. the executable). +#### Exclude gems from being wrapped (`UNBUNDLED_COMMANDS`) -### Exclude gems from being wrapped - -Add this before the plugin-list in your `.zshrc`: +Add this before the plugin list in your `.zshrc`: ```sh UNBUNDLED_COMMANDS=(foreman spin) @@ -49,13 +62,13 @@ plugins=(... bundler ...) This will exclude the `foreman` and `spin` gems (i.e. their executable) from being wrapped. -## Excluded gems +### Excluded gems -These gems should not be called with `bundle exec`. Please see [issue #2923](https://github.com/ohmyzsh/ohmyzsh/pull/2923) on GitHub for clarification. +These gems should not be called with `bundle exec`. Please see [issue #2923](https://github.com/ohmyzsh/ohmyzsh/pull/2923) on GitHub for clarification: -`berks` -`foreman` -`mailcatcher` -`rails` -`ruby` -`spin` +- `berks` +- `foreman` +- `mailcatcher` +- `rails` +- `ruby` +- `spin` diff --git a/plugins/bundler/bundler.plugin.zsh b/plugins/bundler/bundler.plugin.zsh index 65b0ffa6e..6293dc28a 100644 --- a/plugins/bundler/bundler.plugin.zsh +++ b/plugins/bundler/bundler.plugin.zsh @@ -1,13 +1,49 @@ +## Aliases + alias ba="bundle add" +alias bck="bundle check" +alias bcn="bundle clean" alias be="bundle exec" +alias bi="bundle_install" alias bl="bundle list" -alias bp="bundle package" alias bo="bundle open" alias bout="bundle outdated" +alias bp="bundle package" alias bu="bundle update" -alias bi="bundle_install" -alias bcn="bundle clean" -alias bck="bundle check" + +## Functions + +bundle_install() { + # Bail out if bundler is not installed + if (( ! $+commands[bundle] )); then + echo "Bundler is not installed" + return 1 + fi + + # Bail out if not in a bundled project + if ! _within-bundled-project; then + echo "Can't 'bundle install' outside a bundled project" + return 1 + fi + + # Check the bundler version is at least 1.4.0 + autoload -Uz is-at-least + local bundler_version=$(bundle version | cut -d' ' -f3) + if ! is-at-least 1.4.0 "$bundler_version"; then + bundle install "$@" + return $? + fi + + # If bundler is at least 1.4.0, use all the CPU cores to bundle install + if [[ "$OSTYPE" = (darwin|freebsd)* ]]; then + local cores_num="$(sysctl -n hw.ncpu)" + else + local cores_num="$(nproc)" + fi + bundle install --jobs="$cores_num" "$@" +} + +## Gem wrapper bundled_commands=( annotate @@ -54,65 +90,41 @@ for cmd in $BUNDLED_COMMANDS; do bundled_commands+=($cmd); done -## Functions - -bundle_install() { - if ! _bundler-installed; then - echo "Bundler is not installed" - elif ! _within-bundled-project; then - echo "Can't 'bundle install' outside a bundled project" - else - local bundler_version=`bundle version | cut -d' ' -f3` - if [[ $bundler_version > '1.4.0' || $bundler_version = '1.4.0' ]]; then - if [[ "$OSTYPE" = (darwin|freebsd)* ]] - then - local cores_num="$(sysctl -n hw.ncpu)" - else - local cores_num="$(nproc)" - fi - bundle install --jobs=$cores_num $@ - else - bundle install $@ - fi - fi -} - -_bundler-installed() { - which bundle > /dev/null 2>&1 -} - +# Check if in the root or a subdirectory of a bundled project _within-bundled-project() { local check_dir="$PWD" - while [ "$check_dir" != "/" ]; do - [ -f "$check_dir/Gemfile" -o -f "$check_dir/gems.rb" ] && return - check_dir="$(dirname $check_dir)" + while [[ "$check_dir" != "/" ]]; do + if [[ -f "$check_dir/Gemfile" || -f "$check_dir/gems.rb" ]]; then + return 0 + fi + check_dir="${check_dir:h}" done - false -} - -_binstubbed() { - [ -f "./bin/${1}" ] + return 1 } _run-with-bundler() { - if _bundler-installed && _within-bundled-project; then - if _binstubbed $1; then - ./bin/${^^@} - else - bundle exec $@ - fi + if (( ! $+commands[bundle] )) || ! _within-bundled-project; then + "$@" + return $? + fi + + if [[ -f "./bin/${1}" ]]; then + ./bin/${^^@} else - $@ + bundle exec "$@" fi } -## Main program for cmd in $bundled_commands; do - eval "function unbundled_$cmd () { $cmd \$@ }" - eval "function bundled_$cmd () { _run-with-bundler $cmd \$@}" - alias $cmd=bundled_$cmd + # Create wrappers for bundled and unbundled execution + eval "function unbundled_$cmd () { \"$cmd\" \"\$@\"; }" + eval "function bundled_$cmd () { _run-with-bundler \"$cmd\" \"\$@\"; }" + alias "$cmd"="bundled_$cmd" - if which _$cmd > /dev/null 2>&1; then - compdef _$cmd bundled_$cmd=$cmd + # Bind completion function to wrapped gem if available + if (( $+functions[_$cmd] )); then + compdef "_$cmd" "bundled_$cmd"="$cmd" fi done + +unset cmd bundled_commands |