1.0.0

ChangeLog.md

@@ -1,3 +1,22 @@
+### 1.0.0
+
+#### Upgrade Notes
+
+* When updating from `chruby` < 1.0 to `chruby` >= 1.0, you will need to
+  re-install your gems because the gem directories will be different. It is also
+  recommended to clean old gem directories under `~/.gem` which will no longer
+  be used to save disk space. To remove them, you can use
+  `rm -rf ~/.gem/{ruby,jruby,rbx,truffleruby}/[0-9].[0-9].[0-9]`
+
+#### chruby.sh
+
+* Use the installed Ruby directory name for setting `GEM_HOME`. (@eregon)  
+  This guarantees a unique `GEM_HOME` per installed Ruby, even if they have
+  the same `RUBY_VERSION`.  This is important for native extensions, which
+  might compile differently based on build-time flags such as `--enable-shared`.
+  This also fixes the bug that the `GEM_HOME` for non-MRI Ruby implementations
+  was shared even for different releases.
+
 ### 0.3.9 / 2014-11-23
 
 #### chruby.sh

Makefile

@@ -1,5 +1,5 @@
 NAME=chruby
-VERSION=0.3.9
+VERSION=1.0.0
 AUTHOR=postmodern
 URL=https://github.com/$(AUTHOR)/$(NAME)
 
@@ -22,6 +22,15 @@ all:
 pkg:
 	mkdir $(PKG_DIR)
 
+share/man/man1/chruby.1: doc/man/chruby.1.md
+	kramdown-man <doc/man/chruby.1.md >share/man/man1/chruby.1
+
+share/man/man1/chruby-exec.1: doc/man/chruby-exec.1.md
+	kramdown-man <doc/man/chruby-exec.1.md >share/man/man1/chruby-exec.1
+
+update-man: share/man/man1/chruby.1 share/man/man1/chruby-exec.1
+	git commit -m "Updated the man pages" doc/man/chruby.1.md share/man/man1/chruby.1 doc/man/chruby-exec.1.md share/man/man1/chruby-exec.1
+
 download: pkg
 	wget -O $(PKG) $(URL)/archive/v$(VERSION).tar.gz
 
@@ -80,4 +89,4 @@ uninstall:
 	rm -rf $(DESTDIR)$(PREFIX)/$(DOC_DIR)
 	rmdir $(DESTDIR)$(PREFIX)/$(SHARE_DIR)/chruby
 
-.PHONY: build download sign verify clean check configure_tests test integration_tests gauntlet tag release rpm install uninstall all
+.PHONY: build man download sign verify clean check configure_tests test integration_tests gauntlet tag release rpm install uninstall all

README.md

@@ -9,8 +9,8 @@ Changes the current Ruby.
 * Updates `$PATH`.
   * Also adds RubyGems `bin/` directories to `$PATH`.
 * Correctly sets `$GEM_HOME` and `$GEM_PATH`.
-  * Users: gems are installed into `~/.gem/$ruby/$version`.
-  * Root: gems are installed directly into `/path/to/$ruby/$gemdir`.
+  * Users: gems are installed into `~/.gem/$ruby_name` (e.g., `~/.gem/ruby-2.6.3` for `~/.rubies/ruby-2.6.3`).
+  * Root: gems are installed directly into `$ruby_install_dir/$gemdir` (the default).
 * Additionally sets `$RUBY_ROOT`, `$RUBY_ENGINE`, `$RUBY_VERSION` and
   `$GEM_ROOT`.
 * Optionally sets `$RUBYOPT` if second argument is given.
@@ -218,13 +218,13 @@ If you have enabled auto-switching, simply create a `.ruby-version` file:
 ### RubyGems
 
 Gems installed as a non-root user via `gem install` will be installed into
