Use XDG directory for cache #5787
Conversation
Falls back to ~/.bundle/cache if the directory exists.
|
Thanks for opening a PR and helping make Bundler better 🎉. This PR is missing tests, we will need some before we considering merging this. |
|
Added tests for Still not that experienced with rspec, so any improvements are welcome. |
| end | ||
|
|
||
| before(:each) do | ||
| ENV.delete("XDG_CACHE_HOME") |
There was a problem hiding this comment.
this shouldn't be necessary, the spec helper already resets ENV before each test
|
@valeth can you provide your reasoning for why this PR is an improvement? Today, all possible state that Bundler could write fall either into an application at Why would using XDG directories to scatter Bundler-created files across many directories be an improvement? |
|
ping @valeth |
|
@indirect It would also make backing up configurations easier (if this would be expanded to also handle the configuration file), because you only need to backup one directory to save all your configuration. Git uses a similar approach, they use the file at |
|
@valeth I can understand the argument, but I don't think I'm convinced by it. Very few popular open-source utilities support XDG for either cache or config. Very few users set I'm open to the possibility of allowing the |
|
Making the bundle path configurable would be good enough for me, as long as I can stash the files somewhere that isn't my home directory I'm fine with it. |
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.
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)
What was the end-user problem that led to this PR?
Bundler was storing user cache in the user's home directory.
Issue: #4333
What is your fix for the problem, implemented in this PR?
Store cache in XDG_CACHE_HOME if ~/.bundle/cache does not exist.
Otherwise continue to use the legacy directory.