Allow user to override ~/.bundle with environment variables #6024

gwerbin · 2017-09-11T16:13:23Z

What was the end-user problem that led to this PR?

As in #4333, users wanted a way to make Bundler respect the XDG specification.

What was your diagnosis of the problem?

The directory ~/.bundle was hard-coded and could not be configured.

What is your fix for the problem, implemented in this PR?

Allow users to configure ~/.bundle and its relevant sub-directories by setting environment variables. The environment variables and their fallbacks are as follows:

variable	fallback if unset
`BUNDLE_USER_HOME`	`$HOME/.bundle`
`BUNDLE_USER_CACHE`	`$BUNDLE_USER_HOME/cache`
`BUNDLE_USER_CONFIG`	`$BUNDLE_USER_HOME/config`
`BUNDLE_USER_PLUGIN`	`$BUNDLE_USER_HOME/plugin`

Why did you choose this fix out of the possible options?

Unlike #5787, This solution is not specific to the XDG specification. Users have all kinds of setups, and this is a very general system for allowing them to configure their development machines however they need. It tries to keep all files created by Bundler in the same place (as per #5787 (comment)), but allows the user to override that convention if they really want to and they know what they are doing.

If they want to use XDG for everything, they can do it by explicitly setting the BUNDLE_USER_* variables to the equivalent XDG_DATA_*. If they just want to get .bundle out of their home directory, they can do it by setting BUNDLE_USER_HOME and don't have to mess with the more specific env variables if they don't want to.

To me, this solution strikes the right balance between "fine-grained control for power users" and "simple, sane defaults for everyone else".

Please let me know if my tests can be improved. My only Ruby experience so far has been writing Homebrew formulas and configuring Jekyll, so I'm sure I have a lot to learn.

Recognize new environment variables, with the following fallbacks: $BUNDLE_USER_HOME -> $HOME/.bundle $BUNDLE_USER_CACHE -> $BUNDLE_USER_HOME/cache $BUNDLE_USER_CONFIG -> $BUNDLE_USER_HOME/config $BUNDLE_USER_PLUGIN -> $BUNDLE_USER_HOME/plugin TODOs: - Error handling in Bundler.user_bundle_path when an invalid option is passed - Add tests (see rubygems@47fbe99) - Draft PR with reference to GitHub issue numbers (not linked here as per contributing guidelines) + Issue: 4333 + Pull request: 5787

Mostly unmodified tests from PR 5787 (not linked here to respect contribution guidelines).

ghost · 2017-09-11T16:13:42Z

Thanks for opening a pull request and helping make Bundler better! Someone from the Bundler team will take a look at your pull request shortly and leave any feedback. Please make sure that your pull request has tests for any changes or added functionality.

We use Travis CI to test and make sure your change works functionally and uses acceptable conventions, you can review the current progress of Travis CI in the PR status window below.

If you have any questions or concerns that you wish to ask, feel free to leave a comment in this PR or join our #bundler channel on Slack.

For more information about contributing to the Bundler project feel free to review our CONTRIBUTING guide

segiddins

This seems reasonable to me. Thoughts @colby-swandale @indirect ?

segiddins · 2017-09-11T17:50:18Z

lib/bundler.rb

@@ -193,8 +193,26 @@ def tmp_home_path(login, warning)
      raise e.exception("#{warning}\nBundler also failed to create a temporary home directory at `#{path}':\n#{e}")
    end

-    def user_bundle_path
-      Pathname.new(user_home).join(".bundle")
+    def user_bundle_path(dir="home")


space around =

colby-swandale · 2017-09-18T04:26:35Z

I have a few issues with this PR, mainly it's making things relating to the bundle path pretty confusing but this can be addressed in a later PR.

@bundlerbot r+

bundlerbot · 2017-09-18T04:26:35Z

📌 Commit b3108fa has been approved by colby-swandale

bundlerbot · 2017-09-18T04:26:47Z

⌛ Testing commit b3108fa with merge e6cc7a2...

