926 lines
24 KiB
Ruby
Raw Normal View History

2020-10-10 14:16:11 +02:00
# typed: false
# frozen_string_literal: true
require "commands"
require "completions"
require "extend/cachable"
require "description_cache_store"
require "settings"
# A {Tap} is used to extend the formulae provided by Homebrew core.
# Usually, it's synced with a remote Git repository. And it's likely
2018-09-04 09:58:58 +01:00
# a GitHub repository with the name of `user/homebrew-repo`. In such
# cases, `user/repo` will be used as the {#name} of this {Tap}, where
# {#user} represents the GitHub username and {#repo} represents the repository
# name without the leading `homebrew-`.
2015-06-10 15:39:47 +08:00
class Tap
2020-10-20 12:03:48 +02:00
extend T::Sig
extend Cachable
2019-04-19 21:46:20 +09:00
TAP_DIRECTORY = (HOMEBREW_LIBRARY/"Taps").freeze
2020-11-09 08:39:56 -05:00
HOMEBREW_TAP_FORMULA_RENAMES_FILE = "formula_renames.json"
HOMEBREW_TAP_MIGRATIONS_FILE = "tap_migrations.json"
HOMEBREW_TAP_AUDIT_EXCEPTIONS_DIR = "audit_exceptions"
HOMEBREW_TAP_STYLE_EXCEPTIONS_DIR = "style_exceptions"
HOMEBREW_TAP_PYPI_FORMULA_MAPPINGS = "pypi_formula_mappings.json"
2020-11-09 08:39:56 -05:00
HOMEBREW_TAP_JSON_FILES = %W[
#{HOMEBREW_TAP_FORMULA_RENAMES_FILE}
#{HOMEBREW_TAP_MIGRATIONS_FILE}
#{HOMEBREW_TAP_AUDIT_EXCEPTIONS_DIR}/*.json
#{HOMEBREW_TAP_STYLE_EXCEPTIONS_DIR}/*.json
#{HOMEBREW_TAP_PYPI_FORMULA_MAPPINGS}
2020-11-09 08:39:56 -05:00
].freeze
def self.fetch(*args)
case args.length
when 1
user, repo = args.first.split("/", 2)
when 2
2018-09-17 19:44:12 +02:00
user = args.first
repo = args.second
end
raise "Invalid tap name '#{args.join("/")}'" if [user, repo].any? { |part| part.nil? || part.include?("/") }
# We special case homebrew and linuxbrew so that users don't have to shift in a terminal.
user = user.capitalize if ["homebrew", "linuxbrew"].include? user
2019-02-25 22:56:29 +01:00
repo = repo.sub(HOMEBREW_OFFICIAL_REPO_PREFIXES_REGEX, "")
return CoreTap.instance if ["Homebrew", "Linuxbrew"].include?(user) && ["core", "homebrew"].include?(repo)
cache_key = "#{user}/#{repo}".downcase
cache.fetch(cache_key) { |key| cache[key] = Tap.new(user, repo) }
end
def self.from_path(path)
match = File.expand_path(path).match(HOMEBREW_TAP_PATH_REGEX)
return if match.blank? || match[:user].blank? || match[:repo].blank?
2018-09-17 02:45:00 +02:00
2017-07-29 16:27:54 +02:00
fetch(match[:user], match[:repo])
end
sig { returns(T.attached_class) }
2018-06-09 10:13:28 +02:00
def self.default_cask_tap
@default_cask_tap ||= fetch("Homebrew", "cask")
end
sig { params(force: T::Boolean).returns(T::Boolean) }
def self.install_default_cask_tap_if_necessary(force: false)
false
end
2015-06-10 15:39:47 +08:00
extend Enumerable
2018-09-04 09:58:58 +01:00
# The user name of this {Tap}. Usually, it's the GitHub username of
# this {Tap}'s remote repository.
2015-06-10 15:39:47 +08:00
attr_reader :user
# The repository name of this {Tap} without the leading `homebrew-`.
2015-06-10 15:39:47 +08:00
attr_reader :repo
# The name of this {Tap}. It combines {#user} and {#repo} with a slash.
# {#name} is always in lowercase.
# e.g. `user/repo`
2015-06-10 15:39:47 +08:00
attr_reader :name
# The full name of this {Tap}, including the `homebrew-` prefix.
# It combines {#user} and 'homebrew-'-prefixed {#repo} with a slash.
# e.g. `user/homebrew-repo`
attr_reader :full_name
# The local path to this {Tap}.
# e.g. `/usr/local/Library/Taps/user/homebrew-repo`
2015-06-10 15:39:47 +08:00
attr_reader :path
# @private
def initialize(user, repo)
@user = user
2015-06-10 15:39:47 +08:00
@repo = repo
@name = "#{@user}/#{@repo}".downcase
@full_name = "#{@user}/homebrew-#{@repo}"
@path = TAP_DIRECTORY/@full_name.downcase
@path.extend(GitRepositoryExtension)
@alias_table = nil
@alias_reverse_table = nil
end
# Clear internal cache.
def clear_cache
@remote = nil
2018-05-25 22:47:31 +02:00
@repo_var = nil
@formula_dir = nil
2016-08-04 14:37:37 +04:00
@cask_dir = nil
2018-07-25 11:38:19 +02:00
@command_dir = nil
@formula_files = nil
@alias_dir = nil
@alias_files = nil
@aliases = nil
@alias_table = nil
@alias_reverse_table = nil
@command_files = nil
@formula_renames = nil
@tap_migrations = nil
@audit_exceptions = nil
@style_exceptions = nil
@pypi_formula_mappings = nil
@config = nil
2021-06-19 00:14:33 +01:00
@spell_checker = nil
remove_instance_variable(:@private) if instance_variable_defined?(:@private)
end
# The remote path to this {Tap}.
# e.g. `https://github.com/user/homebrew-repo`
def remote
raise TapUnavailableError, name unless installed?
2018-09-17 02:45:00 +02:00
@remote ||= path.git_origin
2015-06-10 15:39:47 +08:00
end
# The remote repository name of this {Tap}.
# e.g. `user/homebrew-repo`
def remote_repo
raise TapUnavailableError, name unless installed?
return unless remote
@remote_repo ||= remote.delete_prefix("https://github.com/")
.delete_prefix("git@github.com:")
.delete_suffix(".git")
end
# The default remote path to this {Tap}.
2020-10-20 12:03:48 +02:00
sig { returns(String) }
def default_remote
"https://github.com/#{full_name}"
end
2018-05-25 16:21:37 +02:00
def repo_var
@repo_var ||= path.to_s
2018-09-15 00:04:01 +02:00
.delete_prefix(TAP_DIRECTORY.to_s)
2018-05-25 16:21:37 +02:00
.tr("^A-Za-z0-9", "_")
.upcase
end
# True if this {Tap} is a Git repository.
def git?
path.git?
end
2017-09-27 16:32:13 -04:00
# git branch for this {Tap}.
def git_branch
raise TapUnavailableError, name unless installed?
2018-09-17 02:45:00 +02:00
2017-09-27 16:32:13 -04:00
path.git_branch
end
# git HEAD for this {Tap}.
def git_head
raise TapUnavailableError, name unless installed?
2018-09-17 02:45:00 +02:00
path.git_head
end
# Time since last git commit for this {Tap}.
def git_last_commit
raise TapUnavailableError, name unless installed?
2018-09-17 02:45:00 +02:00
path.git_last_commit
end
# The issues URL of this {Tap}.
# e.g. `https://github.com/user/homebrew-repo/issues`
2020-10-20 12:03:48 +02:00
sig { returns(T.nilable(String)) }
def issues_url
return if !official? && custom_remote?
2018-09-17 02:45:00 +02:00
"#{default_remote}/issues"
end
2015-06-10 15:39:47 +08:00
def to_s
name
end
# True if this {Tap} is an official Homebrew tap.
2015-06-10 15:39:47 +08:00
def official?
2015-12-06 20:57:28 +08:00
user == "Homebrew"
2015-06-10 15:39:47 +08:00
end
# True if the remote of this {Tap} is a private repository.
2015-06-10 15:39:47 +08:00
def private?
return @private if instance_variable_defined?(:@private)
2018-09-17 02:45:00 +02:00
@private = read_or_set_private_config
end
# {TapConfig} of this {Tap}.
def config
@config ||= begin
raise TapUnavailableError, name unless installed?
2018-09-17 02:45:00 +02:00
TapConfig.new(self)
end
2015-06-10 15:39:47 +08:00
end
# True if this {Tap} has been installed.
2015-06-10 15:39:47 +08:00
def installed?
2015-12-06 20:57:28 +08:00
path.directory?
2015-06-10 15:39:47 +08:00
end
# True if this {Tap} is not a full clone.
def shallow?
(path/".git/shallow").exist?
end
2015-12-07 14:12:57 +08:00
# @private
2020-10-20 12:03:48 +02:00
sig { returns(T::Boolean) }
def core_tap?
2015-12-07 14:12:57 +08:00
false
end
# Install this {Tap}.
2015-11-07 16:25:34 +08:00
#
# @param clone_target [String] If passed, it will be used as the clone remote.
# @param force_auto_update [Boolean, nil] If present, whether to override the
# logic that skips non-GitHub repositories during auto-updates.
# @param quiet [Boolean] If set, suppress all output.
# @param custom_remote [Boolean] If set, change the tap's remote if already installed.
def install(quiet: false, clone_target: nil, force_auto_update: nil, custom_remote: false)
require "descriptions"
2020-08-18 00:23:23 +01:00
require "readall"
2015-11-07 16:25:34 +08:00
if official? && DEPRECATED_OFFICIAL_TAPS.include?(repo)
odie "#{name} was deprecated. This tap is now empty and all its contents were either deleted or migrated."
2020-09-28 20:54:16 +02:00
elsif user == "caskroom" || name == "phinze/cask"
new_repo = repo == "cask" ? "cask" : "cask-#{repo}"
odie "#{name} was moved. Tap homebrew/#{new_repo} instead."
end
raise TapNoCustomRemoteError, name if custom_remote && clone_target.nil?
requested_remote = clone_target || default_remote
if installed? && !custom_remote
raise TapRemoteMismatchError.new(name, @remote, requested_remote) if clone_target && requested_remote != remote
raise TapAlreadyTappedError, name if force_auto_update.nil? && !shallow?
end
2016-02-25 21:09:50 +08:00
2015-11-07 16:25:34 +08:00
# ensure git is installed
2020-08-23 06:32:26 +02:00
Utils::Git.ensure_installed!
if installed?
if requested_remote != remote # we are sure that clone_target is not nil and custom_remote is true here
fix_remote_configuration(requested_remote: requested_remote, quiet: quiet)
end
unless force_auto_update.nil?
config["forceautoupdate"] = force_auto_update
2021-05-06 09:56:30 -04:00
return
end
2021-05-06 09:56:30 -04:00
$stderr.ohai "Unshallowing #{name}" if shallow? && !quiet
args = %w[fetch]
# Git throws an error when attempting to unshallow a full clone
args << "--unshallow" if shallow?
args << "-q" if quiet
path.cd { safe_system "git", *args }
return
end
clear_cache
2020-09-17 04:18:13 +05:30
$stderr.ohai "Tapping #{name}" unless quiet
2016-06-20 13:03:27 +01:00
args = %W[clone #{requested_remote} #{path}]
# Override possible user configs like:
# git config --global clone.defaultRemoteName notorigin
args << "--origin=origin"
2016-02-25 21:09:50 +08:00
args << "-q" if quiet
2015-11-07 16:25:34 +08:00
2021-05-14 10:47:52 -04:00
# Override user-set default template
args << "--template="
2015-11-07 16:25:34 +08:00
begin
safe_system "git", *args
# TODO: 3.6.0: consider if we want to actually read all contents of tap or odeprecate.
2020-09-01 14:05:52 +01:00
if !Readall.valid_tap?(self, aliases: true) && !Homebrew::EnvConfig.developer?
raise "Cannot tap #{name}: invalid syntax in tap!"
end
2018-09-02 23:30:07 +02:00
rescue Interrupt, RuntimeError
2015-11-07 16:25:34 +08:00
ignore_interrupts do
# wait for git to possibly cleanup the top directory when interrupt happens.
sleep 0.1
FileUtils.rm_rf path
2015-12-06 20:57:28 +08:00
path.parent.rmdir_if_possible
2015-11-07 16:25:34 +08:00
end
raise
end
config["forceautoupdate"] = force_auto_update unless force_auto_update.nil?
Commands.rebuild_commands_completion_list
link_completions_and_manpages
formatted_contents = contents.presence&.to_sentence&.dup&.prepend(" ")
2020-09-17 04:18:13 +05:30
$stderr.puts "Tapped#{formatted_contents} (#{path.abv})." unless quiet
CacheStoreDatabase.use(:descriptions) do |db|
DescriptionCacheStore.new(db)
.update_from_formula_names!(formula_names)
end
2015-11-07 16:25:34 +08:00
2021-01-19 17:55:03 -05:00
if official?
2021-01-20 12:02:24 -05:00
untapped = self.class.untapped_official_taps
2021-01-19 17:55:03 -05:00
untapped -= [name]
if untapped.empty?
Homebrew::Settings.delete :untapped
else
Homebrew::Settings.write :untapped, untapped.join(";")
end
end
return if clone_target
2016-09-23 22:02:23 +02:00
return unless private?
return if quiet
2018-09-17 02:45:00 +02:00
2020-09-17 04:18:13 +05:30
$stderr.puts <<~EOS
2016-09-23 22:02:23 +02:00
It looks like you tapped a private repository. To avoid entering your
credentials each time you update, you can use git HTTP credential
caching or issue the following command:
cd #{path}
git remote set-url origin git@github.com:#{full_name}.git
2016-09-23 22:02:23 +02:00
EOS
2015-11-07 16:25:34 +08:00
end
def link_completions_and_manpages
command = "brew tap --repair"
Utils::Link.link_manpages(path, command)
Homebrew::Completions.show_completions_message_if_needed
if official? || Homebrew::Completions.link_completions?
Utils::Link.link_completions(path, command)
else
Utils::Link.unlink_completions(path)
end
end
def fix_remote_configuration(requested_remote: nil, quiet: false)
if requested_remote.present?
path.cd do
safe_system "git", "remote", "set-url", "origin", requested_remote
safe_system "git", "config", "remote.origin.fetch", "+refs/heads/*:refs/remotes/origin/*"
end
$stderr.ohai "#{name}: changed remote from #{remote} to #{requested_remote}" unless quiet
end
current_upstream_head = path.git_origin_branch
return if requested_remote.blank? && path.git_origin_has_branch?(current_upstream_head)
args = %w[fetch]
args << "--quiet" if quiet
args << "origin"
safe_system "git", "-C", path, *args
path.git_origin_set_head_auto
new_upstream_head = path.git_origin_branch
return if new_upstream_head == current_upstream_head
path.git_rename_branch old: current_upstream_head, new: new_upstream_head
path.git_branch_set_upstream local: new_upstream_head, origin: new_upstream_head
2021-10-12 20:38:09 +08:00
return if quiet
$stderr.ohai "#{name}: changed default branch name from #{current_upstream_head} to #{new_upstream_head}!"
end
# Uninstall this {Tap}.
def uninstall(manual: false)
require "descriptions"
2015-11-07 16:25:34 +08:00
raise TapUnavailableError, name unless installed?
2020-09-17 04:18:13 +05:30
$stderr.puts "Untapping #{name}..."
2018-06-19 17:59:25 +02:00
abv = path.abv
formatted_contents = contents.presence&.to_sentence&.dup&.prepend(" ")
2018-06-19 17:59:25 +02:00
2015-11-07 16:25:34 +08:00
unpin if pinned?
CacheStoreDatabase.use(:descriptions) do |db|
DescriptionCacheStore.new(db)
.delete_from_formula_names!(formula_names)
end
Utils::Link.unlink_manpages(path)
Utils::Link.unlink_completions(path)
2015-12-06 20:57:28 +08:00
path.rmtree
path.parent.rmdir_if_possible
2020-09-17 04:18:13 +05:30
$stderr.puts "Untapped#{formatted_contents} (#{abv})."
Commands.rebuild_commands_completion_list
clear_cache
2021-01-19 17:55:03 -05:00
return if !manual || !official?
2021-01-19 17:55:03 -05:00
2021-01-20 12:02:24 -05:00
untapped = self.class.untapped_official_taps
2021-01-19 17:55:03 -05:00
return if untapped.include? name
untapped << name
Homebrew::Settings.write :untapped, untapped.join(";")
2015-11-07 16:25:34 +08:00
end
# True if the {#remote} of {Tap} is customized.
2015-06-10 15:39:47 +08:00
def custom_remote?
return true unless remote
2018-09-17 02:45:00 +02:00
remote.casecmp(default_remote).nonzero?
2015-06-10 15:39:47 +08:00
end
# Path to the directory of all {Formula} files for this {Tap}.
2015-12-06 20:59:31 +08:00
def formula_dir
@formula_dir ||= potential_formula_dirs.find(&:directory?) || (path/"Formula")
end
def potential_formula_dirs
@potential_formula_dirs ||= [path/"Formula", path/"HomebrewFormula", path].freeze
2015-12-06 20:59:31 +08:00
end
# Path to the directory of all {Cask} files for this {Tap}.
2016-08-04 14:37:37 +04:00
def cask_dir
@cask_dir ||= path/"Casks"
2016-08-04 14:37:37 +04:00
end
2018-06-20 20:35:24 +02:00
def contents
contents = []
if (command_count = command_files.count).positive?
contents << "#{command_count} #{"command".pluralize(command_count)}"
2018-06-20 20:35:24 +02:00
end
if (cask_count = cask_files.count).positive?
contents << "#{cask_count} #{"cask".pluralize(cask_count)}"
2018-06-20 20:35:24 +02:00
end
if (formula_count = formula_files.count).positive?
contents << "#{formula_count} #{"formula".pluralize(formula_count)}"
2018-06-20 20:35:24 +02:00
end
contents
end
# An array of all {Formula} files of this {Tap}.
2015-06-10 15:39:47 +08:00
def formula_files
@formula_files ||= if formula_dir.directory?
formula_dir.children.select(&method(:ruby_file?))
else
[]
end
end
# An array of all {Cask} files of this {Tap}.
def cask_files
@cask_files ||= if cask_dir.directory?
cask_dir.children.select(&method(:ruby_file?))
else
[]
end
2015-06-10 15:39:47 +08:00
end
# returns true if the file has a Ruby extension
# @private
def ruby_file?(file)
file.extname == ".rb"
end
# return true if given path would present a {Formula} file in this {Tap}.
# accepts both absolute path and relative path (relative to this {Tap}'s path)
# @private
def formula_file?(file)
file = Pathname.new(file) unless file.is_a? Pathname
file = file.expand_path(path)
ruby_file?(file) && file.parent == formula_dir
end
# return true if given path would present a {Cask} file in this {Tap}.
2016-08-04 14:37:37 +04:00
# accepts both absolute path and relative path (relative to this {Tap}'s path)
# @private
def cask_file?(file)
file = Pathname.new(file) unless file.is_a? Pathname
file = file.expand_path(path)
ruby_file?(file) && file.parent == cask_dir
2016-08-04 14:37:37 +04:00
end
# An array of all {Formula} names of this {Tap}.
2015-06-10 15:39:47 +08:00
def formula_names
@formula_names ||= formula_files.map(&method(:formula_file_to_name))
end
# An array of all {Cask} tokens of this {Tap}.
def cask_tokens
@cask_tokens ||= cask_files.map(&method(:formula_file_to_name))
2015-06-10 15:39:47 +08:00
end
2015-12-06 21:15:43 +08:00
# path to the directory of all alias files for this {Tap}.
# @private
def alias_dir
@alias_dir ||= path/"Aliases"
2015-12-06 21:15:43 +08:00
end
2015-09-12 18:21:22 +08:00
# an array of all alias files of this {Tap}.
# @private
def alias_files
2015-12-06 21:15:43 +08:00
@alias_files ||= Pathname.glob("#{alias_dir}/*").select(&:file?)
2015-09-12 18:21:22 +08:00
end
# an array of all aliases of this {Tap}.
# @private
def aliases
@aliases ||= alias_files.map { |f| alias_file_to_name(f) }
2015-09-12 18:21:22 +08:00
end
# a table mapping alias to formula name
# @private
def alias_table
return @alias_table if @alias_table
2018-09-17 02:45:00 +02:00
@alias_table = {}
alias_files.each do |alias_file|
@alias_table[alias_file_to_name(alias_file)] = formula_file_to_name(alias_file.resolved_path)
end
@alias_table
end
# a table mapping formula name to aliases
# @private
def alias_reverse_table
return @alias_reverse_table if @alias_reverse_table
2018-09-17 02:45:00 +02:00
@alias_reverse_table = {}
alias_table.each do |alias_name, formula_name|
@alias_reverse_table[formula_name] ||= []
@alias_reverse_table[formula_name] << alias_name
end
@alias_reverse_table
end
2018-07-25 11:38:19 +02:00
def command_dir
@command_dir ||= path/"cmd"
end
# An array of all commands files of this {Tap}.
2015-06-10 15:39:47 +08:00
def command_files
2018-07-25 11:38:19 +02:00
@command_files ||= if command_dir.directory?
Commands.find_commands(command_dir)
2018-07-25 11:38:19 +02:00
else
[]
end
2015-06-10 15:39:47 +08:00
end
2015-11-07 16:00:45 +08:00
# path to the pin record for this {Tap}.
# @private
2015-08-09 22:42:46 +08:00
def pinned_symlink_path
2015-12-06 20:57:28 +08:00
HOMEBREW_LIBRARY/"PinnedTaps/#{name}"
2015-08-09 22:42:46 +08:00
end
2015-11-07 16:00:45 +08:00
# True if this {Tap} has been pinned.
2015-08-09 22:42:46 +08:00
def pinned?
return @pinned if instance_variable_defined?(:@pinned)
2018-09-17 02:45:00 +02:00
@pinned = pinned_symlink_path.directory?
2015-08-09 22:42:46 +08:00
end
2015-06-10 15:39:47 +08:00
def to_hash
hash = {
2018-11-02 17:18:07 +00:00
"name" => name,
"user" => user,
"repo" => repo,
"path" => path.to_s,
"installed" => installed?,
"official" => official?,
2015-06-10 15:39:47 +08:00
"formula_names" => formula_names,
"formula_files" => formula_files.map(&:to_s),
"cask_tokens" => cask_tokens,
"cask_files" => cask_files.map(&:to_s),
"command_files" => command_files.map(&:to_s),
2015-06-10 15:39:47 +08:00
}
if installed?
hash["remote"] = remote
hash["custom_remote"] = custom_remote?
hash["private"] = private?
end
hash
2015-06-10 15:39:47 +08:00
end
# Hash with tap formula renames.
def formula_renames
2020-11-09 08:39:56 -05:00
@formula_renames ||= if (rename_file = path/HOMEBREW_TAP_FORMULA_RENAMES_FILE).file?
JSON.parse(rename_file.read)
else
{}
end
end
# Hash with tap migrations.
def tap_migrations
2020-11-09 08:39:56 -05:00
@tap_migrations ||= if (migration_file = path/HOMEBREW_TAP_MIGRATIONS_FILE).file?
JSON.parse(migration_file.read)
else
{}
end
end
# Hash with audit exceptions
sig { returns(Hash) }
def audit_exceptions
@audit_exceptions = read_formula_list_directory "#{HOMEBREW_TAP_AUDIT_EXCEPTIONS_DIR}/*"
end
# Hash with style exceptions
sig { returns(Hash) }
def style_exceptions
@style_exceptions = read_formula_list_directory "#{HOMEBREW_TAP_STYLE_EXCEPTIONS_DIR}/*"
end
# Hash with pypi formula mappings
sig { returns(Hash) }
def pypi_formula_mappings
@pypi_formula_mappings = read_formula_list path/HOMEBREW_TAP_PYPI_FORMULA_MAPPINGS
end
2015-12-06 22:21:27 +08:00
def ==(other)
other = Tap.fetch(other) if other.is_a?(String)
self.class == other.class && name == other.name
2015-12-06 22:21:27 +08:00
end
def self.each(&block)
2015-06-10 15:39:47 +08:00
return unless TAP_DIRECTORY.directory?
2020-11-16 22:18:56 +01:00
return to_enum unless block
2015-06-10 15:39:47 +08:00
TAP_DIRECTORY.subdirs.each do |user|
user.subdirs.each do |repo|
2021-11-02 11:16:10 +00:00
yield fetch(user.basename.to_s, repo.basename.to_s)
2015-06-10 15:39:47 +08:00
end
end
end
# An array of all installed {Tap} names.
2015-06-10 15:39:47 +08:00
def self.names
2017-10-14 06:13:40 +01:00
map(&:name).sort
2015-06-10 15:39:47 +08:00
end
# An array of all tap cmd directory {Pathname}s.
2020-10-20 12:03:48 +02:00
sig { returns(T::Array[Pathname]) }
def self.cmd_directories
Pathname.glob TAP_DIRECTORY/"*/*/cmd"
end
2021-01-20 12:02:24 -05:00
# An array of official taps that have been manually untapped
sig { returns(T::Array[String]) }
def self.untapped_official_taps
Homebrew::Settings.read(:untapped)&.split(";") || []
end
# @private
def formula_file_to_name(file)
"#{name}/#{file.basename(".rb")}"
end
# @private
def alias_file_to_name(file)
"#{name}/#{file.basename}"
end
2021-10-04 21:45:20 -04:00
def audit_exception(list, formula_or_cask, value = nil)
return false if audit_exceptions.blank?
return false unless audit_exceptions.key? list
list = audit_exceptions[list]
case list
when Array
list.include? formula_or_cask
when Hash
return false unless list.include? formula_or_cask
return list[formula_or_cask] if value.blank?
list[formula_or_cask] == value
end
end
private
def read_or_set_private_config
case config["private"]
when "true" then true
when "false" then false
else
config["private"] = begin
if custom_remote?
true
else
GitHub.private_repo?(full_name)
end
2021-02-15 21:48:21 +05:30
rescue GitHub::API::HTTPNotFoundError
true
2021-02-15 21:48:21 +05:30
rescue GitHub::API::Error
false
end
end
end
sig { params(file: Pathname).returns(T.any(T::Array[String], Hash)) }
def read_formula_list(file)
JSON.parse file.read
rescue JSON::ParserError
opoo "#{file} contains invalid JSON"
{}
rescue Errno::ENOENT
{}
end
sig { params(directory: String).returns(Hash) }
def read_formula_list_directory(directory)
list = {}
Pathname.glob(path/directory).each do |exception_file|
list_name = exception_file.basename.to_s.chomp(".json").to_sym
list_contents = read_formula_list exception_file
next if list_contents.blank?
list[list_name] = list_contents
end
list
end
2015-06-10 15:39:47 +08:00
end
# A specialized {Tap} class for the core formulae.
class CoreTap < Tap
2020-10-20 12:03:48 +02:00
extend T::Sig
# @private
2020-10-20 12:03:48 +02:00
sig { void }
def initialize
super "Homebrew", "core"
end
def self.instance
@instance ||= new
end
def self.ensure_installed!
return if instance.installed?
2021-10-22 11:46:54 -04:00
return if Homebrew::EnvConfig.install_from_api?
2018-09-17 02:45:00 +02:00
safe_system HOMEBREW_BREW_FILE, "tap", instance.name
end
# CoreTap never allows shallow clones (on request from GitHub).
def install(quiet: false, clone_target: nil, force_auto_update: nil, custom_remote: false)
remote = Homebrew::EnvConfig.core_git_remote # set by HOMEBREW_CORE_GIT_REMOTE
requested_remote = clone_target || remote
# The remote will changed again on `brew update` since remotes for Homebrew/core are mismatched
raise TapCoreRemoteMismatchError.new(name, remote, requested_remote) if requested_remote != remote
2020-09-17 04:18:13 +05:30
if remote != default_remote
$stderr.puts "HOMEBREW_CORE_GIT_REMOTE set: using #{remote} for Homebrew/core Git remote."
2020-09-17 04:18:13 +05:30
end
super(quiet: quiet, clone_target: remote, force_auto_update: force_auto_update, custom_remote: custom_remote)
end
# @private
2021-06-12 18:02:23 -04:00
sig { params(manual: T::Boolean).void }
def uninstall(manual: false)
2021-10-22 11:46:54 -04:00
raise "Tap#uninstall is not available for CoreTap" unless Homebrew::EnvConfig.install_from_api?
2021-06-12 18:02:23 -04:00
super
end
# @private
2020-10-20 12:03:48 +02:00
sig { void }
def pin
raise "Tap#pin is not available for CoreTap"
end
# @private
2020-10-20 12:03:48 +02:00
sig { void }
def unpin
raise "Tap#unpin is not available for CoreTap"
end
# @private
2020-10-20 12:03:48 +02:00
sig { returns(T::Boolean) }
def pinned?
false
end
# @private
2020-10-20 12:03:48 +02:00
sig { returns(T::Boolean) }
def core_tap?
true
end
# @private
sig { returns(T::Boolean) }
def linuxbrew_core?
remote_repo.to_s.end_with?("/linuxbrew-core") || remote_repo == "Linuxbrew/homebrew-core"
end
# @private
def formula_dir
@formula_dir ||= begin
self.class.ensure_installed!
super
end
end
# @private
def alias_dir
@alias_dir ||= begin
self.class.ensure_installed!
super
end
end
# @private
def formula_renames
@formula_renames ||= begin
self.class.ensure_installed!
super
end
end
# @private
def tap_migrations
@tap_migrations ||= begin
self.class.ensure_installed!
super
end
end
# @private
def audit_exceptions
@audit_exceptions ||= begin
self.class.ensure_installed!
super
end
end
# @private
def style_exceptions
@style_exceptions ||= begin
self.class.ensure_installed!
super
end
end
# @private
def pypi_formula_mappings
@pypi_formula_mappings ||= begin
self.class.ensure_installed!
super
end
end
# @private
def formula_file_to_name(file)
file.basename(".rb").to_s
end
# @private
def alias_file_to_name(file)
file.basename.to_s
end
end
# Permanent configuration per {Tap} using `git-config(1)`.
class TapConfig
attr_reader :tap
def initialize(tap)
@tap = tap
end
def [](key)
return unless tap.git?
2020-08-23 06:32:26 +02:00
return unless Utils::Git.available?
Homebrew::Settings.read key, repo: tap.path
end
def []=(key, value)
return unless tap.git?
2020-08-23 06:32:26 +02:00
return unless Utils::Git.available?
Homebrew::Settings.write key, value.to_s, repo: tap.path
end
end
require "extend/os/tap"