Use Bundler to manage vendor directory #4895
Conversation
ghost
assigned 
| @@ -1,4 +1,3 @@ | |||
| # Taken from https://github.com/marcandre/backports/blob/v3.8.0/lib/backports/2.4.0/string/match.rb | |||
There was a problem hiding this comment.
This change is not present in the upstream file so was removed by Bundler.
| require_relative 'plist/generator' | ||
| require_relative 'plist/parser' | ||
| require_relative 'plist/version' | ||
| require 'plist/generator' |
There was a problem hiding this comment.
These changes are not present in the upstream file so were removed by Bundler.
| @@ -5,3 +5,5 @@ | |||
| unless $LOAD_PATH.include?(HOMEBREW_LIBRARY_PATH.to_s) | |||
| $LOAD_PATH.push(HOMEBREW_LIBRARY_PATH.to_s) | |||
| end | |||
|
|
|||
| require "vendor/bundle-standalone/bundler/setup" | |||
There was a problem hiding this comment.
Check below if interested; this file is generated by bundler and sets up the load path for all the relevant gems. This means they can live in versioned directories but we never need to manually update the names of those directories.
| !**/vendor/bundle-standalone/ruby/*/gems/*/lib | ||
|
|
||
| # Ignore backports gem (we don't need all files) | ||
| **/vendor/bundle-standalone/ruby/*/gems/backports-*/lib |
There was a problem hiding this comment.
This requires git add -f to add additional backports files but I think it's the best approach to avoid making this .gitignore very messy and backports-specific.
| @@ -1,5 +1,5 @@ | |||
| # Contains backports from newer versions of Ruby | |||
There was a problem hiding this comment.
This comment is perhaps no longer needed as it's a bit more obvious from the require what's going on here.
Rather than having to manually keep track of what version each thing in here is and copy files around by hand on update let's use Bundler's standalone mode and careful use of `.gitignore` to help us do it. This means a `bundle update --standalone` will allow us to update all gems in vendor. We could consider vendoring other gems this way in future but I'd suggest only doing this for gems with no dependencies or at least gems with no native extensions. The only gem this applies to that we currently use is `ruby-prof` and I'm not convinced it's widely used enough to warrant vendoring for everyone. Perhaps that's another criteria: it should be functionality that's used by non-developer commands and/or normal Homebrew usage.
|
I think it would be nicer to have either all in |
can't have two
The standard location for them tends to be |
|
Let's try shipping this as-is and iterating on it further. Things like this have gone 💥 in the past so I'm merging the simplest thing we can now so it can be reverted if need be later today. |
Alternative title: how many
Gemfiles does Homebrew need? Just one more...Rather than having to manually keep track of what version each thing in here is and copy files around by hand on update let's use Bundler's standalone mode and careful use of
.gitignoreto help us do it.This means a
bundle update --standalonewill allow us to update all gems in vendor.We could consider vendoring other gems this way in future but I'd suggest only doing this for gems with no dependencies or at least gems with no native extensions. The only gem this applies to that we
currently use is
ruby-profand I'm not convinced it's widely used enough to warrant vendoring for everyone. Perhaps that's another criteria: it should be functionality that's used by non-developer commands and/or normal Homebrew usage.Once this is merged we can look at updating our current gems in a follow-up PR.
This approach should also make it much easier to selectively include other backports (#4505) or parts of e.g. ActiveSupport.
We previously discussed a
brew vendor-gemcommand in #4288. If desired,brew vendor-gemscould run thebundle install --standalonerequired here in the correct directory?brew stylewith your changes locally?brew testswith your changes locally?