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

cleaner: rewrite pkg-config file Cellar paths and keg-only #18229

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions Library/Homebrew/cleaner.rb
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@
observe_file_removal info_dir_file
end

# TODO: rewrite_config_scripts
rewrite_pkgconfig
rewrite_shebangs
clean_python_metadata

Expand Down Expand Up @@ -153,6 +155,42 @@
end
end

sig { void }
def rewrite_pkgconfig
basepath = @formula.prefix.realpath
pc_files = %w[lib share].flat_map do |subdir|
next [] unless (pc_dir = basepath/subdir/"pkgconfig").exist?
next [] if @formula.skip_clean?(basepath/subdir) || @formula.skip_clean?(pc_dir)

pc_dir.glob("*.pc").reject { |pc_file| @formula.skip_clean?(pc_file) }

Check warning on line 165 in Library/Homebrew/cleaner.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/cleaner.rb#L165

Added line #L165 was not covered by tests
end
return if pc_files.empty?

keg_only_pc_files = @formula.deps
.reject { |d| d.build? || d.test? }

Check warning on line 170 in Library/Homebrew/cleaner.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/cleaner.rb#L169-L170

Added lines #L169 - L170 were not covered by tests
.map(&:to_formula)
.select(&:keg_only?)
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps controversial idea: I think this could be usefully done for all formulae, not just keg-only. We've debated for a while about whether we should try to support formulae when brew unlinked and, generally, I think we should.

.flat_map { |f| f.prefix.glob("{lib,share}/pkgconfig/*.pc") }
.to_h { |pc_file| [pc_file.basename(".pc").to_s, pc_file.to_s] }
keg_only_modules_pattern = keg_only_pc_files.keys.map { |mod| Regexp.escape(mod) }.join("|")

Check warning on line 175 in Library/Homebrew/cleaner.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/cleaner.rb#L173-L175

Added lines #L173 - L175 were not covered by tests

pc_files.each do |pc_file|
any_modification = T.let(false, T::Boolean)
lines = pc_file.each_line.map do |line|
any_modification ||= line.gsub!(@formula.prefix.realpath.to_s, @formula.opt_prefix.to_s).present?

Check warning on line 180 in Library/Homebrew/cleaner.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/cleaner.rb#L177-L180

Added lines #L177 - L180 were not covered by tests
Copy link
Member Author

Choose a reason for hiding this comment

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

One thing is that this doesn't handle multiple copies of formula in Cellar. I guess the more accurate way would be to handle this during link/unlink but that makes logic a bit more complex than always using opt path.

Copy link
Member

Choose a reason for hiding this comment

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

I think it's fine to not handle multiple formulae in Cellar.

next line if keg_only_pc_files.empty? || !line.start_with?(/Requires(?:\.private)?:/)

line.gsub(/(?<=[:,\s])(#{keg_only_modules_pattern})(?=[<=>!,\s])/) do |match|
any_modification ||= keg_only_pc_files.include?(match)
keg_only_pc_files[match] || match

Check warning on line 185 in Library/Homebrew/cleaner.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/cleaner.rb#L183-L185

Added lines #L183 - L185 were not covered by tests
end
end
next unless any_modification

pc_file.atomic_write(lines.join)

Check warning on line 190 in Library/Homebrew/cleaner.rb

View check run for this annotation

Codecov / codecov/patch

Library/Homebrew/cleaner.rb#L190

Added line #L190 was not covered by tests
end
end

sig { void }
def rewrite_shebangs
require "language/node"
Expand Down