diff --git a/Library/Homebrew/api/cask.rb b/Library/Homebrew/api/cask.rb index 17ca86b7169fd..8e06edc840b57 100644 --- a/Library/Homebrew/api/cask.rb +++ b/Library/Homebrew/api/cask.rb @@ -10,82 +10,80 @@ module API # # @api private module Cask - class << self - include Cachable + extend Cachable - private :cache + private_class_method :cache - sig { params(token: String).returns(Hash) } - def fetch(token) - Homebrew::API.fetch "cask/#{token}.json" - end - - sig { params(cask: ::Cask::Cask).returns(::Cask::Cask) } - def source_download(cask) - path = cask.ruby_source_path.to_s || "Casks/#{cask.token}.rb" - sha256 = cask.ruby_source_checksum[:sha256] - checksum = Checksum.new(sha256) if sha256 - git_head = cask.tap_git_head || "HEAD" - tap = cask.tap&.full_name || "Homebrew/homebrew-cask" - - download = Homebrew::API::Download.new( - "https://raw.githubusercontent.com/#{tap}/#{git_head}/#{path}", - checksum, - mirrors: [ - "#{HOMEBREW_API_DEFAULT_DOMAIN}/cask-source/#{File.basename(path)}", - ], - cache: HOMEBREW_CACHE_API_SOURCE/"#{tap}/#{git_head}/Cask", - ) - download.fetch - ::Cask::CaskLoader::FromPathLoader.new(download.symlink_location) - .load(config: cask.config) - end + sig { params(token: String).returns(Hash) } + def self.fetch(token) + Homebrew::API.fetch "cask/#{token}.json" + end - sig { returns(T::Boolean) } - def download_and_cache_data! - json_casks, updated = Homebrew::API.fetch_json_api_file "cask.jws.json" + sig { params(cask: ::Cask::Cask).returns(::Cask::Cask) } + def self.source_download(cask) + path = cask.ruby_source_path.to_s || "Casks/#{cask.token}.rb" + sha256 = cask.ruby_source_checksum[:sha256] + checksum = Checksum.new(sha256) if sha256 + git_head = cask.tap_git_head || "HEAD" + tap = cask.tap&.full_name || "Homebrew/homebrew-cask" + + download = Homebrew::API::Download.new( + "https://raw.githubusercontent.com/#{tap}/#{git_head}/#{path}", + checksum, + mirrors: [ + "#{HOMEBREW_API_DEFAULT_DOMAIN}/cask-source/#{File.basename(path)}", + ], + cache: HOMEBREW_CACHE_API_SOURCE/"#{tap}/#{git_head}/Cask", + ) + download.fetch + ::Cask::CaskLoader::FromPathLoader.new(download.symlink_location) + .load(config: cask.config) + end - cache["renames"] = {} - cache["casks"] = json_casks.to_h do |json_cask| - token = json_cask["token"] + sig { returns(T::Boolean) } + def self.download_and_cache_data! + json_casks, updated = Homebrew::API.fetch_json_api_file "cask.jws.json" - json_cask.fetch("old_tokens", []).each do |old_token| - cache["renames"][old_token] = token - end + cache["renames"] = {} + cache["casks"] = json_casks.to_h do |json_cask| + token = json_cask["token"] - [token, json_cask.except("token")] + json_cask.fetch("old_tokens", []).each do |old_token| + cache["renames"][old_token] = token end - updated + [token, json_cask.except("token")] end - private :download_and_cache_data! - sig { returns(T::Hash[String, Hash]) } - def all_casks - unless cache.key?("casks") - json_updated = download_and_cache_data! - write_names(regenerate: json_updated) - end + updated + end + private_class_method :download_and_cache_data! - cache.fetch("casks") + sig { returns(T::Hash[String, Hash]) } + def self.all_casks + unless cache.key?("casks") + json_updated = download_and_cache_data! + write_names(regenerate: json_updated) end - sig { returns(T::Hash[String, String]) } - def all_renames - unless cache.key?("renames") - json_updated = download_and_cache_data! - write_names(regenerate: json_updated) - end + cache.fetch("casks") + end - cache.fetch("renames") + sig { returns(T::Hash[String, String]) } + def self.all_renames + unless cache.key?("renames") + json_updated = download_and_cache_data! + write_names(regenerate: json_updated) end - sig { params(regenerate: T::Boolean).void } - def write_names(regenerate: false) - download_and_cache_data! unless cache.key?("casks") + cache.fetch("renames") + end - Homebrew::API.write_names_file(all_casks.keys, "cask", regenerate: regenerate) - end + sig { params(regenerate: T::Boolean).void } + def self.write_names(regenerate: false) + download_and_cache_data! unless cache.key?("casks") + + Homebrew::API.write_names_file(all_casks.keys, "cask", regenerate: regenerate) end end end diff --git a/Library/Homebrew/api/formula.rb b/Library/Homebrew/api/formula.rb index 8704ec6ad4342..e9747c1ba420c 100644 --- a/Library/Homebrew/api/formula.rb +++ b/Library/Homebrew/api/formula.rb @@ -10,95 +10,93 @@ module API # # @api private module Formula - class << self - include Cachable + extend Cachable - private :cache + private_class_method :cache - sig { params(name: String).returns(Hash) } - def fetch(name) - Homebrew::API.fetch "formula/#{name}.json" - end + sig { params(name: String).returns(Hash) } + def self.fetch(name) + Homebrew::API.fetch "formula/#{name}.json" + end - sig { params(formula: ::Formula).returns(::Formula) } - def source_download(formula) - path = formula.ruby_source_path || "Formula/#{formula.name}.rb" - git_head = formula.tap_git_head || "HEAD" - tap = formula.tap&.full_name || "Homebrew/homebrew-core" - - download = Homebrew::API::Download.new( - "https://raw.githubusercontent.com/#{tap}/#{git_head}/#{path}", - formula.ruby_source_checksum, - cache: HOMEBREW_CACHE_API_SOURCE/"#{tap}/#{git_head}/Formula", - ) - download.fetch - Formulary.factory(download.symlink_location, - formula.active_spec_sym, - alias_path: formula.alias_path, - flags: formula.class.build_flags) - end + sig { params(formula: ::Formula).returns(::Formula) } + def self.source_download(formula) + path = formula.ruby_source_path || "Formula/#{formula.name}.rb" + git_head = formula.tap_git_head || "HEAD" + tap = formula.tap&.full_name || "Homebrew/homebrew-core" + + download = Homebrew::API::Download.new( + "https://raw.githubusercontent.com/#{tap}/#{git_head}/#{path}", + formula.ruby_source_checksum, + cache: HOMEBREW_CACHE_API_SOURCE/"#{tap}/#{git_head}/Formula", + ) + download.fetch + Formulary.factory(download.symlink_location, + formula.active_spec_sym, + alias_path: formula.alias_path, + flags: formula.class.build_flags) + end - sig { returns(T::Boolean) } - def download_and_cache_data! - json_formulae, updated = Homebrew::API.fetch_json_api_file "formula.jws.json" - - cache["aliases"] = {} - cache["renames"] = {} - cache["formulae"] = json_formulae.to_h do |json_formula| - json_formula["aliases"].each do |alias_name| - cache["aliases"][alias_name] = json_formula["name"] - end - (json_formula["oldnames"] || [json_formula["oldname"]].compact).each do |oldname| - cache["renames"][oldname] = json_formula["name"] - end - - [json_formula["name"], json_formula.except("name")] + sig { returns(T::Boolean) } + def self.download_and_cache_data! + json_formulae, updated = Homebrew::API.fetch_json_api_file "formula.jws.json" + + cache["aliases"] = {} + cache["renames"] = {} + cache["formulae"] = json_formulae.to_h do |json_formula| + json_formula["aliases"].each do |alias_name| + cache["aliases"][alias_name] = json_formula["name"] + end + (json_formula["oldnames"] || [json_formula["oldname"]].compact).each do |oldname| + cache["renames"][oldname] = json_formula["name"] end - updated + [json_formula["name"], json_formula.except("name")] end - private :download_and_cache_data! - sig { returns(T::Hash[String, Hash]) } - def all_formulae - unless cache.key?("formulae") - json_updated = download_and_cache_data! - write_names_and_aliases(regenerate: json_updated) - end + updated + end + private_class_method :download_and_cache_data! - cache["formulae"] + sig { returns(T::Hash[String, Hash]) } + def self.all_formulae + unless cache.key?("formulae") + json_updated = download_and_cache_data! + write_names_and_aliases(regenerate: json_updated) end - sig { returns(T::Hash[String, String]) } - def all_aliases - unless cache.key?("aliases") - json_updated = download_and_cache_data! - write_names_and_aliases(regenerate: json_updated) - end + cache["formulae"] + end - cache["aliases"] + sig { returns(T::Hash[String, String]) } + def self.all_aliases + unless cache.key?("aliases") + json_updated = download_and_cache_data! + write_names_and_aliases(regenerate: json_updated) end - sig { returns(T::Hash[String, String]) } - def all_renames - unless cache.key?("renames") - json_updated = download_and_cache_data! - write_names_and_aliases(regenerate: json_updated) - end + cache["aliases"] + end - cache["renames"] + sig { returns(T::Hash[String, String]) } + def self.all_renames + unless cache.key?("renames") + json_updated = download_and_cache_data! + write_names_and_aliases(regenerate: json_updated) end - sig { params(regenerate: T::Boolean).void } - def write_names_and_aliases(regenerate: false) - download_and_cache_data! unless cache.key?("formulae") + cache["renames"] + end + + sig { params(regenerate: T::Boolean).void } + def self.write_names_and_aliases(regenerate: false) + download_and_cache_data! unless cache.key?("formulae") - return unless Homebrew::API.write_names_file(all_formulae.keys, "formula", regenerate: regenerate) + return unless Homebrew::API.write_names_file(all_formulae.keys, "formula", regenerate: regenerate) - (HOMEBREW_CACHE_API/"formula_aliases.txt").open("w") do |file| - all_aliases.each do |alias_name, real_name| - file.puts "#{alias_name}|#{real_name}" - end + (HOMEBREW_CACHE_API/"formula_aliases.txt").open("w") do |file| + all_aliases.each do |alias_name, real_name| + file.puts "#{alias_name}|#{real_name}" end end end diff --git a/Library/Homebrew/readall.rb b/Library/Homebrew/readall.rb index 91407529aaa01..ab1d24f508ea4 100644 --- a/Library/Homebrew/readall.rb +++ b/Library/Homebrew/readall.rb @@ -9,127 +9,124 @@ # # @api private module Readall - class << self - include Cachable - include SystemCommand::Mixin + extend Cachable + extend SystemCommand::Mixin - # TODO: remove this once the `MacOS` module is undefined on Linux - MACOS_MODULE_REGEX = /\b(MacOS|OS::Mac)(\.|::)\b/ - private_constant :MACOS_MODULE_REGEX + # TODO: remove this once the `MacOS` module is undefined on Linux + MACOS_MODULE_REGEX = /\b(MacOS|OS::Mac)(\.|::)\b/ + private_constant :MACOS_MODULE_REGEX - private :cache + private_class_method :cache - def valid_ruby_syntax?(ruby_files) - failed = T.let(false, T::Boolean) - ruby_files.each do |ruby_file| - # As a side effect, print syntax errors/warnings to `$stderr`. - failed = true if syntax_errors_or_warnings?(ruby_file) - end - !failed + def self.valid_ruby_syntax?(ruby_files) + failed = T.let(false, T::Boolean) + ruby_files.each do |ruby_file| + # As a side effect, print syntax errors/warnings to `$stderr`. + failed = true if syntax_errors_or_warnings?(ruby_file) end + !failed + end - def valid_aliases?(alias_dir, formula_dir) - return true unless alias_dir.directory? - - failed = T.let(false, T::Boolean) - alias_dir.each_child do |f| - if !f.symlink? - onoe "Non-symlink alias: #{f}" - failed = true - elsif !f.file? - onoe "Non-file alias: #{f}" - failed = true - end + def self.valid_aliases?(alias_dir, formula_dir) + return true unless alias_dir.directory? + + failed = T.let(false, T::Boolean) + alias_dir.each_child do |f| + if !f.symlink? + onoe "Non-symlink alias: #{f}" + failed = true + elsif !f.file? + onoe "Non-file alias: #{f}" + failed = true + end - if formula_dir.glob("**/#{f.basename}.rb").any?(&:exist?) - onoe "Formula duplicating alias: #{f}" - failed = true - end + if formula_dir.glob("**/#{f.basename}.rb").any?(&:exist?) + onoe "Formula duplicating alias: #{f}" + failed = true end - !failed end + !failed + end - def valid_formulae?(tap, bottle_tag: nil) - cache[:valid_formulae] ||= {} - - success = T.let(true, T::Boolean) - tap.formula_files.each do |file| - valid = cache[:valid_formulae][file] - next if valid == true || valid&.include?(bottle_tag) - - formula_name = file.basename(".rb").to_s - formula_contents = file.read(encoding: "UTF-8") - - readall_namespace = "ReadallNamespace" - readall_formula_class = Formulary.load_formula(formula_name, file, formula_contents, readall_namespace, - flags: [], ignore_errors: false) - readall_formula = readall_formula_class.new(formula_name, file, :stable, tap: tap) - readall_formula.to_hash - # TODO: Remove check for MACOS_MODULE_REGEX once the `MacOS` module is undefined on Linux - cache[:valid_formulae][file] = if readall_formula.on_system_blocks_exist? || - formula_contents.match?(MACOS_MODULE_REGEX) - [bottle_tag, *cache[:valid_formulae][file]] - else - true - end - rescue Interrupt - raise - rescue Exception => e # rubocop:disable Lint/RescueException - onoe "Invalid formula (#{bottle_tag}): #{file}" - $stderr.puts e - success = false + def self.valid_formulae?(tap, bottle_tag: nil) + cache[:valid_formulae] ||= {} + + success = T.let(true, T::Boolean) + tap.formula_files.each do |file| + valid = cache[:valid_formulae][file] + next if valid == true || valid&.include?(bottle_tag) + + formula_name = file.basename(".rb").to_s + formula_contents = file.read(encoding: "UTF-8") + + readall_namespace = "ReadallNamespace" + readall_formula_class = Formulary.load_formula(formula_name, file, formula_contents, readall_namespace, + flags: [], ignore_errors: false) + readall_formula = readall_formula_class.new(formula_name, file, :stable, tap: tap) + readall_formula.to_hash + # TODO: Remove check for MACOS_MODULE_REGEX once the `MacOS` module is undefined on Linux + cache[:valid_formulae][file] = if readall_formula.on_system_blocks_exist? || + formula_contents.match?(MACOS_MODULE_REGEX) + [bottle_tag, *cache[:valid_formulae][file]] + else + true end - success + rescue Interrupt + raise + rescue Exception => e # rubocop:disable Lint/RescueException + onoe "Invalid formula (#{bottle_tag}): #{file}" + $stderr.puts e + success = false end + success + end - def valid_casks?(_tap, os_name: nil, arch: nil) - true - end + def self.valid_casks?(_tap, os_name: nil, arch: nil) + true + end - def valid_tap?(tap, aliases: false, no_simulate: false, os_arch_combinations: OnSystem::ALL_OS_ARCH_COMBINATIONS) - success = true + def self.valid_tap?(tap, aliases: false, no_simulate: false, + os_arch_combinations: OnSystem::ALL_OS_ARCH_COMBINATIONS) + success = true - if aliases - valid_aliases = valid_aliases?(tap.alias_dir, tap.formula_dir) - success = false unless valid_aliases - end + if aliases + valid_aliases = valid_aliases?(tap.alias_dir, tap.formula_dir) + success = false unless valid_aliases + end - if no_simulate - success = false unless valid_formulae?(tap) - success = false unless valid_casks?(tap) - else - os_arch_combinations.each do |os, arch| - bottle_tag = Utils::Bottles::Tag.new(system: os, arch: arch) - next unless bottle_tag.valid_combination? - - Homebrew::SimulateSystem.with os: os, arch: arch do - success = false unless valid_formulae?(tap, bottle_tag: bottle_tag) - success = false unless valid_casks?(tap, os_name: os, arch: arch) - end + if no_simulate + success = false unless valid_formulae?(tap) + success = false unless valid_casks?(tap) + else + os_arch_combinations.each do |os, arch| + bottle_tag = Utils::Bottles::Tag.new(system: os, arch: arch) + next unless bottle_tag.valid_combination? + + Homebrew::SimulateSystem.with os: os, arch: arch do + success = false unless valid_formulae?(tap, bottle_tag: bottle_tag) + success = false unless valid_casks?(tap, os_name: os, arch: arch) end end - - success end - private + success + end - def syntax_errors_or_warnings?(filename) - # Retrieve messages about syntax errors/warnings printed to `$stderr`. - _, err, status = system_command(RUBY_PATH, args: ["-c", "-w", filename], print_stderr: false) + private_class_method def self.syntax_errors_or_warnings?(filename) + # Retrieve messages about syntax errors/warnings printed to `$stderr`. + _, err, status = system_command(RUBY_PATH, args: ["-c", "-w", filename], print_stderr: false) - # Ignore unnecessary warning about named capture conflicts. - # See https://bugs.ruby-lang.org/issues/12359. - messages = err.lines - .grep_v(/named capture conflicts a local variable/) - .join + # Ignore unnecessary warning about named capture conflicts. + # See https://bugs.ruby-lang.org/issues/12359. + messages = err.lines + .grep_v(/named capture conflicts a local variable/) + .join - $stderr.print messages + $stderr.print messages - # Only syntax errors result in a non-zero status code. To detect syntax - # warnings we also need to inspect the output to `$stderr`. - !status.success? || !messages.chomp.empty? - end + # Only syntax errors result in a non-zero status code. To detect syntax + # warnings we also need to inspect the output to `$stderr`. + !status.success? || !messages.chomp.empty? end end diff --git a/Library/Homebrew/test/spec_helper.rb b/Library/Homebrew/test/spec_helper.rb index 9d2f2d10eeff3..2c09cbbd21a0d 100644 --- a/Library/Homebrew/test/spec_helper.rb +++ b/Library/Homebrew/test/spec_helper.rb @@ -35,6 +35,8 @@ $LOAD_PATH.unshift(File.expand_path("#{ENV.fetch("HOMEBREW_LIBRARY")}/Homebrew/test/support/lib")) +require_relative "support/extend/cachable" + require_relative "../global" require "test/support/quiet_progress_formatter" @@ -202,16 +204,7 @@ config.around do |example| Homebrew.raise_deprecation_exceptions = true - Formulary.clear_cache - Tap.each(&:clear_cache) - Tap.clear_cache - DependencyCollector.clear_cache - Formula.clear_cache - Keg.clear_cache - Tab.clear_cache - Dependency.clear_cache - Requirement.clear_cache - Readall.clear_cache if defined?(Readall) + Cachable::Registry.clear_all_caches FormulaInstaller.clear_attempted FormulaInstaller.clear_installed FormulaInstaller.clear_fetched @@ -263,15 +256,7 @@ @__stderr.close @__stdin.close - Formulary.clear_cache - Tap.clear_cache - DependencyCollector.clear_cache - Formula.clear_cache - Keg.clear_cache - Tab.clear_cache - Dependency.clear_cache - Requirement.clear_cache - Readall.clear_cache if defined?(Readall) + Cachable::Registry.clear_all_caches FileUtils.rm_rf [ *TEST_DIRECTORIES, diff --git a/Library/Homebrew/test/support/extend/cachable.rb b/Library/Homebrew/test/support/extend/cachable.rb new file mode 100644 index 0000000000000..764314674d7f2 --- /dev/null +++ b/Library/Homebrew/test/support/extend/cachable.rb @@ -0,0 +1,53 @@ +# frozen_string_literal: true + +raise "This needs to be required before Cachable gets loaded normally." if defined?(Cachable) + +# Collect all classes that mix in Cachable so that those caches can be cleared in-between tests. +module Cachable + private_class_method def self.included(klass) + # It's difficult to backtrack from a singleton class to find the original class + # and you can always just extend this module instead for equivalent behavior. + raise ArgumentError, "Don't use Cachable with singleton classes" if klass.singleton_class? + + super if defined?(super) + end + + private_class_method def self.extended(klass) + Registry.class_list << klass + # Ignore the `Formula` class that gets inherited from a lot and + # that has caches that we don't need to clear on the class level. + klass.extend(Inherited) if klass.name != "Formula" + super if defined?(super) + end + + module Inherited + private + + def inherited(klass) + # A class might inherit Cachable at the instance level + # and in that case we just want to skip registering it. + Registry.class_list << klass if klass.respond_to?(:clear_cache) + super if defined?(super) + end + end + + module Registry + # A list of all classes that have been loaded into memory that mixin or + # inherit `Cachable` at the class or module level. + # + # Note: Classes that inherit from `Formula` are excluded since it's not + # necessary to track and clear individual formula caches. + def self.class_list + @class_list ||= [] + end + + # Clear the cache of every class or module that mixes in or inherits + # `Cachable` at the class or module level. + # + # Note: Classes that inherit from `Formula` are excluded since it's not + # necessary to track and clear individual formula caches. + def self.clear_all_caches + class_list.each(&:clear_cache) + end + end +end