Allow user to override ~/.bundle with environment variables ### What was the end-user problem that led to this PR? As in #4333, users wanted a way to make Bundler respect the XDG specification. ### What was your diagnosis of the problem? The directory `~/.bundle` was hard-coded and could not be configured. ### What is your fix for the problem, implemented in this PR? Allow users to configure `~/.bundle` and its relevant sub-directories by setting environment variables. The environment variables and their fallbacks are as follows: | variable | fallback if unset | |---|---| | `BUNDLE_USER_HOME` | `$HOME/.bundle` | | `BUNDLE_USER_CACHE` | `$BUNDLE_USER_HOME/cache` | | `BUNDLE_USER_CONFIG` | `$BUNDLE_USER_HOME/config` | | `BUNDLE_USER_PLUGIN` | `$BUNDLE_USER_HOME/plugin` | ### Why did you choose this fix out of the possible options? Unlike #5787, This solution is not specific to the XDG specification. Users have all kinds of setups, and this is a very general system for allowing them to configure their development machines however they need. It tries to keep all files created by Bundler in the same place (as per #5787 (comment)), but allows the user to override that convention _if they really want to and they know what they are doing_. If they want to use XDG for everything, they can do it by explicitly setting the `BUNDLE_USER_*` variables to the equivalent `XDG_DATA_*`. If they just want to get `.bundle` out of their home directory, they can do it by setting `BUNDLE_USER_HOME` and don't have to mess with the more specific env variables if they don't want to. To me, this solution strikes the right balance between "fine-grained control for power users" and "simple, sane defaults for everyone else". Please let me know if my tests can be improved. My only Ruby experience so far has been writing Homebrew formulas and configuring Jekyll, so I'm sure I have a lot to learn.

bundlerbot · 2017-09-18T04:50:09Z

☀️ Test successful - status-travis
Approved by: colby-swandale
Pushing e6cc7a2 to master...

gwerbin · 2017-09-18T12:34:57Z

@colby-swandale what issues do you have in mind? Obviously I'm happy to have my PR merged ("it works for me"), but I don't want to be responsible for any design debt in the future.

jasonkarns · 2018-05-08T17:45:38Z

@gwerbin The discussion above (mainly the env var fallbacks table) seemed to imply that the vars all indicate directories.

Allow users to configure ~/.bundle and its relevant sub-directories by setting environment variables.

The code seems to indicate that BUNDLE_USER_CONFIG should point to a file, not a directory.

https://github.com/bundler/bundler/blob/23dfadcd8d561d48e89c7287cbbdd816e0a10ab8/lib/bundler/settings.rb#L392-L402

Is this the case? Can this be documented somewhere?

gwerbin · 2018-05-08T18:59:25Z

@jasonkarns the relevant diff from my patch corresponding to that snippet is here: e6cc7a2#diff-75219bd6bc0defc0e7f4ba322d92f950

As you can see, I didn't change anything that was previously stored under ~/.bundle. My patch just allows the user to move the contents around.

It would have been more correct if I had written:

Allow users to relocate ~/.bundle, or specific contents thereof, by setting environment variables.

In the documentation it's implied but not explicitly stated that config is a file. So maybe the documentation could be updated to reflect that, but my patch didn't affect anything along those lines.

jasonkarns · 2018-05-08T19:43:49Z

@gwerbin cool. Since this feature was significantly driven by (but not solely by) the XDG request, I was easily mislead by the directories vs files. Was having an issue with BUNDLE_USER_CONFIG not working when set to a directory: $XDG_CONFIG_HOME/bundler. I think the added confusion was because BUNDLE_CONFIG already existed as an env var. Since that var already existed, it didn't make sense to me why BUNDLE_USER_CONFIG would be created with identical use/value. (Therefore I assumed that BUNDLE_USER_CONFIG would be a directory which would contain a file. ie BUNDLE_CONFIG essentially being the same as: $BUNDLE_USER_CONFIG/config.yml or something.

Anyway, thanks for the clarification.

jasonkarns · 2018-05-08T21:50:16Z

Welp, I've found my problem!!! This apparently hasn't been released yet? I figured that since it was merged in September, and both 1.16.0 and 1.16.1 were released in October, December respectively, that this would have been included.

Does anyone have any rough ideas on when this might land?

soc · 2018-05-09T01:16:23Z

@jasonkarns I'm pretty confused about the whole state of this, too. I also checked this a while ago and assumed the change wasn't shipped because it failed to fix the problem people reported in #4333, and devs wanted to rework this before officially releasing it.

