Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

vendor/bundle/ruby: cleanup unneeded files #15954

Merged
merged 1 commit into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
54 changes: 54 additions & 0 deletions .github/workflows/vendor-gems.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,60 @@ permissions:
pull-requests: read

jobs:
check-vendor-version:
if: github.event_name == 'pull_request'
runs-on: ubuntu-22.04
steps:
- name: Set up Homebrew
id: set-up-homebrew
uses: Homebrew/actions/setup-homebrew@master
with:
core: false
cask: false
test-bot: false

- name: Install Bundler RubyGems
run: brew install-bundler-gems --groups=all

- name: Get Ruby ABI version
id: ruby-abi
run: echo "version=$(brew ruby -e "puts Gem.ruby_api_version")" >> "${GITHUB_OUTPUT}"

- name: Get gem info
id: gem-info
working-directory: ${{ steps.set-up-homebrew.outputs.gems-path }}/${{ steps.ruby-abi.outputs.version }}/gems
run: |
{
echo "vendor-version=$(cat ../.homebrew_vendor_version)"
echo "ignored<<EOS"
git check-ignore -- *
echo "EOS"
} >> "${GITHUB_OUTPUT}"

- name: Compare to base ref
working-directory: ${{ steps.set-up-homebrew.outputs.gems-path }}/${{ steps.ruby-abi.outputs.version }}
run: |
git checkout "origin/${GITHUB_BASE_REF}"
rm .homebrew_vendor_version
brew install-bundler-gems --groups=all
if [[ "$(cat .homebrew_vendor_version)" == "${{ steps.gem-info.outputs.vendor-version }}" ]]; then
ignored_gems="${{ steps.gem-info.outputs.ignored }}"
while IFS= read -r gem; do
gem_dir="./gems/${gem}"
[[ -d "${gem_dir}" ]] || continue
exit_code=0
git check-ignore --quiet "${gem_dir}" || exit_code=$?
if (( exit_code != 0 )); then
if (( exit_code == 1 )); then
echo "::error::VENDOR_VERSION needs bumping in utils/gems.rb" >&2
else
echo "::error::git check-ignore failed" >&2
fi
exit "${exit_code}"
fi
done <<< "${ignored_gems}"
fi
Comment on lines +47 to +77
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not blocking but might be nice to pull these into dedicated Bash scripts instead at some point.


