Browse Source

ruby: Cleanup and optimize 'ruby' module

Changes:
- Honor `$RBENV_ROOT` or `RVM_DIR` if set but, no need to set it
  explicitly if not set. Instead, let the respective initialization
  scripts take care of that.
- Reverse `rbenv` vs `rvm` selection order, preferring `rbenv` instead.
- Check for availability of `rbenv` or `rvm` function instead of command
  to validate requirements. In a properly configured and initialized
  shell, `rbenv` or `rvm` will be available as function.
- Adhere to more idiomatic Zsh operation and minimize redundant syntaxes.

For additional rationale, see: https://github.com/rbenv/rbenv/wiki/Why-rbenv%3F
master
Indrajit Raychaudhuri 4 years ago committed by Indrajit Raychaudhuri
parent
commit
491d1b5afe
  1. 30
      modules/ruby/README.md
  2. 43
      modules/ruby/init.zsh

30
modules/ruby/README.md

@ -6,11 +6,22 @@ aliases.
## Local Gem Installation ## Local Gem Installation
When a Ruby version manager is not detected, local gems are installed in When a Ruby version manager is not detected, local gems are installed in
_`~/.gems`_; otherwise, they are installed according to the manager. _`~/.gem`_; otherwise, they are installed according to the manager.
## rbenv
An alternative RVM is to use [_rbenv_][2], which allows for switching between
multiple, isolated Ruby installations in the home directory.
While it is not as feature rich as RVM, it is not loaded into the shell and is
not known to cause conflicts with shell scripts.
This will be loaded automatically if _rbenv_ is installed to `$RBENV_ROOT`,
_`~/.rbenv`_, or if the `rbenv` command is on the path.
## rvm ## rvm
An alternative to the above is to use [The Ruby Version Manager (_rvm_)][2], An alternative to the above is to use [The Ruby Version Manager (_rvm_)][3],
which allows for managing multiple, isolated Ruby installations and gem sets in which allows for managing multiple, isolated Ruby installations and gem sets in
the home directory. the home directory.
@ -20,17 +31,6 @@ may conflict with shell scripts.
Load this module as late as possible when using RVM since RVM will complain if Load this module as late as possible when using RVM since RVM will complain if
it is not first in `$PATH`. it is not first in `$PATH`.
## rbenv
An alternative RVM is to use [_rbenv_][3], which allows for switching between
multiple, isolated Ruby installations in the home directory.
While it is not as feature rich as RVM, it is not loaded into the shell and is
not known to cause conflicts with shell scripts.
This will be loaded automatically if _rbenv_ is installed to `$RBENV_ROOT`,
_`~/.rbenv`_, or if the `rbenv` command is on the path.
## chruby ## chruby
Yet another alternative is [_chruby_][4], which is simpler than both _rvm_ and Yet another alternative is [_chruby_][4], which is simpler than both _rvm_ and
@ -99,8 +99,8 @@ _The authors of this module should be contacted via the [issue tracker][6]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
[1]: https://www.ruby-lang.org [1]: https://www.ruby-lang.org
[2]: https://rvm.io [2]: https://github.com/rbenv/rbenv
[3]: https://github.com/sstephenson/rbenv [3]: https://rvm.io
[4]: https://github.com/postmodern/chruby [4]: https://github.com/postmodern/chruby
[5]: https://gembundler.com [5]: https://gembundler.com
[6]: https://github.com/sorin-ionescu/prezto/issues [6]: https://github.com/sorin-ionescu/prezto/issues

43
modules/ruby/init.zsh

@ -1,27 +1,32 @@
# #
# Configures Ruby local gem installation, loads version managers, and defines # Configures Ruby local installation, loads version managers, and defines
# aliases. # aliases.
# #
# Authors: Sorin Ionescu <sorin.ionescu@gmail.com> # Authors:
# Sorin Ionescu <sorin.ionescu@gmail.com>
# Indrajit Raychaudhuri <irc@indrajit.com>
# #
# Load RVM into the shell session. # Possible lookup locations for manually installed rbenv and rvm.
if [[ -s "$HOME/.rvm/scripts/rvm" ]]; then local_rbenv_paths=({$RBENV_ROOT,{$XDG_CONFIG_HOME/,$HOME/.}rbenv}/bin/rbenv(N))
# Unset AUTO_NAME_DIRS since auto adding variable-stored paths to ~ list local_rvm_paths=({$RVM_DIR,{$XDG_CONFIG_HOME/,$HOME/.}rvm}/scripts/rvm(N))
# conflicts with RVM.
unsetopt AUTO_NAME_DIRS
# Source RVM. # Load manually installed or package manager installed rbenv into the shell
source "$HOME/.rvm/scripts/rvm" # session.
if (( $#local_rbenv_paths || $+commands[rbenv] )); then
# Load manually installed rbenv into the shell session. # Ensure manually installed rbenv is added to path when present.
elif [[ -s "${RBENV_ROOT:=$HOME/.rbenv}/bin/rbenv" ]]; then [[ -s $local_rbenv_paths[1] ]] && path=($local_rbenv_paths[1]:h $path)
path=("${RBENV_ROOT}/bin" $path)
eval "$(rbenv init - --no-rehash zsh)"
# Load package manager installed rbenv into the shell session. eval "$(rbenv init - zsh)"
elif (( $+commands[rbenv] )); then
eval "$(rbenv init - --no-rehash zsh)" # Load manually installed rvm into the shell session.
elif (( $#local_rvm_paths )); then
# Unset AUTO_NAME_DIRS since auto adding variable-stored paths to ~ list
# conflicts with rvm.
unsetopt AUTO_NAME_DIRS
source "$local_rvm_paths[1]"
# Load package manager installed chruby into the shell session. # Load package manager installed chruby into the shell session.
elif (( $+commands[chruby-exec] )); then elif (( $+commands[chruby-exec] )); then
@ -34,7 +39,7 @@ elif (( $+commands[chruby-exec] )); then
source "${commands[chruby-exec]:h:h}/share/chruby/auto.sh" source "${commands[chruby-exec]:h:h}/share/chruby/auto.sh"
fi fi
# If a default Ruby is set, switch to it. # If a default ruby is set, switch to it.
chruby_auto chruby_auto
fi fi
@ -43,8 +48,10 @@ else
path=($HOME/.gem/ruby/*/bin(N) $path) path=($HOME/.gem/ruby/*/bin(N) $path)
fi fi
unset local_rbenv
# Return if requirements are not found. # Return if requirements are not found.
if (( ! $+commands[ruby] && ! ( $+commands[rvm] || $+commands[rbenv] ) )); then if (( ! $+commands[ruby] && ! $#functions[(i)r(benv|vm)] )); then
return 1 return 1
fi fi

Loading…
Cancel
Save