feat!: modernise ruby_rbenv cookbook (#354)

* refactor: modernise ruby_rbenv cookbook

- Add frozen_string_literal: true to all Ruby files

- Move test cookbook from test/fixtures/cookbooks/test to test/cookbooks/test

- Fix partial reference from _partial/git to _partial/_git in system_install

- Remove EOL platforms, add current Ubuntu/Debian/AlmaLinux/Fedora platforms

- Add default kitchen suite exercising primary system install workflow

- Align CI matrix with kitchen.yml suites and platforms

- Update Ruby versions in test recipes to 3.3.10, 3.4.9, 4.0.1

- Simplify package_deps.rb removing EOL Debian version branches

- Add ChefSpec tests for all 8 resources and helper modules

- Add default InSpec suite with controls for system install workflow

- Update Ruby versions in existing InSpec integration tests

- Move documentation to flat documentation/ structure

- Update README with current platform list, doc paths, and test cookbook path

- Add LIMITATIONS.md documenting install method, build deps, platform/arch notes

- Remove stale test/unit specs

* fix: add libyaml-dev/libyaml-devel to Ruby build dependencies

- Ruby 3.4+ requires libyaml for the psych extension

- Added libyaml-dev for Debian, libyaml-devel for RHEL/Fedora/Amazon/SUSE

- Updated specs to match new dependency lists

* fix: make rbenv_ruby uninstall guard idempotent

- Skip uninstall when ruby version is already absent

- Skip install when ruby version is already present

- Stub File.directory? in spec for uninstall context

* fix: resolve CI and idempotency issues in test configuration

- Pass version: latest to actionshub/chef-install@6.0.0 (default 21.6.497 has checksum mismatch)

- Disable idempotency for gem and ruby_uninstall suites (install-then-remove is inherently non-convergent)

- Remove rbenv_rehash from default test recipe (bash resource always reports updated)

* fix: use -d instead of -s for directory tests in rbenv.sh template

- The -s flag tests 'file exists and has size > 0' which is unreliable

  for directories on overlayfs (Docker/CI environments)

- Use -d to properly test directory existence

* fix: add apt_update to test::dokken for Debian-family platforms

- Dokken containers have stale apt cache causing package 404 errors

- Refresh apt cache before installing git and other prerequisites

* fix: resolve CI regressions for profile script, CRB repos, and test infra

- Fix rbenv.sh.erb: use RBENV_ROOT env var, test .rbenv dir instead of .rbenv/bin, guard nil global_prefix with -n test

- Fix test::dokken: enable native CRB/PowerTools repos instead of AlmaLinux-specific yum_alma resources

- Fix test::dokken: set explicit home + manage_home for vagrant user

- Fix system_install test: add include_recipe test::dokken for apt_update on Debian

- Remove yum-almalinux test cookbook dependency

Signed-off-by: Dan Webb <dan.webb@damacus.io>

* fix: make rbenv profile script robust against rbenv init failures

- Add shims dir to PATH so Ruby commands work even if rbenv init fails

- Suppress rbenv init stderr and exit code to prevent source failures

- Add diagnostic InSpec control to capture environment state on CI

* fix: add sudo + NOPASSWD for vagrant in Dokken containers

RHEL-family Dokken containers lack PAM configuration for non-root users,

causing 'PAM account management error' when Chef or InSpec runs sudo -u vagrant.

Install sudo package and add /etc/sudoers.d/vagrant with NOPASSWD:ALL.

* fix: replace sudo with runuser in gem binary helper

sudo fails in Dokken containers on RHEL-family because PAM cannot

perform account management for users without /etc/shadow entries.

runuser does not use PAM authentication, making it reliable for

non-interactive user switching when already running as root.

Also set vagrant password via chpasswd in test::dokken so InSpec

verification commands using sudo work correctly.

* fix: use runuser in user install integration checks

---------

Signed-off-by: Dan Webb <dan.webb@damacus.io>

Author: damacus

.github/workflows/ci.yml

@@ -22,20 +22,19 @@ jobs:
     strategy:
       matrix:
         os:
-          - "almalinux-8"
-          - "almalinux-9"
           - "amazonlinux-2023"
-          - "centos-7"
-          - "centos-stream-8"
+          - "fedora-latest"
+          - "opensuse-leap-15"
+          - "almalinux-9"
+          - "almalinux-10"
           - "centos-stream-9"
-          - "debian-10"
-          - "debian-11"
+          - "centos-stream-10"
           - "debian-12"
-          - "fedora-latest"
-          - "ubuntu-1804"
-          - "ubuntu-2004"
+          - "debian-13"
           - "ubuntu-2204"
+          - "ubuntu-2404"
         suite:
+          - "default"
           - "gem"
           - "global"
           - "ruby-uninstall"
@@ -48,6 +47,8 @@ jobs:
         uses: actions/checkout@v6
       - name: Install Chef
         uses: actionshub/chef-install@6.0.0
+        with:
+          version: latest
       - name: Dokken
         uses: actionshub/test-kitchen@3.0.0
         env:

.rubocop.yml

@@ -1,4 +1,2 @@
----
-AllCops:
-  Exclude:
-    - 'Dangerfile'
+require:
+  - cookstyle

Berksfile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 source 'https://supermarket.chef.io'
 
 metadata
 
 group :integration do
-  cookbook 'test', path: 'test/fixtures/cookbooks/test'
+  cookbook 'test', path: 'test/cookbooks/test'
 end

LIMITATIONS.md

@@ -0,0 +1,39 @@
+# Limitations
+
+## Installation Method
+
+rbenv is installed from source via `git clone` — there are no binary packages.
+Ruby versions are compiled from source using the [ruby-build](https://github.com/rbenv/ruby-build) plugin.
+
+## Package Availability
+
+This cookbook does **not** install packages for rbenv itself. It clones the rbenv
+git repository and compiles Ruby from source. Build dependencies are installed
+per platform family.
+
+## Build Dependencies
+
+| Platform Family        | Packages                                                                                                                        |
+|------------------------|---------------------------------------------------------------------------------------------------------------------------------|
+| Debian                 | gcc, autoconf, bison, build-essential, libssl-dev, libreadline6-dev, zlib1g-dev, libncurses5-dev, libffi-dev, libgdbm-dev, make |
+| RHEL / Fedora / Amazon | gcc, bzip2, openssl-devel, libffi-devel, readline-devel, zlib-devel, gdbm-devel, ncurses-devel, make                            |
+| SUSE                   | gcc, make, automake, gdbm-devel, ncurses-devel, readline-devel, zlib-devel, libopenssl-devel, bzip2                             |
+| macOS                  | openssl, makedepend, pkg-config, libffi                                                                                         |
+
+## Architecture Limitations
+
+- Ruby compiles natively on both amd64 and arm64
+- No architecture-specific restrictions from rbenv itself
+- Individual Ruby versions may have architecture-specific build issues
+
+## Platform Notes
+
+- **macOS**: Listed in `metadata.rb` but not tested in CI. System-wide installation
+  requires manual `/etc/profile.d` setup as macOS does not support this idiom natively.
+- **FreeBSD**: Partial support in helper code but not listed in `metadata.rb` or tested.
+
+## Known Issues
+
+- Some Chef versions (>= 16 and < 16.4.41) have a bug in the `git` resource causing
+  failures. Use Chef >= 16.4.41 or later.
+- JRuby installations require Java to be pre-installed (not managed by this cookbook).

README.md

@@ -17,7 +17,7 @@ This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of
 
 ### Chef
 
-This cookbook requires Chef 13.0+.
+This cookbook requires Chef 16.0+.
 
 **NOTE:** Some Chef versions (>= 16 and < 16.4.41) have a bug in the git resource causing some failures (see [#289](https://github.com/sous-chefs/ruby_rbenv/issues/289)). If you experience any troubles please try a more recent version of Chef 16.
 
@@ -26,23 +26,23 @@ This cookbook requires Chef 13.0+.
 - Debian derivatives
 - Fedora
 - macOS (not currently tested)
-- RHEL derivatives (RHEL, CentOS, Amazon Linux, Oracle, Scientific Linux)
-- openSUSE and openSUSE leap
+- RHEL derivatives (RHEL, AlmaLinux, Rocky Linux, Amazon Linux, Oracle Linux)
+- openSUSE Leap
 
 ## Resources
 
-- [rbenv_gem](documentation/resources/rbenv_gem.md)
-- [rbenv_global](documentation/resources/rbenv_global.md)
-- [rbenv_plugin](documentation/resources/rbenv_plugin.md)
-- [rbenv_rehash](documentation/resources/rbenv_rehash.md)
-- [rbenv_ruby](documentation/resources/rbenv_ruby.md)
-- [rbenv_script](documentation/resources/rbenv_script.md)
-- [rbenv_system_install](documentation/resources/rbenv_system_install.md)
-- [rbenv_user_install](documentation/resources/rbenv_user_install.md)
+- [rbenv_gem](documentation/rbenv_gem.md)
+- [rbenv_global](documentation/rbenv_global.md)
+- [rbenv_plugin](documentation/rbenv_plugin.md)
+- [rbenv_rehash](documentation/rbenv_rehash.md)
+- [rbenv_ruby](documentation/rbenv_ruby.md)
+- [rbenv_script](documentation/rbenv_script.md)
+- [rbenv_system_install](documentation/rbenv_system_install.md)
+- [rbenv_user_install](documentation/rbenv_user_install.md)
 
 ## Usage
 
-Example installations are provided in `test/fixtures/cookbooks/test/recipes/`.
+Example installations are provided in `test/cookbooks/test/recipes/`.
 
 A `rbenv_system_install` or `rbenv_user_install` is required to be set so that rbenv knows which version you want to use, and is installed on the system.
 

documentation/resources/rbenv_gem.md documentation/rbenv_gem.mddocumentation/resources/rbenv_gem.md renamed to documentation/rbenv_gem.md

@@ -5,7 +5,7 @@ Installs a given Ruby version to the system or user location.
 ## Properties
 
 | Name               | Type            | Default                                   | Description                             |
-| ------------------ | --------------- | ----------------------------------------- | --------------------------------------- |
+|--------------------|-----------------|-------------------------------------------|-----------------------------------------|
 | version            | `String`        |                                           | Ruby version to install.                |
 | environment        | `Hash`          |                                           | Environment to pass to the Ruby script. |
 | rbenv_action       | `String`        | `install`                                 | Action to pass to rbenv.                |
@@ -17,11 +17,11 @@ Installs a given Ruby version to the system or user location.
 ## Examples
 
 ```ruby
-rbenv_ruby '2.5.1' do
+rbenv_ruby '3.4.9' do
   user 'vagrant'
 end
 ```
 
 ```ruby
-rbenv_ruby '2.5.1'
+rbenv_ruby '3.4.9'
 ```