segiddins · 2018-05-09T02:43:17Z

We cut the 1.16 branch before this was merged, and have been focusing on getting the 2.0 train out the door, and tend to not backport new features after a branch cut

soc · 2018-05-09T03:40:13Z

@segiddins Is there a chance to fix #4333 before 2.0 is released?

segiddins · 2018-05-09T04:59:15Z

Since its a feature rather than a bug fix, it's likely it wont ship before 2.0

soc · 2018-05-09T16:11:46Z

Sorry, my comment could be interpreted two ways. What I meant is whether #4333 will be actually fixed in 2.0.

Allow user to override ~/.bundle with environment variables ### What was the end-user problem that led to this PR? As in #4333, users wanted a way to make Bundler respect the XDG specification. ### What was your diagnosis of the problem? The directory `~/.bundle` was hard-coded and could not be configured. ### What is your fix for the problem, implemented in this PR? Allow users to configure `~/.bundle` and its relevant sub-directories by setting environment variables. The environment variables and their fallbacks are as follows: | variable | fallback if unset | |---|---| | `BUNDLE_USER_HOME` | `$HOME/.bundle` | | `BUNDLE_USER_CACHE` | `$BUNDLE_USER_HOME/cache` | | `BUNDLE_USER_CONFIG` | `$BUNDLE_USER_HOME/config` | | `BUNDLE_USER_PLUGIN` | `$BUNDLE_USER_HOME/plugin` | ### Why did you choose this fix out of the possible options? Unlike #5787, This solution is not specific to the XDG specification. Users have all kinds of setups, and this is a very general system for allowing them to configure their development machines however they need. It tries to keep all files created by Bundler in the same place (as per #5787 (comment)), but allows the user to override that convention _if they really want to and they know what they are doing_. If they want to use XDG for everything, they can do it by explicitly setting the `BUNDLE_USER_*` variables to the equivalent `XDG_DATA_*`. If they just want to get `.bundle` out of their home directory, they can do it by setting `BUNDLE_USER_HOME` and don't have to mess with the more specific env variables if they don't want to. To me, this solution strikes the right balance between "fine-grained control for power users" and "simple, sane defaults for everyone else". Please let me know if my tests can be improved. My only Ruby experience so far has been writing Homebrew formulas and configuring Jekyll, so I'm sure I have a lot to learn. (cherry picked from commit e6cc7a2)

6754: Add docs for configuring bundler folders through ENV vars r=colby-swandale a=colby-swandale ### Overview This PR is just adding documentation for the feature in #6024. Co-authored-by: Colby Swandale <me@colby.fyi>

6754: Add docs for configuring bundler folders through ENV vars r=colby-swandale a=colby-swandale ### Overview This PR is just adding documentation for the feature in #6024. Co-authored-by: Colby Swandale <me@colby.fyi> (cherry picked from commit 97a0430)

* 1-17-stable: (38 commits) Version 1.17.0 with changelog Merge #6754 Version 1.17.0.pre.2 with changelog fix failing bundle remove specs Still document the `--force` option scope specs testing bundler 2 deprecations to bundler 1 only Merge #6718 Merge #6707 Merge #6702 Merge #6316 Auto merge of #6447 - agrim123:agr-update-error-message, r=segiddins Auto merge of #6513 - agrim123:agr-bundler-remove, r=indirect Auto merge of #6318 - jhawthorn:fix_incorrect_test_in_requires_sudo, r=segiddins Auto merge of #6450 - bundler:segiddins/bundle-binstubs-all, r=colby-swandale Auto merge of #6024 - gwerbin:custom-user-bundle-dir, r=colby-swandale Version 1.17.0.pre.1 with changelog Auto merge of #5964 - bundler:colby/deprecate-viz-command, r=segiddins Auto merge of #5986 - bundler:seg-jobs-count, r=indirect Auto merge of #5995 - bundler:seg-gvp-major, r=indirect Auto merge of #5803 - igorbozato:path_relative_to_pwd, r=indirect ...

