1.0.0

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

@@ -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
 }
 

share/chruby/chruby.sh

@@ -1,10 +1,35 @@
-CHRUBY_VERSION="0.3.9"
-RUBIES=()
+CHRUBY_VERSION="1.0.0"
+CHRUBY_DIRS=("$PREFIX/opt/rubies" "$HOME/.rubies")
 
-for dir in "$PREFIX/opt/rubies" "$HOME/.rubies"; do
-	[[ -d "$dir" && -n "$(command ls -A "$dir")" ]] && RUBIES+=("$dir"/*)
-done
-unset dir
+function chruby_list()
+{
+	local rubies_dir ruby_dir
+
+	for rubies_dir in "${CHRUBY_DIRS[@]}"; do
+		for ruby_dir in "${rubies_dir}"/*; do
+			if [[ -d "$ruby_dir" ]]; then
+				echo "$ruby_dir"
+			fi
+		done
+	done
+}
+
+function chruby_find()
+{
+	local ruby_dir ruby_name match
+
+	while IFS= read -r ruby_dir; do
+		ruby_dir="${ruby_dir%%/}"
+		ruby_name="${ruby_dir##*/}"
+
+		case "$ruby_name" in
+			"$1")	match="$ruby_dir" && break ;;
+			*"$1"*)	match="$ruby_dir" ;;
+		esac
+	done <<< "$(chruby_list)"
+
+	echo -n "$match"
+}
 
 function chruby_reset()
 {
@@ -30,16 +55,18 @@ function chruby_reset()
 	hash -r
 }
 
-function chruby_use()
+function chruby_set()
 {
-	if [[ ! -x "$1/bin/ruby" ]]; then
-		echo "chruby: $1/bin/ruby not executable" >&2
+	local ruby_dir="$1"
+
+	if [[ ! -x "$ruby_dir/bin/ruby" ]]; then
+		echo "chruby: $ruby_dir/bin/ruby not executable" >&2
 		return 1
 	fi
 
 	[[ -n "$RUBY_ROOT" ]] && chruby_reset
 
-	export RUBY_ROOT="$1"
+	export RUBY_ROOT="$ruby_dir"
 	export RUBYOPT="$2"
 	export PATH="$RUBY_ROOT/bin:$PATH"
 
@@ -64,41 +91,37 @@ function chruby()
 {
 	case "$1" in
 		-h|--help)
-			echo "usage: chruby [RUBY|VERSION|system] [RUBYOPT...]"
+			echo "usage: chruby [RUBY|VERSION [RUBYOPT...] | system]"
 			;;
 		-V|--version)
 			echo "chruby: $CHRUBY_VERSION"
 			;;
 		"")
-			local dir ruby
-			for dir in "${RUBIES[@]}"; do
-				dir="${dir%%/}"; ruby="${dir##*/}"
-				if [[ "$dir" == "$RUBY_ROOT" ]]; then
-					echo " * ${ruby} ${RUBYOPT}"
+			local ruby_dir ruby_name
+
+			while IFS= read -r ruby_dir; do
+				ruby_dir="${ruby_dir%%/}"
+				ruby_name="${ruby_dir##*/}"
+
+				if [[ "$ruby_dir" == "$RUBY_ROOT" ]]; then
+					echo " * ${ruby_name}${RUBYOPT:+ $RUBYOPT}"
 				else
-					echo "   ${ruby}"
+					echo "   ${ruby_name}"
 				fi
-
-			done
+			done <<< "$(chruby_list)"
 			;;
 		system) chruby_reset ;;
 		*)
-			local dir ruby match
-			for dir in "${RUBIES[@]}"; do
-				dir="${dir%%/}"; ruby="${dir##*/}"
-				case "$ruby" in
-					"$1")	match="$dir" && break ;;
-					*"$1"*)	match="$dir" ;;
-				esac
-			done
-
-			if [[ -z "$match" ]]; then
-				echo "chruby: unknown Ruby: $1" >&2
+			local ruby="$1"
+			local ruby_dir="$(chruby_find "$ruby")"
+
+			if [[ -z "$ruby_dir" ]]; then
+				echo "chruby: unknown Ruby: $ruby" >&2
 				return 1
 			fi
 
 			shift
-			chruby_use "$match" "$*"
+			chruby_set "$ruby_dir" "$*"
 			;;
 	esac
 }