Refactor the Ruby feature to use functions

This will make easier to add other version managers in the future.

Author: rafaelfranca

features/src/ruby/devcontainer-feature.json

@@ -10,9 +10,6 @@
             ]
         }
     },
-    "containerEnv": {
-        "PATH": "/usr/local/share/rbenv/bin:${PATH}"
-    },
     "installsAfter": [
         "ghcr.io/devcontainers/features/common-utils"
     ],

features/src/ruby/install.sh

@@ -3,34 +3,86 @@ set -e
 
 USERNAME="${USERNAME:-"${_REMOTE_USER:-"automatic"}"}"
 
-apt-get update -y
-apt-get -y install --no-install-recommends git curl ca-certificates libssl-dev libreadline-dev zlib1g-dev autoconf bison build-essential \
-    libyaml-dev libncurses5-dev libffi-dev libgdbm-dev libxml2-dev rustc
+# Function to install dependencies needed for building Ruby
+install_dependencies() {
+    apt-get update -y
+    DEBIAN_FRONTEND=noninteractive apt-get -y install --no-install-recommends \
+        git \
+        curl \
+        ca-certificates \
+        libssl-dev \
+        libreadline-dev \
+        zlib1g-dev \
+        autoconf \
+        bison \
+        build-essential \
+        libyaml-dev \
+        libncurses5-dev \
+        libffi-dev \
+        libgdbm-dev \
+        libxml2-dev \
+        rustc
+}
 
-git clone https://github.com/rbenv/rbenv.git /usr/local/share/rbenv
-git clone https://github.com/rbenv/ruby-build.git /usr/local/share/ruby-build
+# Function to add lines to shell initialization files
+add_to_shell_init() {
+    _user="$1"
+    _bash_line="$2"
+    _zsh_line="${3:-$_bash_line}"  # Use bash_line as default if zsh_line not provided
 
-mkdir -p /root/.rbenv/plugins
-ln -s /usr/local/share/ruby-build /root/.rbenv/plugins/ruby-build
+    if [ "$_user" = "root" ]; then
+        _home_dir="/root"
+    else
+        _home_dir="/home/$_user"
+    fi
 
-if [ "${USERNAME}" != "root" ]; then
-    user_home="/home/${USERNAME}"
-    mkdir -p "${user_home}/.rbenv/plugins"
-    ln -s /usr/local/share/ruby-build "${user_home}/.rbenv/plugins/ruby-build"
+    echo "$_bash_line" >> "$_home_dir/.bashrc"
 
-    chown -R "${USERNAME}" "${user_home}/.rbenv/"
-    chmod -R g+r+w "${user_home}/.rbenv"
+    if [ -f "$_home_dir/.zshrc" ]; then
+        echo "$_zsh_line" >> "$_home_dir/.zshrc"
+    fi
+}
 
-    # shellcheck disable=SC2016
-    echo 'eval "$(rbenv init -)"' >> "${user_home}/.bashrc"
+# Function to setup rbenv
+setup_rbenv() {
+    _user="$1"
+    _user_home="/home/$_user"
 
-    if [ -f "${user_home}/.zshrc" ]; then
-        # shellcheck disable=SC2016
-        echo 'eval "$(rbenv init -)"' >> "${user_home}/.zshrc"
+    # Clone rbenv and ruby-build
+    git clone https://github.com/rbenv/rbenv.git /usr/local/share/rbenv
+    git clone https://github.com/rbenv/ruby-build.git /usr/local/share/ruby-build
+
+    # Setup plugins for root
+    mkdir -p /root/.rbenv/plugins
+    ln -s /usr/local/share/ruby-build /root/.rbenv/plugins/ruby-build
+
+    # Setup for non-root user if needed
+    if [ "$_user" != "root" ]; then
+        mkdir -p "$_user_home/.rbenv/plugins"
+        ln -s /usr/local/share/ruby-build "$_user_home/.rbenv/plugins/ruby-build"
+        chown -R "$_user" "$_user_home/.rbenv/"
+        chmod -R g+r+w "$_user_home/.rbenv"
     fi
-fi
 
-su "${USERNAME}" -c "/usr/local/share/rbenv/bin/rbenv install $VERSION"
-su "${USERNAME}" -c "/usr/local/share/rbenv/bin/rbenv global $VERSION"
+    # shellcheck disable=SC2016
+    add_to_shell_init "$_user" 'export PATH="/usr/local/share/rbenv/bin:$PATH"'
+    # shellcheck disable=SC2016
+    add_to_shell_init "$_user" 'eval "$(rbenv init -)"'
+}
+
+# Function to install Ruby with rbenv
+install_ruby_rbenv() {
+    _user="$1"
+    _version="$2"
+
+    su "$_user" -c "/usr/local/share/rbenv/bin/rbenv install $_version"
+    su "$_user" -c "/usr/local/share/rbenv/bin/rbenv global $_version"
+}
+
+install_dependencies
+
+setup_rbenv "${USERNAME}"
+
+install_ruby_rbenv "$USERNAME" "$VERSION"
 
 rm -rf /var/lib/apt/lists/*

images/ruby/.devcontainer/devcontainer.json

@@ -17,7 +17,7 @@
     },
     "ghcr.io/rails/devcontainer/features/ruby": {
       "version": "${localEnv:RUBY_VERSION}"
-    },
+    }
   },
   // Set `remoteUser` to `root` to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
   "remoteUser": "vscode"