Class: Tap Private

Inherits:
Object show all
Extended by:
Cachable, Enumerable, T::Generic, Utils::Output::Mixin
Includes:
Utils::Output::Mixin
Defined in:
tap.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

A Tap is used to encapsulate Homebrew formulae, casks and custom commands. Usually, it's synced with a remote Git repository. And it's likely a GitHub repository with the name of user/homebrew-repository. In such cases, user/repository will be used as the #name of this Tap, where #user represents the GitHub username and #repository represents the repository name without the leading homebrew-.

Direct Known Subclasses

AbstractCoreTap

Defined Under Namespace

Classes: InvalidNameError

Constant Summary collapse

Cache =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

type_template { { fixed: T::Hash[T.any(String, Symbol), T.untyped] } }
HOMEBREW_TAP_JSON_FILES =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let(%W[
  #{HOMEBREW_TAP_FORMULA_RENAMES_FILE}
  #{HOMEBREW_TAP_CASK_RENAMES_FILE}
  #{HOMEBREW_TAP_MIGRATIONS_FILE}
  #{HOMEBREW_TAP_SYNCED_VERSIONS_FORMULAE_FILE}
  #{HOMEBREW_TAP_DISABLED_NEW_USR_LOCAL_RELOCATION_FORMULAE_FILE}
  #{HOMEBREW_TAP_AUDIT_EXCEPTIONS_DIR}/*.json
  #{HOMEBREW_TAP_STYLE_EXCEPTIONS_DIR}/*.json
].freeze, T::Array[String])
NORMALIZE_REMOTE_HOSTS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

Hosts where a .git suffix and trailing slashes are known not to change which repository a remote identifies, so we can safely strip them. We don't assume this for arbitrary hosts (including self-hosted GitLab and GitHub Enterprise) where repo.git and repo may differ.

%w[github.com gitlab.com].freeze
REMOTE_SCHEME_USERINFO_REGEX =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

An optional RFC 3986-ish scheme:// (e.g. https://, ssh:// or git+https://) followed by optional user@ userinfo: the part of a remote URL that can precede the host.