6885: Don't check for the existence of a writable home directory if BUNDLE_USER_HOME is set r=deivid-rodriguez a=jturkel #6024 added support for specifying an alternate bundler home directory via the `BUNDLE_USER_HOME` environment variable. Unfortunately bundler still checks for a writable user home directory even if the `BUNDLE_USER_HOME` override is specified resulting in warnings like this: ``` `/home/appuser` is not a directory. Bundler will use `/tmp/bundler/home/unknown' as your home directory temporarily. ``` The fix for this problem is to only evaluate bundler path fallbacks if environment variable overrides are not specified. Co-authored-by: Joel Turkel <jturkel@salsify.com>

Greg Werbin added 4 commits September 10, 2017 20:49

Use tests from the old commit

d378a81

Mostly unmodified tests from PR 5787 (not linked here to respect contribution guidelines).

Remove unnecessary method

71f13f9

Make tests green

bea2797

segiddins reviewed Sep 11, 2017

View reviewed changes

Greg Werbin added 2 commits September 11, 2017 15:31

Conform to code style

abb8f97

Conform to code style

b3108fa

bundlerbot merged commit b3108fa into rubygems:master Sep 18, 2017

colby-swandale mentioned this pull request Sep 18, 2017

Respect XDG basedir spec for global configuration file #4333

Closed

colby-swandale added this to the 1.17.0 milestone Oct 2, 2018

colby-swandale mentioned this pull request Oct 15, 2018

BUNDLER_HOME env var #5372

Closed

colby-swandale mentioned this pull request Oct 23, 2018

Add docs for configuring bundler folders through ENV vars #6754

Merged

colby-swandale mentioned this pull request Dec 13, 2018

Do not check the entire user_home for writing #5708

Closed

jturkel mentioned this pull request Jan 7, 2019

Don't check for the existence of a writable home directory if BUNDLE_USER_HOME is set #6885

Merged

gwerbin mentioned this pull request Feb 24, 2021

Thought on XDG convention tree-sitter/tree-sitter#628

Closed

lordzsolt mentioned this pull request Mar 4, 2023

~/.swiftpm config, cache to follow the XDG base dir spec apple/swift-package-manager#6204

Closed

machupicchubeta mentioned this pull request Oct 29, 2023

Move apps config and/or data directory under XDG Base Directory machupicchubeta/dotfiles#451

Merged

loukwn mentioned this pull request Jan 13, 2024

Add Support for .bundle b3nj5m1n/xdg-ninja#346

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow user to override ~/.bundle with environment variables #6024

Allow user to override ~/.bundle with environment variables #6024

gwerbin commented Sep 11, 2017 •

edited

ghost commented Sep 11, 2017

segiddins left a comment

segiddins Sep 11, 2017

colby-swandale commented Sep 18, 2017

bundlerbot commented Sep 18, 2017

bundlerbot commented Sep 18, 2017

bundlerbot commented Sep 18, 2017

gwerbin commented Sep 18, 2017

jasonkarns commented May 8, 2018

gwerbin commented May 8, 2018 •

edited

jasonkarns commented May 8, 2018

jasonkarns commented May 8, 2018

soc commented May 9, 2018

segiddins commented May 9, 2018

soc commented May 9, 2018

segiddins commented May 9, 2018

soc commented May 9, 2018 •

edited

Allow user to override ~/.bundle with environment variables #6024

Allow user to override ~/.bundle with environment variables #6024

Conversation

gwerbin commented Sep 11, 2017 • edited

What was the end-user problem that led to this PR?

What was your diagnosis of the problem?

What is your fix for the problem, implemented in this PR?

Why did you choose this fix out of the possible options?

ghost commented Sep 11, 2017

segiddins left a comment

Choose a reason for hiding this comment

segiddins Sep 11, 2017

Choose a reason for hiding this comment

colby-swandale commented Sep 18, 2017

bundlerbot commented Sep 18, 2017

bundlerbot commented Sep 18, 2017

bundlerbot commented Sep 18, 2017

gwerbin commented Sep 18, 2017

jasonkarns commented May 8, 2018

gwerbin commented May 8, 2018 • edited

jasonkarns commented May 8, 2018

jasonkarns commented May 8, 2018

soc commented May 9, 2018

segiddins commented May 9, 2018

soc commented May 9, 2018

segiddins commented May 9, 2018

soc commented May 9, 2018 • edited

gwerbin commented Sep 11, 2017 •

edited

gwerbin commented May 8, 2018 •

edited

soc commented May 9, 2018 •

edited