-`~/.gem/$ruby/X.Y.Z`.  By default, RubyGems will use the absolute path to the
-currently selected ruby for the shebang of any binstubs it generates.  In some
-cases, this path may contain extra version information (e.g.
+`~/.gem/$ruby_name`.  By default, RubyGems will use the
+absolute path to the currently selected ruby for the shebang of any binstubs it
+generates.  In some cases, this path may contain extra version information (e.g.
 `ruby-2.0.0-p451`).  To mitigate potential problems when removing rubies, you
 can force RubyGems to generate binstubs with shebangs that will search for
 ruby in your `$PATH` by using `gem install --env-shebang` (or the equivalent
-short option `-E`).  This parameter can also be added to your gemrc file.
+short option `-E`).  This parameter can also be added to your `.gemrc` file.
 
 ### Integration
 
@@ -269,7 +269,7 @@ Select a Ruby:
         - ruby
         - x86_64-linux
       - GEM PATHS:
-         - /home/hal/.gem/ruby/1.9.3
+         - /home/hal/.gem/ruby-1.9.3-p392
          - /opt/rubies/ruby-1.9.3-p392/lib/ruby/gems/1.9.1
       - GEM CONFIGURATION:
          - :update_sources => true
@@ -299,7 +299,7 @@ Run a command under a Ruby with `chruby-exec`:
 
 Switch to an arbitrary Ruby on the fly:
 
-    $ chruby_use /path/to/ruby
+    $ chruby_set /path/to/ruby
 
 ## Uninstall
 

benchmarks/chruby_use.sh → benchmarks/chruby_set.sh

@@ -9,7 +9,7 @@ for i in {1..3}; do
 
 	time (
 		for ((i=0; i<$n; i+=1)); do
-			chruby_use "$ruby_dir"
+			chruby_set "$ruby_dir"
 		done
 	)
 done

doc/man/chruby-exec.1.md