%r{(?:[a-z][a-z0-9+.-]*://)?(?:[^@/]+@)?}
GITHUB_REMOTE_PREFIX_REGEX =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

The leading <scheme>://<user>@github.com/ of a GitHub URL or the SCP-style <user>@github.com: shorthand. The : form is only SCP syntax when there is no scheme; with a scheme a : starts a port rather than the path, so it must not be rewritten.

%r{\A(?:[a-z][a-z0-9+.-]*://(?:[^@/]+@)?github\.com/|(?:[^@/]+@)?github\.com:)}
REMOTE_HOST_REGEX =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

The host of a remote: the first /- or :-delimited segment after any scheme and userinfo.

%r{\A#{REMOTE_SCHEME_USERINFO_REGEX.source}([^/:]+)}
Elem =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

type_member(:out) { { fixed: Tap } }

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Enumerable

compact_blank, exclude?

Methods included from Cachable

cache

Methods included from Utils::Output::Mixin

issue_reporting_message, odebug, odeprecated, odie, odisabled, ofail, oh1, oh1_title, ohai, ohai_title, onoe, opoo, opoo_outside_github_actions, opoo_without_github_actions_annotation, pretty_deprecated, pretty_disabled, pretty_duration, pretty_install_status, pretty_installed, pretty_uninstalled, pretty_upgradable

Constructor Details

#initialize(user, repository) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:



296
297
298
299
300
301
302
303
304
305
306
 
# File 'tap.rb', line 296

def initialize(user, repository)
  require "git_repository"

  @user = user
  @repository = repository
  @name = T.let("#{@user}/#{@repository}".downcase, String)
  @full_repository = T.let("homebrew-#{@repository}", String)
  @full_name = T.let("#{@user}/#{@full_repository}", String)
  @path = T.let(HOMEBREW_TAP_DIRECTORY/@full_name.downcase, Pathname)
  @git_repository = T.let(GitRepository.new(@path), GitRepository)
end

Instance Attribute Details

#full_name ⇒ String (readonly)

The full name of this Tap, including the homebrew- prefix. It combines #user and 'homebrew-'-prefixed #repository with a slash. e.g. user/homebrew-repository

Returns:



279
280
281
 
# File 'tap.rb', line 279

def full_name
  @full_name
end

#full_repository ⇒ String (readonly)

The repository name of this Tap including the leading homebrew-.

Returns:



257
258
259
 
# File 'tap.rb', line 257

def full_repository
  @full_repository
end

#git_repository ⇒ GitRepository (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

The git repository of this Tap.

Returns:



290
291
292
 
# File 'tap.rb', line 290

def git_repository
  @git_repository
end

#name ⇒ String (readonly)

The name of this Tap. It combines #user and #repository with a slash. #name is always in lowercase. e.g. user/repository

Returns:



265
266
267
 
# File 'tap.rb', line 265

def name
  @name
end

#path ⇒ Pathname (readonly)

The local path to this Tap. e.g. /usr/local/Library/Taps/user/homebrew-repository

Returns:



286
287
288
 
# File 'tap.rb', line 286

def path
  @path
end

#repository ⇒ String (readonly)

The repository name of this Tap without the leading homebrew-.

Returns:



251
252
253
 
# File 'tap.rb', line 251

def repository
  @repository
end

#user ⇒ String (readonly)

The user name of this Tap. Usually, it's the GitHub username of this Tap's remote repository.

Returns:



245
246
247
 
# File 'tap.rb', line 245

def user
  @user
end

Class Method Details

.all ⇒ Array<Tap>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

All locally installed and core taps. Core taps might not be installed locally when using the API.

Returns:



1368
1369
1370
 
# File 'tap.rb', line 1368

def self.all
  cache[:all] ||= installed | core_taps
end

.allowed_taps ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



124
125
126
127
 
# File 'tap.rb', line 124

def self.allowed_taps
  cache_key = :"allowed_taps_#{Homebrew::EnvConfig.allowed_taps.to_s.tr(" ", "_")}"
  cache[cache_key] ||= tap_list_references(Homebrew::EnvConfig.allowed_taps.to_s, "HOMEBREW_ALLOWED_TAPS")
end

.core_taps ⇒ Array<Tap>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



1373
1374
1375
 
# File 'tap.rb', line 1373

def self.core_taps
  [CoreTap.instance, CoreCaskTap.instance].freeze
end

.each(&block) ⇒ Array<Tap>, T::Enumerator[Tap]

Enumerate all available Taps.

Parameters:

  • block (T.proc.params(tap: Tap).void, nil)

Returns:



1381
1382
1383
1384
1385
1386
1387
1388
1389
 
# File 'tap.rb', line 1381

def self.each(&block)
  return to_enum unless block_given?

  if Homebrew::EnvConfig.no_install_from_api?
    installed.each(&block)
  else
    all.each(&block)
  end
end

.fetch(user, repository = T.unsafe(nil)) ⇒ Tap

Fetch a Tap by name.

Parameters:

  • user (String)
  • repository (String) (defaults to: T.unsafe(nil))

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'tap.rb', line 59

def self.fetch(user, repository = T.unsafe(nil))
  user, repository = user.split("/", 2) if repository.nil?

  if [user, repository].any? { |part| part.nil? || part.include?("/") }
    raise InvalidNameError, "Invalid tap name: '#{[*user, *repository].join("/")}'"
  end

  user = T.must(user)

  # 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)
  repository = repository.sub(HOMEBREW_OFFICIAL_REPO_PREFIXES_REGEX, "")

  return CoreTap.instance if ["Homebrew", "Linuxbrew"].include?(user) && ["core", "homebrew"].include?(repository)
  return CoreCaskTap.instance if user == "Homebrew" && repository == "cask"

  cache_key = "#{user}/#{repository}".downcase
  cache.fetch(cache_key) { |key| cache[key] = new(user, repository) }
end

.forbidden_taps ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



130
131
132
133
 
# File 'tap.rb', line 130

def self.forbidden_taps
  cache_key = :"forbidden_taps_#{Homebrew::EnvConfig.forbidden_taps.to_s.tr(" ", "_")}"
  cache[cache_key] ||= tap_list_references(Homebrew::EnvConfig.forbidden_taps.to_s, "HOMEBREW_FORBIDDEN_TAPS")
end

.from_path(path) ⇒ Tap?

Get a Tap from its path or a path inside of it.

Parameters:

Returns:



83
84
85
86
87
88
89
90
91
 
# File 'tap.rb', line 83

def self.from_path(path)
  match = File.expand_path(path).match(HOMEBREW_TAP_PATH_REGEX)

  return unless match
  return unless (user = match[:user])
  return unless (repository = match[:repository])

  fetch(user, repository)
end

.installed ⇒ Array<Tap>

All locally installed taps.

Returns:



1358
1359
1360
1361
1362
1363
1364
 
# File 'tap.rb', line 1358

def self.installed
  cache[:installed] ||= if HOMEBREW_TAP_DIRECTORY.directory?
    HOMEBREW_TAP_DIRECTORY.subdirs.flat_map(&:subdirs).map { from_path(it) }
  else
    []
  end
end

.normalize_remote(remote) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

On GitHub the scheme and userinfo are insignificant (any of HTTPS, SSH SCP syntax, ssh:// or git:// identify the same repository), so those forms are canonicalised to HTTPS. For hosts in NORMALIZE_REMOTE_HOSTS a .git suffix and trailing slashes are also insignificant, so we strip them; we don't assume that for other hosts.

Parameters:

Returns:



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'tap.rb', line 168

def self.normalize_remote(remote)
  return if remote.blank?

  remote = remote.strip.downcase

  # Canonicalise every GitHub remote form to `https://github.com/<owner>/<repo>` so SSH and
  # HTTPS remotes for the same repository compare equal.
  remote = remote.sub(GITHUB_REMOTE_PREFIX_REGEX, "https://github.com/")

  # Only strip `.git`/trailing slashes for hosts where this is known to be safe.
  host = remote[REMOTE_HOST_REGEX, 1]
  return remote unless NORMALIZE_REMOTE_HOSTS.include?(host)

  remote.sub(%r{/+\z}, "").delete_suffix(".git")
end

.remote_reference?(reference) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Whether an allow/forbid/trust list reference is a remote URL or local path rather than a user/repository tap name (which can only match a tap on its default GitHub remote). A genuine remote reference is a URL (contains ://), scp-like syntax ([user@]host:path, i.e. a non-empty path after a : before any /, the same way Git itself detects scp syntax) or a local path (starts with /, . or ~). A bare foo@bar or host: is not one.

Parameters:

Returns:

  • (Boolean) 


141
142
143
 
# File 'tap.rb', line 141

def self.remote_reference?(reference)
  reference.match?(%r{\A[^/]+:.}) || reference.start_with?("/", ".", "~")
end

.remote_to_reference(url) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Converts a remote URL to the canonical trust-list reference for the tap it identifies. A default-style GitHub remote canonicalises to the owner/repo name form (matching how #reference works for an installed tap); any other remote is stored as the normalised URL. Returns nil if the URL is blank or otherwise invalid.

Parameters:

Returns:



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'tap.rb', line 189

def self.remote_to_reference(url)
  normalised = normalize_remote(url)
  return if normalised.blank?

  match = normalised.match(HOMEBREW_TAP_REPOSITORY_REGEX)
  return normalised unless match

  remote_repository = match[:remote_repository]
  return normalised unless remote_repository

  tap = fetch(remote_repository)
  if same_remote?(normalised, tap.default_remote)
    tap.name
  else
    normalised
  end
rescue InvalidNameError
  normalised
end

.same_remote?(first, second) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

  • (Boolean) 


210
211
212
213
 
# File 'tap.rb', line 210

def self.same_remote?(first, second)
  first = normalize_remote(first)
  first.present? && first == normalize_remote(second)
end

.tap_list_references(env_taps, env_var) ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Normalise user/repository entries in a tap allow/forbid list to canonical tap names, warning about invalid ones, while preserving remote URL or path entries verbatim.

Parameters:

Returns:



218
219
220
221
222
223
224
225
226
227
 
# File 'tap.rb', line 218

def self.tap_list_references(env_taps, env_var)
  env_taps.split.filter_map do |reference|
    next reference if remote_reference?(reference)

    Tap.fetch(reference).name
  rescue Tap::InvalidNameError
    opoo "Invalid tap name in `$#{env_var}`: #{reference}"
    nil
  end.freeze
end

.tap_migration_oldnames(current_tap, name_or_token) ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

The old names a formula or cask had before getting migrated to the current tap.

Parameters:

Returns:



1249
1250
1251
1252
1253
1254
1255
1256
1257
 
# File 'tap.rb', line 1249

def self.tap_migration_oldnames(current_tap, name_or_token)
  key = "#{current_tap}/#{name_or_token}"

  Tap.each_with_object([]) do |tap, array|
    next unless (renames = tap.reverse_tap_migrations_renames[key])

    array.concat(renames)
  end
end

.untapped_official_taps ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

An array of official taps that have been manually untapped

Returns:



1393
1394
1395
 
# File 'tap.rb', line 1393

def self.untapped_official_taps
  Homebrew::Settings.read(:untapped)&.split(";") || []
end

.with_cask_token(token) ⇒ Array<(Tap, String)>?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'tap.rb', line 109

def self.with_cask_token(token)
  return unless (match = token.match(HOMEBREW_TAP_CASK_REGEX))

  user = T.must(match[:user])
  repository = T.must(match[:repository])
  token = T.must(match[:token])

  # Relative paths are not taps.
  return if [user, repository].intersect?([".", ".."])

  tap = fetch(user, repository)
  [tap, token.downcase]
end

.with_formula_name(name) ⇒ Array<(Tap, String)>?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'tap.rb', line 94

def self.with_formula_name(name)
  return unless (match = name.match(HOMEBREW_TAP_FORMULA_REGEX))

  user = T.must(match[:user])
  repository = T.must(match[:repository])
  name = T.must(match[:name])

  # Relative paths are not taps.
  return if [user, repository].intersect?([".", ".."])

  tap = fetch(user, repository)
  [tap, name.downcase]
end

Instance Method Details

#alias_dir ⇒ Pathname

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Path to the directory of all alias files for this Tap.

Returns:



1091
1092
1093
 
# File 'tap.rb', line 1091

def alias_dir
  @alias_dir ||= T.let(path/"Aliases", T.nilable(Pathname))
end

#alias_file_to_name(file) ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



1403
1404
1405
 
# File 'tap.rb', line 1403

def alias_file_to_name(file)
  "#{name}/#{file.basename}"
end

#alias_files ⇒ Array<Pathname>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

An array of all alias files of this Tap.

Returns:



1097
1098
1099
 
# File 'tap.rb', line 1097

def alias_files
  @alias_files ||= T.let(Pathname.glob("#{alias_dir}/*").select(&:file?), T.nilable(T::Array[Pathname]))
end

#alias_reverse_table ⇒ Hash{String => Array<String>}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Mapping from formula names to aliases.

Returns:



1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'tap.rb', line 1117

def alias_reverse_table
  @alias_reverse_table ||= T.let(
    alias_table.each_with_object({}) do |(alias_name, formula_name), alias_reverse_table|
      alias_reverse_table[formula_name] ||= []
      alias_reverse_table[formula_name] << alias_name
    end,
    T.nilable(T::Hash[String, T::Array[String]]),
  )
end

#alias_table ⇒ Hash{String => String}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Mapping from aliases to formula names.

Returns:



1109
1110
1111
1112
1113
 
# File 'tap.rb', line 1109

def alias_table
  @alias_table ||= T.let(alias_files.to_h do |alias_file|
                           [alias_file_to_name(alias_file), formula_file_to_name(alias_file.resolved_path)]
                         end, T.nilable(T::Hash[String, String]))
end

#aliases ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

An array of all aliases of this Tap.

Returns:



1103
1104
1105
 
# File 'tap.rb', line 1103

def aliases
  @aliases ||= T.let(alias_table.keys, T.nilable(T::Array[String]))
end

#allow_bump?(formula_or_cask_name) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Whether this Tap allows running bump commands on the given Formula or Cask.

Parameters:

  • formula_or_cask_name (String)

Returns:

  • (Boolean) 


1293
1294
1295
 
# File 'tap.rb', line 1293

def allow_bump?(formula_or_cask_name)
  ENV["HOMEBREW_TEST_BOT_AUTOBUMP"].present? || !official? || autobump.exclude?(formula_or_cask_name)
end

#allowed_by_env?(remote: self.remote) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • remote (String, nil) (defaults to: self.remote)

Returns:

  • (Boolean) 


1431
1432
1433
1434
1435
1436
 
# File 'tap.rb', line 1431

def allowed_by_env?(remote: self.remote)
  allowed_taps = self.class.allowed_taps

  implicitly_trusted?(remote:) || allowed_taps.blank? ||
    allowed_taps.any? { |reference| matches_reference?(reference, remote:) }
end

#apply_redirected_remote!(redirected_remote, quiet: false) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • redirected_remote (String)
  • quiet (Boolean) (defaults to: false) 


549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
 
# File 'tap.rb', line 549

def apply_redirected_remote!(redirected_remote, quiet: false)
  old_name = name
  old_remote = remote
  return if old_remote.present? && self.class.same_remote?(old_remote, redirected_remote)

  redirected_reference = self.class.remote_to_reference(redirected_remote)
  if redirected_reference.present? && !self.class.remote_reference?(redirected_reference)
    redirected_tap = self.class.fetch(redirected_reference)
    if redirected_tap.name != name && !redirected_tap.installed?
      old_path = path
      redirected_tap.path.dirname.mkpath
      FileUtils.mv(old_path, redirected_tap.path)
      old_path.parent.rmdir_if_possible

      @user = redirected_tap.user
      @repository = redirected_tap.repository
      @name = redirected_tap.name
      @full_repository = redirected_tap.full_repository
      @full_name = redirected_tap.full_name
      @path = redirected_tap.path
      @git_repository = GitRepository.new(@path)
      clear_cache
    end
  end

  safe_system "git", "-C", path, "remote", "set-url", "origin", redirected_remote
  clear_cache
  Tap.clear_cache

  require "trust"
  trust_invalidated = Homebrew::Trust.invalidate_tap_references!(old_name, remote: old_remote)

  return if quiet

  $stderr.ohai(
    if old_name == name
      "Redirected tap #{name} remote to #{redirected_remote}"
    else
      "Redirected tap #{old_name} to tap #{name}"
    end,
  )
  $stderr.puts "#{trust_invalidated ? "Untrusted" : "Not trusted"} tap: #{old_name}"
end

#audit_exception(list, formula_or_cask, value = nil) ⇒ Boolean, String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'tap.rb', line 1411

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?

    return list[formula_or_cask].include?(value) if list[formula_or_cask].is_a?(Array)

    list[formula_or_cask] == value
  end
end

#audit_exceptions ⇒ Hash{Symbol => T.untyped}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Hash with audit exceptions

Returns:



1299
1300
1301
1302
 
# File 'tap.rb', line 1299

def audit_exceptions
  @audit_exceptions ||= T.let(read_formula_list_directory("#{HOMEBREW_TAP_AUDIT_EXCEPTIONS_DIR}/*"),
                              T.nilable(T::Hash[Symbol, T.untyped]))
end

#autobump ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Array with autobump names

Returns:



1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
 
# File 'tap.rb', line 1261

def autobump
  autobump_packages = if core_cask_tap?
    Homebrew::API::Cask.all_casks
  elsif core_tap?
    Homebrew::API::Formula.all_formulae
  else
    {}
  end

  @autobump ||= T.let(autobump_packages.select do |_, p|
    next if p["disabled"]
    next if p["skip_livecheck"]

    p["autobump"] == true
  end.keys, T.nilable(T::Array[String]))

  if @autobump.blank?
    @autobump = T.let(
      if (autobump_file = path/HOMEBREW_TAP_AUTOBUMP_FILE).file?
        autobump_file.readlines(chomp: true)
      else
        []
      end,
      T.nilable(T::Array[String]),
    )
  end

  T.must(@autobump)
end

#canonical_remote?(remote = self.remote) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • remote (String, nil) (defaults to: self.remote)

Returns:

  • (Boolean) 


1452
1453
1454
 
# File 'tap.rb', line 1452

def canonical_remote?(remote = self.remote)
  remote.blank? || self.class.same_remote?(remote, default_remote)
end

#cask_dir ⇒ Pathname

Path to the directory of all Cask files for this Tap.

Returns:



940
941
942
 
# File 'tap.rb', line 940

def cask_dir
  @cask_dir ||= T.let(path/"Casks", T.nilable(Pathname))
end

#cask_file?(file) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

accepts the relative path of a file from Tap's path

Parameters:

Returns:

  • (Boolean) 


1063
1064
1065
 
# File 'tap.rb', line 1063

def cask_file?(file)
  file.match?(CASK_FILE_REGEX)
end

#cask_files ⇒ Array<Pathname>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

An array of all Cask files of this Tap.

Returns:



1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'tap.rb', line 1006

def cask_files
  @cask_files ||= T.let(
    if cask_dir.directory?
      Pathname.glob(cask_dir/"**/*.rb")
    else
      []
    end,
    T.nilable(T::Array[Pathname]),
  )
end

#cask_files_by_name ⇒ Hash{String => Pathname}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

A mapping of Cask tokens to Cask file paths.

Returns:



1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'tap.rb', line 1019

def cask_files_by_name
  @cask_files_by_name ||= T.let(cask_files.each_with_object({}) do |file, hash|
    # If there's more than one file with the same basename: use the longer one to prioritise more specific results.
    basename = file.basename(".rb").to_s
    existing_file = hash[basename]
    hash[basename] = file if existing_file.nil? || existing_file.to_s.length < file.to_s.length
  end, T.nilable(T::Hash[String, Pathname]))
end

#cask_renames ⇒ Hash{String => String}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Hash with tap cask renames.

Returns:



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
 
# File 'tap.rb', line 1177

def cask_renames
  @cask_renames ||= T.let(
    if (rename_file = path/HOMEBREW_TAP_CASK_RENAMES_FILE).file?
      JSON.parse(rename_file.read)
    else
      {}
    end,
    T.nilable(T::Hash[String, String]),
  )
end

#cask_reverse_renames ⇒ Hash{String => Array<String>}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Mapping from new to old cask tokens. Reverse of #cask_renames.

Returns:



1190
1191
1192
1193
1194
1195
 
# File 'tap.rb', line 1190

def cask_reverse_renames
  @cask_reverse_renames ||= T.let(cask_renames.each_with_object({}) do |(old_name, new_name), hash|
    hash[new_name] ||= []
    hash[new_name] << old_name
  end, T.nilable(T::Hash[String, T::Array[String]]))
end

#cask_tokens ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

An array of all Cask tokens of this Tap.

Returns:



1085
1086
1087
 
# File 'tap.rb', line 1085

def cask_tokens
  @cask_tokens ||= T.let(cask_files.map { formula_file_to_name(it) }, T.nilable(T::Array[String]))
end

#clear_cache ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Clear internal cache.



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'tap.rb', line 310

def clear_cache
  @remote = nil
  @repository_var_suffix = nil
  remove_instance_variable(:@private) if instance_variable_defined?(:@private)

  @formula_dir = nil
  @formula_files = nil
  @formula_files_by_name = nil
  @formula_names = nil
  @prefix_to_versioned_formulae_names = nil
  @formula_renames = nil
  @formula_reverse_renames = nil

  @cask_dir = nil
  @cask_files = nil
  @cask_files_by_name = nil
  @cask_tokens = nil
  @cask_renames = nil
  @cask_reverse_renames = nil

  @alias_dir = nil
  @alias_files = nil
  @aliases = nil
  @alias_table = nil
  @alias_reverse_table = nil

  @command_dir = nil
  @command_files = nil

  @tap_migrations = nil
  @reverse_tap_migrations_renames = nil

  @audit_exceptions = nil
  @style_exceptions = nil
  @synced_versions_formulae = nil

  @config = nil
end

#command_dir ⇒ Pathname

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



1128
1129
1130
 
# File 'tap.rb', line 1128

def command_dir
  @command_dir ||= T.let(path/"cmd", T.nilable(Pathname))
end

#command_files ⇒ Array<Pathname>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

An array of all commands files of this Tap.

Returns:



1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'tap.rb', line 1134

def command_files
  @command_files ||= T.let(
    if command_dir.directory?
      Commands.find_commands(command_dir)
    else
      []
    end,
    T.nilable(T::Array[Pathname]),
  )
end

#config ⇒ TapConfig

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

TapConfig of this Tap.

Returns:



506
507
508
509
510
511
512
 
# File 'tap.rb', line 506

def config
  @config ||= T.let(begin
    raise TapUnavailableError, name unless installed?

    TapConfig.new(self)
  end, T.nilable(TapConfig))
end

#contents ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
 
# File 'tap.rb', line 956

def contents
  contents = []

  if (command_count = command_files.count).positive?
    contents << Utils.pluralize("command", command_count, include_count: true)
  end

  if (cask_count = cask_files.count).positive?
    contents << Utils.pluralize("cask", cask_count, include_count: true)
  end

  if (formula_count = formula_files.count).positive?
    contents << Utils.pluralize("formula", formula_count, include_count: true)
  end

  contents
end

#core_cask_tap? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean) 


534
535
536
 
# File 'tap.rb', line 534

def core_cask_tap?
  false
end

#core_tap? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean) 


529
530
531
 
# File 'tap.rb', line 529

def core_tap?
  false
end

#custom_remote? ⇒ Boolean

Check whether the #remote of Tap is customized.

Returns:

  • (Boolean) 


876
877
878
879
880
 
# File 'tap.rb', line 876

def custom_remote?
  return true unless (remote = self.remote)

  !self.class.same_remote?(remote, default_remote)
end

#default_remote ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

The default remote path to this Tap.

Returns:



411
412
413
 
# File 'tap.rb', line 411

def default_remote
  "https://github.com/#{full_name}"
end

#disabled_new_usr_local_relocation_formulae ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Array with formulae that should not be relocated to new /usr/local

Returns:



1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
 
# File 'tap.rb', line 1326

def disabled_new_usr_local_relocation_formulae
  @disabled_new_usr_local_relocation_formulae ||= T.let(
    if (synced_file = path/HOMEBREW_TAP_DISABLED_NEW_USR_LOCAL_RELOCATION_FORMULAE_FILE).file?
      JSON.parse(synced_file.read)
    else
      []
    end,
    T.nilable(T::Array[String]),
  )
end

#ensure_installed! ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.



380
381
382
383
384
 
# File 'tap.rb', line 380

def ensure_installed!
  return if installed?

  install
end

#fix_remote_configuration(requested_remote: nil, quiet: false) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • requested_remote (Pathname, String, nil) (defaults to: nil)
  • quiet (Boolean) (defaults to: false) 


790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
 
# File 'tap.rb', line 790

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
  return unless remote

  current_upstream_head = git_repository.origin_branch_name
  return if current_upstream_head.present? && requested_remote.blank? &&
            git_repository.origin_has_branch?(current_upstream_head)

  args = %w[fetch]
  args << "--quiet" if quiet
  args << "origin"
  args << "+refs/heads/*:refs/remotes/origin/*"
  result = git_command!(args, chdir: path)
  update_remote_from_git_redirect!(result.stderr, quiet:)
  git_repository.set_head_origin_auto

  current_upstream_head ||= T.must(git_repository.origin_branch_name)

  new_upstream_head = T.must(git_repository.origin_branch_name)
  return if new_upstream_head == current_upstream_head

  safe_system "git", "-C", path, "config", "remote.origin.fetch", "+refs/heads/*:refs/remotes/origin/*"
  git_repository.rename_branch old: current_upstream_head, new: new_upstream_head
  git_repository.set_upstream_branch local: new_upstream_head, origin: new_upstream_head

  return if quiet

  $stderr.ohai "#{name}: changed default branch name from #{current_upstream_head} to #{new_upstream_head}!"
end

#forbidden_by_env?(remote: self.remote) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • remote (String, nil) (defaults to: self.remote)

Returns:

  • (Boolean) 


1439
1440
1441
 
# File 'tap.rb', line 1439

def forbidden_by_env?(remote: self.remote)
  self.class.forbidden_taps.any? { |reference| matches_reference?(reference, remote:) }
end

#formula_dir ⇒ Pathname

Path to the directory of all Formula files for this Tap.

Returns:



914
915
916
917
918
919
920
921
922
923
924
 
# File 'tap.rb', line 914

def formula_dir
  # Official formulae taps always use this directory, saves time to hardcode.
  @formula_dir ||= T.let(
    if official?
      path/"Formula"
    else
      potential_formula_dirs.find(&:directory?) || (path/"Formula")
    end,
    T.nilable(Pathname),
  )
end

#formula_file?(file) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

accepts the relative path of a file from Tap's path

Parameters:

Returns:

  • (Boolean) 


1054
1055
1056
 
# File 'tap.rb', line 1054

def formula_file?(file)
  file.match?(formula_file_regex)
end

#formula_file_to_name(file) ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



1398
1399
1400
 
# File 'tap.rb', line 1398

def formula_file_to_name(file)
  "#{name}/#{file.basename(".rb")}"
end

#formula_files ⇒ Array<Pathname>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

An array of all Formula files of this Tap.

Returns:



976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
 
# File 'tap.rb', line 976

def formula_files
  @formula_files ||= T.let(
    if formula_dir.directory?
      if formula_dir == path
        # We only want the top level here so we don't treat commands & casks as formulae.
        # Sharding is only supported in Formula/ and HomebrewFormula/.
        Pathname.glob(formula_dir/"*.rb")
      else
        Pathname.glob(formula_dir/"**/*.rb")
      end
    else
      []
    end,
    T.nilable(T::Array[Pathname]),
  )
end

#formula_files_by_name ⇒ Hash{String => Pathname}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

A mapping of Formula names to Formula file paths.

Returns:



995
996
997
998
999
1000
1001
1002
 
# File 'tap.rb', line 995

def formula_files_by_name
  @formula_files_by_name ||= T.let(formula_files.each_with_object({}) do |file, hash|
    # If there's more than one file with the same basename: use the longer one to prioritise more specific results.
    basename = file.basename(".rb").to_s
    existing_file = hash[basename]
    hash[basename] = file if existing_file.nil? || existing_file.to_s.length < file.to_s.length
  end, T.nilable(T::Hash[String, Pathname]))
end

#formula_names ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

An array of all Formula names of this Tap.

Returns:



1069
1070
1071
 
# File 'tap.rb', line 1069

def formula_names
  @formula_names ||= T.let(formula_files.map { formula_file_to_name(it) }, T.nilable(T::Array[String]))
end

#formula_renames ⇒ Hash{String => String}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Hash with tap formula renames.

Returns:



1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
 
# File 'tap.rb', line 1199

def formula_renames
  @formula_renames ||= T.let(
    if (rename_file = path/HOMEBREW_TAP_FORMULA_RENAMES_FILE).file?
      JSON.parse(rename_file.read)
    else
      {}
    end,
    T.nilable(T::Hash[String, String]),
  )
end

#formula_reverse_renames ⇒ Hash{String => Array<String>}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Mapping from new to old formula names. Reverse of #formula_renames.

Returns:



1212
1213
1214
1215
1216
1217
 
# File 'tap.rb', line 1212

def formula_reverse_renames
  @formula_reverse_renames ||= T.let(formula_renames.each_with_object({}) do |(old_name, new_name), hash|
    hash[new_name] ||= []
    hash[new_name] << old_name
  end, T.nilable(T::Hash[String, T::Array[String]]))
end

#git? ⇒ Boolean

Check whether this Tap is a Git repository.

Returns:

  • (Boolean) 


427
428
429
 
# File 'tap.rb', line 427

def git?
  git_repository.git_repository?
end

#git_branch ⇒ String?

Git branch for this Tap.

Returns:

Raises:



435
436
437
438
439
 
# File 'tap.rb', line 435

def git_branch
  raise TapUnavailableError, name unless installed?

  git_repository.branch_name
end

#git_head ⇒ String?

Git HEAD for this Tap.

Returns:

Raises:



445
446
447
448
449
 
# File 'tap.rb', line 445

def git_head
  raise TapUnavailableError, name unless installed?

  @git_head ||= T.let(git_repository.head_ref, T.nilable(String))
end

#git_last_commit ⇒ String?

Time since last git commit for this Tap.

Returns:

Raises:



455
456
457
458
459
 
# File 'tap.rb', line 455

def git_last_commit
  raise TapUnavailableError, name unless installed?

  git_repository.last_committed
end

#implicitly_trusted?(remote: self.remote) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Whether to implicitly allow/trust this tap as an official one without it appearing in an allow/trust list. Only when its formulae come from the API or it is a Git checkout of an official remote, so an official-named tap on an untrusted custom remote is not implicitly trusted.

Parameters:

  • remote (String, nil) (defaults to: self.remote)

Returns:

  • (Boolean) 


1447
1448
1449
 
# File 'tap.rb', line 1447

def implicitly_trusted?(remote: self.remote)
  official? && canonical_remote?(remote)
end

#install(quiet: false, clone_target: nil, custom_remote: false, verify: false, force: false) ⇒ void

This method returns an undefined value.

Install this Tap.

Parameters:

  • quiet (Boolean) (defaults to: false) —

    If set, suppress all output.

  • clone_target (Pathname, String, nil) (defaults to: nil) —

    If passed, it will be used as the clone remote.

  • custom_remote (Boolean) (defaults to: false) —

    If set, change the tap's remote if already installed.

  • verify (Boolean) (defaults to: false) —

    If set, verify all the formula, casks and aliases in the tap are valid.

  • force (Boolean) (defaults to: false) —

    If set, force core and cask taps to install even under API mode.

Raises:



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'tap.rb', line 619

def install(quiet: false, clone_target: nil,
            custom_remote: false, verify: false, force: false)
  require "descriptions"
  require "readall"

  if official? && DEPRECATED_OFFICIAL_TAPS.include?(repository)
    odie "#{name} was deprecated. This tap is now empty and all its contents were either deleted or migrated."
  elsif user == "caskroom" || name == "phinze/cask"
    new_repository = (repository == "cask") ? "cask" : "cask-#{repository}"
    odie "#{name} was moved. Tap homebrew/#{new_repository} instead."
  end

  raise TapNoCustomRemoteError, name if custom_remote && clone_target.nil?

  requested_remote = (clone_target || default_remote).to_s

  if installed? && !custom_remote
    raise TapRemoteMismatchError.new(name, @remote, requested_remote) if clone_target && requested_remote != remote
    raise TapAlreadyTappedError, name unless shallow?
  end

  tap_allowed = allowed_by_env?(remote: requested_remote)
  tap_forbidden = forbidden_by_env?(remote: requested_remote)
  if !tap_allowed || tap_forbidden
    owner = Homebrew::EnvConfig.forbidden_owner
    owner_contact = if (contact = Homebrew::EnvConfig.forbidden_owner_contact.presence)
      "\n#{contact}"
    end

    error_message = "The installation of the #{full_name} was requested but #{owner}\n"
    error_message << "has not allowed this tap in `$HOMEBREW_ALLOWED_TAPS`" unless tap_allowed
    error_message << " and\n" if !tap_allowed && tap_forbidden
    error_message << "has forbidden this tap in `$HOMEBREW_FORBIDDEN_TAPS`" if tap_forbidden
    error_message << ".#{owner_contact}"

    odie error_message
  end

  # ensure git is installed
  Utils::Git.ensure_installed!

  use_worktree_source_tap = core_tap? || (core_cask_tap? && clone_target.nil? && !custom_remote)
  worktree_source_tap_path = use_worktree_source_tap ? worktree_source_tap_path_for(path: HOMEBREW_REPOSITORY) : nil

  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:, quiet:)
    end

    config.delete(:forceautoupdate)

    $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
    result = git_command!(args, chdir: path)
    update_remote_from_git_redirect!(result.stderr, quiet:)
    return
  elsif (core_tap? || core_cask_tap?) && !Homebrew::EnvConfig.no_install_from_api? && !force &&
        worktree_source_tap_path.blank?
    odie "Tapping #{name} is no longer typically necessary.\n" \
         "Add #{Formatter.option("--force")} if you are sure you need it for contributing to Homebrew."
  end

  clear_cache
  Tap.clear_cache

  $stderr.ohai "Tapping #{name}" unless quiet
  args = %W[clone #{requested_remote} #{path}]

  # Override possible user configs like:
  #   git config --global clone.defaultRemoteName notorigin
  args << "--origin=origin"
  args << "-q" if quiet

  # Override user-set default template.
  args << "--template="
  # Prevent `fsmonitor` from watching this repository.
  args << "--config" << "core.fsmonitor=false"

  begin
    if worktree_source_tap_path
      # Keep core and cask taps connected to the same local source checkout as brew.
      worktree_args = ["-C", worktree_source_tap_path, "worktree", "add"]
      worktree_args << "--quiet" if quiet
      worktree_args += ["--detach", path, "HEAD"]
      safe_system "git", *worktree_args
    else
      result = git_command!(args)
      update_remote_from_git_redirect!(result.stderr, quiet:)
    end

    if verify && !Homebrew::EnvConfig.developer? && !Readall.valid_tap?(self, aliases: true)
      raise "Cannot tap #{name}: invalid syntax in tap!"
    end
  rescue Interrupt, RuntimeError
    ignore_interrupts do
      # wait for git to possibly cleanup the top directory when interrupt happens.
      sleep 0.1
      FileUtils.rm_rf path
      path.parent.rmdir_if_possible
    end
    raise
  end

  Commands.rebuild_commands_completion_list
  link_completions_and_manpages

  formatted_contents = contents.presence&.to_sentence&.prepend(" ")
  $stderr.puts "Tapped#{formatted_contents} (#{path.abv})." unless quiet

  require "description_cache_store"
  if formula_names.present?
    CacheStoreDatabase.use(:descriptions) do |db|
      DescriptionCacheStore.new(T.cast(db, CacheStoreDatabase[String, T.anything]))
                           .update_from_formula_names!(formula_names)
    end
  end
  if cask_tokens.present?
    CacheStoreDatabase.use(:cask_descriptions) do |db|
      CaskDescriptionCacheStore.new(T.cast(db, CacheStoreDatabase[String, T.anything]))
                               .update_from_cask_tokens!(cask_tokens)
    end
  end

  if official?
    untapped = self.class.untapped_official_taps
    untapped -= [name]

    if untapped.empty?
      Homebrew::Settings.delete :untapped
    else
      Homebrew::Settings.write :untapped, untapped.join(";")
    end
  end

  return if clone_target
  return unless private?
  return if quiet

  path.cd do
    return if Utils.popen_read("git", "config", "--get", "credential.helper").present?
  end

  $stderr.puts <<~EOS
    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
  EOS
end

#installed? ⇒ Boolean

Check whether this Tap is installed.

Returns:

  • (Boolean) 


518
519
520
 
# File 'tap.rb', line 518

def installed?
  path.directory?
end

#issues_url ⇒ String?

The issues URL of this Tap. e.g. https://github.com/user/homebrew-repository/issues

Returns:



466
467
468
469
470
 
# File 'tap.rb', line 466

def issues_url
  return if !official? && custom_remote?

  "#{default_remote}/issues"
end

#link_completions_and_manpages ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.



774
775
776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'tap.rb', line 774

def link_completions_and_manpages
  require "utils/link"

  command = "brew tap --repair"
  Utils::Link.link_manpages(path, command)

  require "completions"
  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

#matches_reference?(reference, remote: self.remote) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

A user/repository reference matches only a tap on its default GitHub remote; a tap with a custom remote must be referenced by URL. The remote keyword matches a not-yet-installed remote.

Parameters:

  • reference (String)
  • remote (String, nil) (defaults to: self.remote)

Returns:

  • (Boolean) 


901
902
903
904
905
906
907
908
 
# File 'tap.rb', line 901

def matches_reference?(reference, remote: self.remote)
  if self.class.remote_reference?(reference)
    self.class.same_remote?(reference, remote)
  else
    uses_custom_remote = remote.present? && !self.class.same_remote?(remote, default_remote)
    !uses_custom_remote && name == reference.downcase
  end
end

#new_cask_path(token) ⇒ Pathname

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



945
946
947
 
# File 'tap.rb', line 945

def new_cask_path(token)
  cask_dir/"#{token.downcase}.rb"
end

#new_formula_path(name) ⇒ Pathname

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



932
933
934
 
# File 'tap.rb', line 932

def new_formula_path(name)
  formula_dir/"#{name.downcase}.rb"
end

#official? ⇒ Boolean

Check whether this Tap is an official Homebrew tap.

Returns:

  • (Boolean) 


476
477
478
 
# File 'tap.rb', line 476

def official?
  user == "Homebrew"
end

#potential_formula_dirs ⇒ Array<Pathname>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



927
928
929
 
# File 'tap.rb', line 927

def potential_formula_dirs
  @potential_formula_dirs ||= T.let([path/"Formula", path/"HomebrewFormula", path].freeze, T.nilable(T::Array[Pathname]))
end

#prefix_to_versioned_formulae_names ⇒ Hash{String => Array<String>}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

A hash of all Formula name prefixes to versioned Formula in this Tap.

Returns:



1075
1076
1077
1078
1079
1080
1081
 
# File 'tap.rb', line 1075

def prefix_to_versioned_formulae_names
  @prefix_to_versioned_formulae_names ||= T.let(formula_names
                                                .select { |name| name.include?("@") }
                                                .group_by { |name| name.sub(/@[\d.]+(?=-full$|$)/, "") }
                                                .transform_values(&:sort)
                                                .freeze, T.nilable(T::Hash[String, T::Array[String]]))
end

#private? ⇒ Boolean

Check whether the remote of this Tap is a private repository.

Returns:

  • (Boolean) 


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'tap.rb', line 484

def private?
  return @private unless @private.nil?

  @private = T.let(
    begin
      if core_tap? || core_cask_tap?
        false
      elsif custom_remote? || (value = GitHub.private_repo?(full_name)).nil?
        true
      else
        value
      end
    rescue GitHub::API::Error
      true
    end,
    T.nilable(T::Boolean),
  )
  T.must(@private)
end

#reference ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

The canonical allow/forbid/trust list reference for this Tap.

Returns:



891
892
893
894
895
896
 
# File 'tap.rb', line 891

def reference
  remote = self.remote
  return name if remote.nil? || !custom_remote?

  remote
end

#relative_cask_path(token) ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



950
951
952
953
 
# File 'tap.rb', line 950

def relative_cask_path(token)
  new_cask_path(token).to_s
                      .delete_prefix("#{path}/")
end

#remote ⇒ String?

The remote path to this Tap. e.g. https://github.com/user/homebrew-repository

Returns:



391
392
393
394
395
 
# File 'tap.rb', line 391

def remote
  return default_remote unless installed?

  @remote ||= T.let(git_repository.origin_url, T.nilable(String))
end

#remote_repository ⇒ String?

The remote repository name of this Tap. e.g. user/homebrew-repository

Returns:



402
403
404
405
406
407
 
# File 'tap.rb', line 402

def remote_repository
  return unless (remote = self.remote)
  return unless (match = remote.match(HOMEBREW_TAP_REPOSITORY_REGEX))

  @remote_repository ||= T.let(T.must(match[:remote_repository]), T.nilable(String))
end

#repository_var_suffix ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



416
417
418
419
420
421
 
# File 'tap.rb', line 416

def repository_var_suffix
  @repository_var_suffix ||= T.let(path.to_s
                                       .delete_prefix(HOMEBREW_TAP_DIRECTORY.to_s)
                                       .tr("^A-Za-z0-9", "_")
                                       .upcase, T.nilable(String))
end

#reverse_tap_migrations_renames ⇒ Hash{String => Array<String>}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
 
# File 'tap.rb', line 1232

def reverse_tap_migrations_renames
  @reverse_tap_migrations_renames ||= T.let(
    tap_migrations.each_with_object({}) do |(old_name, new_name), hash|
      # Only include renames:
      # + `homebrew/cask/water-buffalo`
      # - `homebrew/cask`
      next unless Utils.full_name?(new_name)

      hash[new_name] ||= []
      hash[new_name] << old_name
    end,
    T.nilable(T::Hash[String, T::Array[String]]),
  )
end

#shallow? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Check whether this Tap is a shallow clone.

Returns:

  • (Boolean) 


524
525
526
 
# File 'tap.rb', line 524

def shallow?
  (path/".git/shallow").exist?
end

#should_report_analytics? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean) 


1338
1339
1340
 
# File 'tap.rb', line 1338

def should_report_analytics?
  installed? && !private?
end

#style_exceptions ⇒ Hash{Symbol => T.untyped}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Hash with style exceptions

Returns:



1306
1307
1308
1309
 
# File 'tap.rb', line 1306

def style_exceptions
  @style_exceptions ||= T.let(read_formula_list_directory("#{HOMEBREW_TAP_STYLE_EXCEPTIONS_DIR}/*"),
                              T.nilable(T::Hash[Symbol, T.untyped]))
end

#synced_versions_formulae ⇒ Array<Array<String>>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Array with synced versions formulae

Returns:



1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
 
# File 'tap.rb', line 1313

def synced_versions_formulae
  @synced_versions_formulae ||= T.let(
    if (synced_file = path/HOMEBREW_TAP_SYNCED_VERSIONS_FORMULAE_FILE).file?
      JSON.parse(synced_file.read)
    else
      []
    end,
    T.nilable(T::Array[T::Array[String]]),
  )
end

#tap_migrations ⇒ Hash{String => String}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Hash with tap migrations.

Returns:



1221
1222
1223
1224
1225
1226
1227
1228
1229
 
# File 'tap.rb', line 1221

def tap_migrations
  @tap_migrations ||= T.let(
    if (migration_file = path/HOMEBREW_TAP_MIGRATIONS_FILE).file?
      JSON.parse(migration_file.read)
    else
      {}
    end, T.nilable(T::Hash[String, String])
  )
end

#to_hash ⇒ Hash{String => T.untyped}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'tap.rb', line 1146

def to_hash
  hash = {
    "name"          => name,
    "user"          => user,
    "repo"          => repository,
    "repository"    => repository,
    "path"          => path.to_s,
    "installed"     => installed?,
    "official"      => official?,
    "trusted"       => Homebrew::Trust.trusted_tap?(self),
    "formula_names" => formula_names,
    "cask_tokens"   => cask_tokens,
  }

  if installed?
    hash["formula_files"] = formula_files.map(&:to_s)
    hash["cask_files"] = cask_files.map(&:to_s)
    hash["command_files"] = command_files.map(&:to_s)
    hash["remote"] = remote
    hash["custom_remote"] = custom_remote?
    hash["private"] = private?
    hash["HEAD"] = git_head || "(none)"
    hash["last_commit"] = git_last_commit || "never"
    hash["branch"] = git_branch || "(none)"
  end

  hash
end

#uninstall(manual: false) ⇒ void

This method returns an undefined value.

Uninstall this Tap.

Parameters:

  • manual (Boolean) (defaults to: false)

Raises:



830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
 
# File 'tap.rb', line 830

def uninstall(manual: false)
  require "descriptions"
  raise TapUnavailableError, name unless installed?

  $stderr.puts "Untapping #{name}..."

  abv = path.abv
  formatted_contents = contents.presence&.to_sentence&.prepend(" ")

  require "description_cache_store"
  CacheStoreDatabase.use(:descriptions) do |db|
    DescriptionCacheStore.new(T.cast(db, CacheStoreDatabase[String, T.anything]))
                         .delete_from_formula_names!(formula_names)
  end
  CacheStoreDatabase.use(:cask_descriptions) do |db|
    CaskDescriptionCacheStore.new(T.cast(db, CacheStoreDatabase[String, T.anything]))
                             .delete_from_cask_tokens!(cask_tokens)
  end

  require "utils/link"
  Utils::Link.unlink_manpages(path)
  Utils::Link.unlink_completions(path)
  if (worktree_source_tap_path = worktree_source_tap_path_for(path:))
    safe_system "git", "-C", worktree_source_tap_path, "worktree", "remove", "--force", path
  end
  FileUtils.rm_r(path) if path.exist?
  path.parent.rmdir_if_possible
  $stderr.puts "Untapped#{formatted_contents} (#{abv})."

  Commands.rebuild_commands_completion_list
  clear_cache
  Tap.clear_cache

  return if !manual || !official?

  untapped = self.class.untapped_official_taps
  return if untapped.include? name

  untapped << name
  Homebrew::Settings.write :untapped, untapped.join(";")
end

#update_remote_from_git_redirect!(output, quiet: false) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • output (String)
  • quiet (Boolean) (defaults to: false) 


539
540
541
542
543
544
545
546
 
# File 'tap.rb', line 539

def update_remote_from_git_redirect!(output, quiet: false)
  output.each_line do |line|
    next unless (match = line.match(GIT_REDIRECT_REMOTE_REGEX))

    apply_redirected_remote!(T.must(match[:remote]), quiet:)
    break
  end
end

#uses_custom_remote? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Unlike #custom_remote? this is false when no remote is set, so a remote-less local tap is still matched by its #name rather than requiring a URL.

Returns:

  • (Boolean) 


885
886
887
 
# File 'tap.rb', line 885

def uses_custom_remote?
  remote.present? && custom_remote?
end

#worktree_source_tap_path_for(path:) ⇒ Pathname?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'tap.rb', line 350

def worktree_source_tap_path_for(path:)
  return unless (git_file = path/".git").file?
  return unless (git_dir = git_file.read[/\Agitdir: (.+)\n?\z/, 1])

  git_dir_path = Pathname(git_dir)
  git_dir_path = path/git_dir_path unless git_dir_path.absolute?

  # A linked worktree points at `<source>/.git/worktrees/<name>`, so use
  # the matching source tap when it is already checked out there.
  if git_dir_path.dirname.dirname.basename.to_s == ".git" && git_dir_path.dirname.basename.to_s == "worktrees"
    source_path = git_dir_path.dirname.dirname.dirname
    return source_path if path != HOMEBREW_REPOSITORY

    candidate_source_tap_path = source_path/"Library/Taps/#{full_name.downcase}"
    return candidate_source_tap_path if (candidate_source_tap_path/".git").exist?

  end

  Utils.popen_read("git", "-C", path, "worktree", "list", "--porcelain")
       .each_line do |line|
    next unless line.start_with?("worktree ")

    candidate_source_tap_path = Pathname(line.delete_prefix("worktree ").chomp)/"Library/Taps/#{full_name.downcase}"
    return candidate_source_tap_path if (candidate_source_tap_path/".git").exist?
  end

  nil
end