rustlings/install.sh
Jonah Kruschke 5aa2173f5f chore(installation): Refactor installation script
- Run the script through `shellcheck` and apply the suggested changes,
  bar one regarding the use of `ls`.
- Add more descriptive comments.
- Refactor and simplify code.
2020-08-03 22:57:35 -04:00

129 lines
3.8 KiB
Bash
Executable file

#!/usr/bin/env bash
# Compare two version strings, v1 and v2, passed as arguments (e.g 1.31 and
# 1.33.0). Returns 1 if v1 > v2, 0 if v1 == v2, 2 if v1 < v2.
compare_versions() {
[ "$1" == "$2" ] && return 0
declare -a v1=() v2=()
mapfile -d . -t v1 < <(echo "$1")
mapfile -d . -t v2 < <(echo "$1")
declare -ir max_len=$(( ${#v1[@]} > ${#v2[@]} ? ${#v1[@]} : ${#v2[@]} ))
for i in $(seq 0 "$max_len")
do
# Fill empty fields with zeros.
[ -z "${v1[$i]}" ] && v1["$i"]=0
[ -z "${v2[$i]}" ] && v2["$i"]=0
# Compare the fields.
[ ${v1[$i]} -gt ${v2[$i]} ] && return 1
[ ${v1[$i]} -lt ${v2[$i]} ] && return 2
done
return 0
}
# Return 0 if the argument passed represents a valid command on the machine,
# 1 otherwise.
verify_dependency() {
declare -r package="$1"
if [ -x "$(command -v "$package")" ]
then
echo "SUCCESS: $package is installed"
return 0
else
echo "ERROR: $package does not seem to be installed." >&2
return 1
fi
}
declare Clippy Py RustVersion Version
declare -r CargoBin="${CARGO_HOME:-$HOME/.cargo}/bin"
declare -r Path=${1:-rustlings/}
declare -r MinRustVersion=1.31
echo "Let's get you set up with Rustlings!"
# Verify that the required dependencies are installed.
echo "Checking requirements..."
for dep in git rustc cargo curl
do
verify_dependency "$dep" || exit 1
done
# Look up Python installations; start with 3 and fallback to 2 if required.
if [ -x "$(command -v python3)" ]
then
Py="$(command -v python3)"
elif [ -x "$(command -v python)" ]
then
Py="$(command -v python)"
elif [ -x "$(command -v python2)" ]
then
Py="$(command -v python2)"
else
echo ERROR: No working python installation was found. >&2
echo Please install python and add it to the PATH variable. >&2
exit 1
fi
# Ensure the installed Rust compiler is sufficiently up-to-date.
RustVersion=$(rustc --version | cut -d " " -f 2)
compare_versions "$RustVersion" "$MinRustVersion"
if [ $? -eq 2 ]
then
echo ERROR: Rust version is too old: "$RustVersion" - needs at least \
"$MinRustVersion" >&2
echo Please update Rust with \`rustup update\`. >&2
exit 1
else
echo "SUCCESS: Rust is up to date"
fi
# Clone the Git repository.
echo "Cloning Rustlings into $Path..."
git clone -q https://github.com/rust-lang/rustlings "$Path"
cd "$Path" || exit 1
# Determine which version of Rustlings to install.
Version=$(curl -s \
https://api.github.com/repos/rust-lang/rustlings/releases/latest \
| "$Py" -c \
"import json,sys;obj=json.load(sys.stdin);print(obj['tag_name']);")
if [ -z "$Version" ]
then
echo The latest tag version could not be fetched remotely.
echo Using the local git repository...
Version=$(ls -t .git/refs/tags/ | head --lines=1)
if [ -z "$Version" ]
then
echo No valid tag version found
echo Rustlings will be installed using the main branch
Version="main"
else
Version="tags/$Version"
fi
else
Version="tags/$Version"
fi
# Install the selected version of Rustlings.
echo "Checking out version $Version..."
git checkout -q "$Version"
echo "Installing the 'rustlings' executable..."
cargo install --force --path .
# Verify that the Rustlings installation was successful.
if ! [ -x "$(command -v rustlings)" ]
then
echo WARNING: Please ensure "'$CargoBin'" is in your PATH environment \
variable!
fi
# Ensure Clippy is installed (due to a bug in Cargo, this must be done with
# Rustup: https://github.com/rust-lang/rustup/issues/1514).
Clippy=$(rustup component list | grep "clippy" | grep "installed")
if [ -z "$Clippy" ]
then
echo "Installing the 'cargo-clippy' executable..."
rustup component add clippy
fi
echo "All done! Run 'rustlings' to get started."