@@ -0,0 +1,76 @@
+# chruby-exec(1) -- Run a command with selected Ruby.
+
+## SYNOPSIS
+
+`chruby-exec` RUBY [RUBYOPTS] -- COMMAND
+
+## ARGUMENTS
+
+*RUBY*
+    Change current Ruby based on fuzzy matching of Ruby by name.
+
+*RUBYOPTS*
+    Additional optional arguments to pass to Ruby.
+
+*COMMAND*
+    Command to run under the selected Ruby.
+
+## OPTIONS
+
+`-h`, `--help`
+
+`-v`, `--version`
+
+## DESCRIPTION
+Run a command with the selected Ruby version by correctly setting the appropriate environment variables.
+
+[https://github.com/postmodern/chruby/blob/master/README.md](https://github.com/postmodern/chruby/blob/master/README.md)
+
+## EXAMPLES
+
+Run the command `gem update` under JRuby:
+    $ chruby-exec jruby -- gem update
+
+## FILES
+
+*/opt/rubies*
+    Primary default Ruby install location.
+
+*~/.rubies/*
+    Secondary default Ruby install location.
+
+*/etc/profile.d/chruby.sh*
+    Application environment settings for chruby.
+
+*~/.gem/$ruby/$version*
+    Default gem install location.
+
+## ENVIRONMENT
+
+*PATH*
+    Updates the PATH environment variable to include Rubies and RubyGems bin/ directories.
+
+*GEM_HOME*
+    Default repository location for gem installation.
+
+*GEM_PATH*
+    A colon-separated list of gem repository directories.
+
+*GEM_ROOT*
+
+*RUBY_ROOT*
+
+*RUBY_ENGINE*
+    Name of Ruby implementation.
+
+*RUBY_VERSION*
+    Ruby version number.
+
+*RUBYOPT*
+    Optionally set if additional Ruby options are given.
+
+## AUTHOR
+Postmodern [postmodern.mod3\@gmail.com](mailto:postmodern.mod3\@gmail.com).
+
+## SEE ALSO
+chruby(1), ruby(1), gem(1)

doc/man/chruby.1.md

@@ -0,0 +1,95 @@
+# chruby(1) -- Changes the current Ruby.
+
+## SYNOPSIS
+
+`chruby` [OPTIONS | <RUBY|VERSION> [<RUBY_OPTS>] | system]
+
+## ARGUMENTS
+
+*RUBY|VERSION*
+    Change current Ruby based on fuzzy matching of Ruby by name.
+
+*system*
+    Change current Ruby to system Ruby.
+
+*RUBY_OPTS*
+    Additional optional arguments to pass to Ruby.
+
+## OPTIONS
+
+`-h`, `--help`
+
+`-v`, `--version`
+
+## DESCRIPTION
+Changes the current Ruby version by correctly setting the appropriate environment variables.
+
+[https://github.com/postmodern/chruby/blob/master/README.md](https://github.com/postmodern/chruby/blob/master/README.md)
+
+## EXAMPLES
+
+List available Rubies:
+    $ chruby
+       ruby-1.9.3-p362
+       jruby-1.7.2
+       rubinius-2.0.0-rc1
+
+Select a Ruby:
+    $ chruby 1.9.3
+    $ chruby
+     * ruby-1.9.3-p362
+       jruby-1.7.2
+       rubinius-2.0.0-rc1
+
+Switch to JRuby in 1.9 mode:
+    $ chruby jruby --1.9
+
+Switch back to system Ruby:
+    $ chruby system
+
+Switch to an arbitrary Ruby on the fly:
+    $ chruby_set /path/to/ruby
+
+## FILES
+
+*/opt/rubies*
+    Primary default Ruby install location.
+
+*~/.rubies/*
+    Secondary default Ruby install location.
+
+*/etc/profile.d/chruby.sh*
+    Application environment settings for chruby.
+
+*~/.gem/$ruby/$version*
+    Default gem install location.
+
+## ENVIRONMENT
+
+*PATH*
+    Updates the PATH environment variable to include Rubies and RubyGems bin/ directories.
+
+*GEM_HOME*
+    Default repository location for gem installation.
+
+*GEM_PATH*
+    A colon-separated list of gem repository directories.
+
+*GEM_ROOT*
+
+*RUBY_ROOT*
+
+*RUBY_ENGINE*
+    Name of Ruby implementation.
+
+*RUBY_VERSION*
+    Ruby version number.
+
+*RUBYOPT*
+    Optionally set if additional Ruby options are given.
+
+## AUTHOR
+Postmodern [postmodern.mod3\@gmail.com](mailto:postmodern.mod3\@gmail.com).
+
+## SEE ALSO
+chruby-exec(1), ruby(1), gem(1)

share/chruby/auto.sh

@@ -1,6 +1,7 @@
-unset RUBY_AUTO_VERSION
+unset CHRUBY_AUTO_VERSION
 
-function chruby_auto() {
+function chruby_auto()
+{
 	local dir="$PWD/" version
 
 	until [[ -z "$dir" ]]; do
@@ -9,18 +10,19 @@ function chruby_auto() {
 		if { read -r version <"$dir/.ruby-version"; } 2>/dev/null || [[ -n "$version" ]]; then
 			version="${version%%[[:space:]]}"
 
-			if [[ "$version" == "$RUBY_AUTO_VERSION" ]]; then return
+			if [[ "$version" == "$CHRUBY_AUTO_VERSION" ]]; then
+				return
 			else
-				RUBY_AUTO_VERSION="$version"
+				CHRUBY_AUTO_VERSION="$version"
 				chruby "$version"
 				return $?
 			fi
 		fi
 	done
 
-	if [[ -n "$RUBY_AUTO_VERSION" ]]; then
+	if [[ -n "$CHRUBY_AUTO_VERSION" ]]; then
 		chruby_reset
-		unset RUBY_AUTO_VERSION
+		unset CHRUBY_AUTO_VERSION
 	fi
 }