[jrubyscripting] Set .bundle directory to $USERDATA/cache/automation/ruby/.bundle

[jimtng]

set BUNDLE_USER_HOME=$USERDATA/cache/automation/ruby/.bundle
set BUNDLE_USER_CONFIG=<Gemfile's directory>/.bundle/config (by default $CONF/automation/ruby/.bundle/config)

Resolve #19489

openhab> jrubyscripting bundle config                                                                                               
Settings are listed in order of priority. The top value will be used.
gemfile
Set via BUNDLE_GEMFILE: "/openhab/conf/automation/ruby/Gemfile"

user_config
Set via BUNDLE_USER_CONFIG: "/openhab/conf/automation/ruby/.bundle/config"

user_home
Set via BUNDLE_USER_HOME: "/openhab/userdata/cache/automation/ruby/.bundle"


openhab> jrubyscripting bundle config get clean 
Settings for `clean` in order of priority. The top value will be used
You have not configured a value for `clean`
openhab> jrubyscripting bundle config set clean true
openhab> jrubyscripting bundle config get clean
Settings for `clean` in order of priority. The top value will be used
Set for your local app (/openhab/conf/automation/ruby/.bundle/config): true
Set for the current user (/openhab/conf/automation/ruby/.bundle/config): true

root@da1c4ae2491c:/openhab# cd conf/automation/ruby/.bundle/
root@da1c4ae2491c:/openhab/conf/automation/ruby/.bundle# ls
config
root@da1c4ae2491c:/openhab/conf/automation/ruby/.bundle# cat config 
---
BUNDLE_CLEAN: "true"

[jimtng]

If there's a need to use and retain the .bundle/config file, we can add a separate path in the future.

[jimtng]

We could:

• Make it configurable?
• Put it as a sibling of the .gem directory instead of the userdata/cache ?

[jimtng]

Added BUNDLE_USER_CONFIG - updated the OP

[jimtng]

Hmm, the .bundle directory is still initially created inside ~openhab/

[jimtng]

Hmm, the .bundle directory is still initially created inside ~openhab/

This is caused by the gemfile / inline bundler. It doesn't honour BUNDLE_USER_HOME nor BUNDLE_APP_CONFIG env vars.

[jimtng]

I haven't found a way to make the inline bundler to use the custom .bundle directory. I have tried setting BUNDLE_USER_HOME and BUNDLE_APP_CONFIG as system property but that didn't work either.

I haven't delved deep enough in the inline bundler code to figure out how to monkey patch it either.

[jimtng]

Overriding Gem.@user_home works.

If this approach is chosen, we'll need to add the same line in the helper library, so that when user used the inline bundler, it won't end up in ~/.bundle again.

[Copilot]

Pull Request Overview

This PR configures Ruby Bundler's user home and config directories to use openHAB-specific paths instead of the default system locations. This ensures Bundler's cache and configuration files are stored in a controlled location within the openHAB data structure.

• Introduces BUNDLE_USER_HOME constant pointing to the cache directory
• Extracts directory creation logic into a reusable ensureDirectoryExists method
• Sets BUNDLE_USER_HOME and BUNDLE_USER_CONFIG environment variables for Ruby scripts
• Applies the Bundler user home override in all gem management operations

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[jimtng]

Moving the comment here for easier future reference:

it seems that ENV inside Gem / Bundler have been reset (sanitized?), so our custom BUNDLE_USER_HOME is no longer there.

Whilst we can return a static string here, we won't be able to do the same trick in the helper library. Setting this aside, it seems that the ENV sanitization is the cause of the fallback into user_home in the first place.

So if we can figure out why the ENV gets sanitized and maybe prevent it, then we won't even need to touch/tinker with user_home.

#gemfile calls Bundler.unbundle_env! which resets / removes the custom BUNDLE_USER_HOME.

[jimtng]

Overriding by prepending seems to do the trick here. We can do the same in the helper library - but only when gemfile is called.