vendor-gems:
if: >
github.repository_owner == 'Homebrew' && (
Expand Down
221 changes: 35 additions & 186 deletions .gitignore

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion Library/Homebrew/livecheck/livecheck.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
require "livecheck/skip_conditions"
require "livecheck/strategy"
require "addressable"
require "ruby-progressbar"
require "uri"

module Homebrew
Expand Down Expand Up @@ -208,6 +207,7 @@
stderr.puts Formatter.headline("Running checks", color: :blue)
end

require "ruby-progressbar"

Check warning on line 210 in Library/Homebrew/livecheck/livecheck.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/livecheck/livecheck.rb#L210

Added line #L210 was not covered by tests
progress = ProgressBar.create(
total: formulae_and_casks_total,
progress_mark: "#",
Expand Down
2 changes: 2 additions & 0 deletions Library/Homebrew/sorbet/rbi/upstream.rbi
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,5 @@ module Kernel
sig { params(arg0: NilClass).returns(NilClass) }
def set_trace_func(arg0); end
end

class Gem::Security::Exception < Gem::Exception; end
78 changes: 74 additions & 4 deletions Library/Homebrew/utils/gems.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,44 @@
# After updating this, run `brew vendor-gems --update=--bundler`.
HOMEBREW_BUNDLER_VERSION = "2.4.18"

GEM_GROUPS_FILE = (HOMEBREW_LIBRARY_PATH/"vendor/bundle/ruby/.homebrew_gem_groups").freeze
# Bump this whenever a committed vendored gem is later added to gitignore.
# This will trigger it to reinstall properly if `brew install-bundler-gems` needs it.
VENDOR_VERSION = 1
private_constant :VENDOR_VERSION

RUBY_BUNDLE_VENDOR_DIRECTORY = (HOMEBREW_LIBRARY_PATH/"vendor/bundle/ruby").freeze
private_constant :RUBY_BUNDLE_VENDOR_DIRECTORY

# This is tracked across Ruby versions.
GEM_GROUPS_FILE = (RUBY_BUNDLE_VENDOR_DIRECTORY/".homebrew_gem_groups").freeze
private_constant :GEM_GROUPS_FILE

# This is tracked per Ruby version.
VENDOR_VERSION_FILE = (
RUBY_BUNDLE_VENDOR_DIRECTORY/"#{RbConfig::CONFIG["ruby_version"]}/.homebrew_vendor_version"
).freeze
private_constant :VENDOR_VERSION_FILE

module_function

# @api private
def gemfile
File.join(ENV.fetch("HOMEBREW_LIBRARY"), "Homebrew", "Gemfile")
end

# @api private
def bundler_definition
@bundler_definition ||= Bundler::Definition.build(Bundler.default_gemfile, Bundler.default_lockfile, false)

Check warning on line 42 in Library/Homebrew/utils/gems.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/utils/gems.rb#L42

Added line #L42 was not covered by tests
end

# @api private
def valid_gem_groups
install_bundler!
require "bundler"

Bundler.with_unbundled_env do
ENV["BUNDLE_GEMFILE"] = gemfile
groups = Bundler::Definition.build(Bundler.default_gemfile, Bundler.default_lockfile, false).groups
groups = bundler_definition.groups

Check warning on line 52 in Library/Homebrew/utils/gems.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/utils/gems.rb#L52

Added line #L52 was not covered by tests
groups.delete(:default)
groups.map(&:to_s)
end
Expand Down Expand Up @@ -71,7 +91,7 @@
ENV["BUNDLER_NO_OLD_RUBYGEMS_WARNING"] = "1"

# Match where our bundler gems are.
gem_home = "#{HOMEBREW_LIBRARY_PATH}/vendor/bundle/ruby/#{RbConfig::CONFIG["ruby_version"]}"
gem_home = "#{RUBY_BUNDLE_VENDOR_DIRECTORY}/#{RbConfig::CONFIG["ruby_version"]}"
Gem.paths = {
"GEM_HOME" => gem_home,
"GEM_PATH" => gem_home,
Expand Down Expand Up @@ -181,6 +201,14 @@
end
end

def user_vendor_version
@user_vendor_version ||= if VENDOR_VERSION_FILE.exist?

Check warning on line 205 in Library/Homebrew/utils/gems.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/utils/gems.rb#L205

Added line #L205 was not covered by tests
VENDOR_VERSION_FILE.read.to_i
else
0
end
end

def install_bundler_gems!(only_warn_on_failure: false, setup_path: true, groups: [])
old_path = ENV.fetch("PATH", nil)
old_gem_path = ENV.fetch("GEM_PATH", nil)
Expand Down Expand Up @@ -229,7 +257,49 @@
bundle_check_failed = !$CHILD_STATUS.success?

# for some reason sometimes the exit code lies so check the output too.
bundle_installed = if bundle_check_failed || bundle_check_output.include?("Install missing gems")
bundle_install_required = bundle_check_failed || bundle_check_output.include?("Install missing gems")

Check warning on line 260 in Library/Homebrew/utils/gems.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/utils/gems.rb#L260

Added line #L260 was not covered by tests

if user_vendor_version != VENDOR_VERSION
# Check if the install is intact. This is useful if any gems are added to gitignore.
# We intentionally map over everything and then call `any?` so that we remove the spec of each bad gem.
specs = bundler_definition.resolve.materialize(bundler_definition.locked_dependencies)
vendor_reinstall_required = specs.map do |spec|
spec_file = "#{Gem.dir}/specifications/#{spec.full_name}.gemspec"

Check warning on line 267 in Library/Homebrew/utils/gems.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/utils/gems.rb#L266-L267

Added lines #L266 - L267 were not covered by tests
next false unless File.exist?(spec_file)

cache_file = "#{Gem.dir}/cache/#{spec.full_name}.gem"

Check warning on line 270 in Library/Homebrew/utils/gems.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/utils/gems.rb#L270

Added line #L270 was not covered by tests
if File.exist?(cache_file)
require "rubygems/package"
package = Gem::Package.new(cache_file)

Check warning on line 273 in Library/Homebrew/utils/gems.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/utils/gems.rb#L273

Added line #L273 was not covered by tests

package_install_intact = begin
contents = package.contents

Check warning on line 276 in Library/Homebrew/utils/gems.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/utils/gems.rb#L276

Added line #L276 was not covered by tests

# If the gem has contents, ensure we have every file installed it contains.
contents&.all? do |gem_file|
File.exist?("#{Gem.dir}/gems/#{spec.full_name}/#{gem_file}")

Check warning on line 280 in Library/Homebrew/utils/gems.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/utils/gems.rb#L280

Added line #L280 was not covered by tests
end
rescue Gem::Package::Error, Gem::Security::Exception
# Malformed, assume broken
File.unlink(cache_file)
false

Check warning on line 285 in Library/Homebrew/utils/gems.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/utils/gems.rb#L284-L285

Added lines #L284 - L285 were not covered by tests
end

next false if package_install_intact
end

# Mark gem for reinstallation
File.unlink(spec_file)
true

Check warning on line 293 in Library/Homebrew/utils/gems.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/utils/gems.rb#L292-L293

Added lines #L292 - L293 were not covered by tests
end.any?

VENDOR_VERSION_FILE.dirname.mkpath
VENDOR_VERSION_FILE.write(VENDOR_VERSION.to_s)

Check warning on line 297 in Library/Homebrew/utils/gems.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/utils/gems.rb#L296-L297

Added lines #L296 - L297 were not covered by tests

bundle_install_required ||= vendor_reinstall_required

Check warning on line 299 in Library/Homebrew/utils/gems.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/utils/gems.rb#L299

Added line #L299 was not covered by tests
end

bundle_installed = if bundle_install_required

Check warning on line 302 in Library/Homebrew/utils/gems.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/utils/gems.rb#L302

Added line #L302 was not covered by tests
if system bundle, "install"
true
else
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright (c) 2005-2022 David Heinemeier Hansson

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

This file was deleted.

This file was deleted.

This file was deleted.

Loading