Class: Tap Private

Inherits:
Object show all
Extended by:
Cachable, Enumerable
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 extend the formulae provided by Homebrew core. 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

TAP_DIRECTORY =

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.

(HOMEBREW_LIBRARY/"Taps").freeze
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.

%W[
  #{HOMEBREW_TAP_FORMULA_RENAMES_FILE}
  #{HOMEBREW_TAP_CASK_RENAMES_FILE}
  #{HOMEBREW_TAP_MIGRATIONS_FILE}
  #{HOMEBREW_TAP_PYPI_FORMULA_MAPPINGS_FILE}
  #{HOMEBREW_TAP_SYNCED_VERSIONS_FORMULAE_FILE}
  #{HOMEBREW_TAP_AUDIT_EXCEPTIONS_DIR}/*.json
  #{HOMEBREW_TAP_STYLE_EXCEPTIONS_DIR}/*.json
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Cachable

cache

Methods included from Enumerable

compact_blank, exclude?

Constructor Details

#initialize(user, repository) ⇒ 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 a new instance of Tap.



199
200
201
202
203
204
205
206
# File 'tap.rb', line 199

def initialize(user, repository)
  @user = user
  @repository = repository
  @name = "#{@user}/#{@repository}".downcase
  @full_name = "#{@user}/homebrew-#{@repository}"
  @path = TAP_DIRECTORY/@full_name.downcase
  @git_repository = GitRepository.new(@path)
end

Instance Attribute Details

#full_nameObject (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



183
184
185
# File 'tap.rb', line 183

def full_name
  @full_name
end

#git_repositoryGitRepository (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:



194
195
196
# File 'tap.rb', line 194

def git_repository
  @git_repository
end

#nameObject (readonly)

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



172
173
174
# File 'tap.rb', line 172

def name
  @name
end

#pathPathname (readonly)

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

Returns:



190
191
192
# File 'tap.rb', line 190

def path
  @path
end

#repositoryObject (readonly) Also known as: repo

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



163
164
165
# File 'tap.rb', line 163

def repository
  @repository
end

#userObject (readonly)

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



158
159
160
# File 'tap.rb', line 158

def user
  @user
end

Class Method Details

.allArray<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:



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
# File 'tap.rb', line 1025

def self.all
  cache[:all] ||= begin
    core_taps = [
      CoreTap.instance,
      (CoreCaskTap.instance if OS.mac?), # rubocop:disable Homebrew/MoveToExtendOS
    ].compact

    installed | core_taps
  end
end

.allowed_tapsSet<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:



122
123
124
125
126
127
128
129
130
131
132
133
134
# File 'tap.rb', line 122

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

    Set.new(allowed_tap_list.filter_map do |tap|
      Tap.fetch(tap)
    rescue Tap::InvalidNameError
      opoo "Invalid tap name in `HOMEBREW_ALLOWED_TAPS`: #{tap}"
      nil
    end).freeze
  end
end

.cmd_directoriesArray<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 tap cmd directory Pathnames.

Returns:



1057
1058
1059
# File 'tap.rb', line 1057

def self.cmd_directories
  Pathname.glob TAP_DIRECTORY/"*/*/cmd"
end

.each(&block) ⇒ Object

Enumerate all available Taps.



1039
1040
1041
1042
1043
1044
1045
# File 'tap.rb', line 1039

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

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

Fetch a Tap by name.

Parameters:

Returns:



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

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

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

  user = T.must(user)
  repo = T.must(repo)

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

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

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

.forbidden_tapsSet<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:



137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'tap.rb', line 137

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

    Set.new(forbidden_tap_list.filter_map do |tap|
      Tap.fetch(tap)
    rescue Tap::InvalidNameError
      opoo "Invalid tap name in `HOMEBREW_FORBIDDEN_TAPS`: #{tap}"
      nil
    end).freeze
  end
end

.from_path(path) ⇒ Object

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



81
82
83
84
85
86
87
88
89
# File 'tap.rb', line 81

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 (repo = match[:repo])

  fetch(user, repo)
end

.installedArray<Tap>

All locally installed taps.

Returns:



1015
1016
1017
1018
1019
1020
1021
# File 'tap.rb', line 1015

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

.namesArray<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 installed Tap names.

Returns:



1049
1050
1051
1052
1053
# File 'tap.rb', line 1049

def self.names
  odeprecated "`#{self}.names`"

  map(&:name).sort
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:



940
941
942
943
944
945
946
947
948
# File 'tap.rb', line 940

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_tapsArray<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:



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

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:



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

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

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

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

  tap = fetch(user, repo)
  [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:



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

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

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

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

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

Instance Method Details

#alias_dirPathname

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:



804
805
806
# File 'tap.rb', line 804

def alias_dir
  @alias_dir ||= path/"Aliases"
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:



1073
1074
1075
# File 'tap.rb', line 1073

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

#alias_filesArray<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:



810
811
812
# File 'tap.rb', line 810

def alias_files
  @alias_files ||= Pathname.glob("#{alias_dir}/*").select(&:file?)
end

#alias_reverse_tableHash{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:



830
831
832
833
834
835
# File 'tap.rb', line 830

def alias_reverse_table
  @alias_reverse_table ||= 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
end

#alias_tableHash{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:



822
823
824
825
826
# File 'tap.rb', line 822

def alias_table
  @alias_table ||= alias_files.each_with_object({}) do |alias_file, alias_table|
    alias_table[alias_file_to_name(alias_file)] = formula_file_to_name(alias_file.resolved_path)
  end
end

#aliasesArray<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:



816
817
818
# File 'tap.rb', line 816

def aliases
  @aliases ||= alias_table.keys
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)


962
963
964
# File 'tap.rb', line 962

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

#allowed_by_env?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)


1095
1096
1097
1098
1099
1100
1101
# File 'tap.rb', line 1095

def allowed_by_env?
  @allowed_by_env ||= begin
    allowed_taps = self.class.allowed_taps

    official? || allowed_taps.blank? || allowed_taps.include?(self)
  end
end

#audit_exception(list, formula_or_cask, value = nil) ⇒ Object

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.



1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
# File 'tap.rb', line 1077

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

#audit_exceptionsHash

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:



968
969
970
# File 'tap.rb', line 968

def audit_exceptions
  @audit_exceptions ||= read_formula_list_directory("#{HOMEBREW_TAP_AUDIT_EXCEPTIONS_DIR}/*")
end

#autobumpArray<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:



952
953
954
955
956
957
958
# File 'tap.rb', line 952

def autobump
  @autobump ||= if (autobump_file = path/HOMEBREW_TAP_AUTOBUMP_FILE).file?
    autobump_file.readlines(chomp: true)
  else
    []
  end
end

#cask_dirPathname

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

Returns:



669
670
671
# File 'tap.rb', line 669

def cask_dir
  @cask_dir ||= path/"Casks"
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.

Check whether the given path would present a Cask file in this Tap. Accepts either an absolute path or a path relative to this Tap's path.

Parameters:

Returns:

  • (Boolean)


772
773
774
775
776
777
778
# File 'tap.rb', line 772

def cask_file?(file)
  file = Pathname.new(file) unless file.is_a? Pathname
  file = file.expand_path(path)
  return false unless ruby_file?(file)

  file.to_s.start_with?("#{cask_dir}/")
end

#cask_filesArray<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:



731
732
733
734
735
736
737
# File 'tap.rb', line 731

def cask_files
  @cask_files ||= if cask_dir.directory?
    cask_dir.find.select { ruby_file?(_1) }
  else
    []
  end
end

#cask_files_by_nameHash{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:



741
742
743
744
745
746
747
748
# File 'tap.rb', line 741

def cask_files_by_name
  @cask_files_by_name ||= 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
end

#cask_renamesHash{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:



879
880
881
882
883
884
885
# File 'tap.rb', line 879

def cask_renames
  @cask_renames ||= if (rename_file = path/HOMEBREW_TAP_CASK_RENAMES_FILE).file?
    JSON.parse(rename_file.read)
  else
    {}
  end
end

#cask_reverse_renamesHash{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:



889
890
891
892
893
894
# File 'tap.rb', line 889

def cask_reverse_renames
  @cask_reverse_renames ||= cask_renames.each_with_object({}) do |(old_name, new_name), hash|
    hash[new_name] ||= []
    hash[new_name] << old_name
  end
end

#cask_tokensArray<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:



798
799
800
# File 'tap.rb', line 798

def cask_tokens
  @cask_tokens ||= cask_files.map { formula_file_to_name(_1) }
end

#clear_cacheObject

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.

Clear internal cache.



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'tap.rb', line 209

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
  @pypi_formula_mappings = nil
  @synced_versions_formulae = nil

  @config = nil
  @spell_checker = nil
end

#command_dirPathname

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:



838
839
840
# File 'tap.rb', line 838

def command_dir
  @command_dir ||= path/"cmd"
end

#command_filesArray<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:



844
845
846
847
848
849
850
# File 'tap.rb', line 844

def command_files
  @command_files ||= if command_dir.directory?
    Commands.find_commands(command_dir)
  else
    []
  end
end

#configTapConfig

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:



377
378
379
380
381
382
383
# File 'tap.rb', line 377

def config
  @config ||= begin
    raise TapUnavailableError, name unless installed?

    TapConfig.new(self)
  end
end

#contentsObject

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.



684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'tap.rb', line 684

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, plural: "e", 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)


404
405
406
# File 'tap.rb', line 404

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)


399
400
401
# File 'tap.rb', line 399

def core_tap?
  false
end

#custom_remote?Boolean

Check whether the #remote of Tap is customized.

Returns:

  • (Boolean)


636
637
638
639
640
# File 'tap.rb', line 636

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

  !remote.casecmp(default_remote).zero?
end

#default_remoteString

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:



282
283
284
# File 'tap.rb', line 282

def default_remote
  "https://github.com/#{full_name}"
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.



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

def ensure_installed!
  return if installed?

  install
end

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

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.



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 561

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 = T.must(git_repository.origin_branch_name)
  return if 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/*"
  safe_system "git", "-C", path, *args
  git_repository.set_head_origin_auto

  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?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)


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

def forbidden_by_env?
  @forbidden_by_env ||= self.class.forbidden_taps.include?(self)
end

#formula_dirPathname

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

Returns:



646
647
648
649
650
651
652
653
# File 'tap.rb', line 646

def formula_dir
  # Official formulae taps always use this directory, saves time to hardcode.
  @formula_dir ||= if official?
    path/"Formula"
  else
    potential_formula_dirs.find(&:directory?) || (path/"Formula")
  end
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.

Check whether the given path would present a Formula file in this Tap. Accepts either an absolute path or a path relative to this Tap's path.

Parameters:

Returns:

  • (Boolean)


760
761
762
763
764
765
766
767
# File 'tap.rb', line 760

def formula_file?(file)
  file = Pathname.new(file) unless file.is_a? Pathname
  file = file.expand_path(path)
  return false unless ruby_file?(file)
  return false if cask_file?(file)

  file.to_s.start_with?("#{formula_dir}/")
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:



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

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

#formula_filesArray<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:



704
705
706
707
708
709
710
711
712
713
714
715
716
# File 'tap.rb', line 704

def formula_files
  @formula_files ||= 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/.
      formula_dir.children
    else
      formula_dir.find
    end.select { formula_file?(_1) }
  else
    []
  end
end

#formula_files_by_nameHash{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:



720
721
722
723
724
725
726
727
# File 'tap.rb', line 720

def formula_files_by_name
  @formula_files_by_name ||= 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
end

#formula_namesArray<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:



782
783
784
# File 'tap.rb', line 782

def formula_names
  @formula_names ||= formula_files.map { formula_file_to_name(_1) }
end

#formula_renamesHash{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:



898
899
900
901
902
903
904
# File 'tap.rb', line 898

def formula_renames
  @formula_renames ||= if (rename_file = path/HOMEBREW_TAP_FORMULA_RENAMES_FILE).file?
    JSON.parse(rename_file.read)
  else
    {}
  end
end

#formula_reverse_renamesHash{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:



908
909
910
911
912
913
# File 'tap.rb', line 908

def formula_reverse_renames
  @formula_reverse_renames ||= formula_renames.each_with_object({}) do |(old_name, new_name), hash|
    hash[new_name] ||= []
    hash[new_name] << old_name
  end
end

#git?Boolean

Check whether this Tap is a Git repository.

Returns:

  • (Boolean)


299
300
301
# File 'tap.rb', line 299

def git?
  git_repository.git_repository?
end

#git_branchObject

Git branch for this Tap.



306
307
308
309
310
# File 'tap.rb', line 306

def git_branch
  raise TapUnavailableError, name unless installed?

  git_repository.branch_name
end

#git_headObject

Git HEAD for this Tap.



315
316
317
318
319
# File 'tap.rb', line 315

def git_head
  raise TapUnavailableError, name unless installed?

  @git_head ||= git_repository.head_ref
end

#git_last_commitObject

Time since last git commit for this Tap.



324
325
326
327
328
# File 'tap.rb', line 324

def git_last_commit
  raise TapUnavailableError, name unless installed?

  git_repository.last_committed
end

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

Install this Tap.

Parameters:

  • clone_target (String) (defaults to: nil)

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

  • quiet (Boolean) (defaults to: false)

    If set, suppress all output.

  • 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:



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
# File 'tap.rb', line 417

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

  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."
  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 unless shallow?
  end

  if !allowed_by_env? || forbidden_by_env?
    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 allowed_by_env?
    error_message << " and\n" if !allowed_by_env? && forbidden_by_env?
    error_message << "has forbidden this tap in `HOMEBREW_FORBIDDEN_TAPS`" if forbidden_by_env?
    error_message << ".#{owner_contact}"

    odie error_message
  end

  # ensure git is installed
  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:, 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
    path.cd { safe_system "git", *args }
    return
  elsif (core_tap? || core_cask_tap?) && !Homebrew::EnvConfig.no_install_from_api? && !force
    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
    safe_system "git", *args

    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&.dup&.prepend(" ")
  $stderr.puts "Tapped#{formatted_contents} (#{path.abv})." unless quiet
  CacheStoreDatabase.use(:descriptions) do |db|
    DescriptionCacheStore.new(db)
                         .update_from_formula_names!(formula_names)
  end
  CacheStoreDatabase.use(:cask_descriptions) do |db|
    CaskDescriptionCacheStore.new(db)
                             .update_from_cask_tokens!(cask_tokens)
  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)


389
390
391
# File 'tap.rb', line 389

def installed?
  path.directory?
end

#issues_urlString?

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

Returns:



335
336
337
338
339
# File 'tap.rb', line 335

def issues_url
  return if !official? && custom_remote?

  "#{default_remote}/issues"
end

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.



549
550
551
552
553
554
555
556
557
558
559
# File 'tap.rb', line 549

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

#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:



674
675
676
# File 'tap.rb', line 674

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:



661
662
663
# File 'tap.rb', line 661

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

#official?Boolean

Check whether this Tap is an official Homebrew tap.

Returns:

  • (Boolean)


344
345
346
# File 'tap.rb', line 344

def official?
  user == "Homebrew"
end

#potential_formula_dirsArray<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:



656
657
658
# File 'tap.rb', line 656

def potential_formula_dirs
  @potential_formula_dirs ||= [path/"Formula", path/"HomebrewFormula", path].freeze
end

#prefix_to_versioned_formulae_namesHash{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:



788
789
790
791
792
793
794
# File 'tap.rb', line 788

def prefix_to_versioned_formulae_names
  @prefix_to_versioned_formulae_names ||= formula_names
                                          .select { |name| name.include?("@") }
                                          .group_by { |name| name.gsub(/(@[\d.]+)?$/, "") }
                                          .transform_values(&:sort)
                                          .freeze
end

#private?Boolean

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

Returns:

  • (Boolean)


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

def private?
  return @private if defined?(@private)

  @private = if (value = config[:private]).nil?
    config[:private] = begin
      if custom_remote?
        true
      else
        # Don't store config if we don't know for sure.
        return false if (value = GitHub.private_repo?(full_name)).nil?

        value
      end
    rescue GitHub::API::HTTPNotFoundError
      true
    rescue GitHub::API::Error
      false
    end
  else
    value
  end
end

#pypi_formula_mappingsHash

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 pypi formula mappings

Returns:



980
981
982
# File 'tap.rb', line 980

def pypi_formula_mappings
  @pypi_formula_mappings ||= read_formula_list(path/HOMEBREW_TAP_PYPI_FORMULA_MAPPINGS_FILE)
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:



679
680
681
682
# File 'tap.rb', line 679

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

#remoteObject

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



261
262
263
264
265
# File 'tap.rb', line 261

def remote
  return default_remote unless installed?

  @remote ||= git_repository.origin_url
end

#remote_repoString?

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

Returns:



272
273
274
275
276
277
278
# File 'tap.rb', line 272

def remote_repo
  return unless (remote = self.remote)

  @remote_repo ||= remote.delete_prefix("https://github.com/")
                         .delete_prefix("git@github.com:")
                         .delete_suffix(".git")
end

#repository_var_suffixString Also known as: repo_var_suffix

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:



287
288
289
290
291
292
# File 'tap.rb', line 287

def repository_var_suffix
  @repository_var_suffix ||= path.to_s
                                 .delete_prefix(TAP_DIRECTORY.to_s)
                                 .tr("^A-Za-z0-9", "_")
                                 .upcase
end

#reverse_tap_migrations_renamesHash{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:



926
927
928
929
930
931
932
933
934
935
936
# File 'tap.rb', line 926

def reverse_tap_migrations_renames
  @reverse_tap_migrations_renames ||= tap_migrations.each_with_object({}) do |(old_name, new_name), hash|
    # Only include renames:
    # + `homebrew/cask/water-buffalo`
    # - `homebrew/cask`
    next if new_name.count("/") != 2

    hash[new_name] ||= []
    hash[new_name] << old_name
  end
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)


394
395
396
# File 'tap.rb', line 394

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)


995
996
997
# File 'tap.rb', line 995

def should_report_analytics?
  installed? && !private?
end

#style_exceptionsHash

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:



974
975
976
# File 'tap.rb', line 974

def style_exceptions
  @style_exceptions ||= read_formula_list_directory("#{HOMEBREW_TAP_STYLE_EXCEPTIONS_DIR}/*")
end

#synced_versions_formulaeArray<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:



986
987
988
989
990
991
992
# File 'tap.rb', line 986

def synced_versions_formulae
  @synced_versions_formulae ||= if (synced_file = path/HOMEBREW_TAP_SYNCED_VERSIONS_FORMULAE_FILE).file?
    JSON.parse(synced_file.read)
  else
    []
  end
end

#tap_migrationsHash{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:



917
918
919
920
921
922
923
# File 'tap.rb', line 917

def tap_migrations
  @tap_migrations ||= if (migration_file = path/HOMEBREW_TAP_MIGRATIONS_FILE).file?
    JSON.parse(migration_file.read)
  else
    {}
  end
end

#to_hashHash

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:



853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
# File 'tap.rb', line 853

def to_hash
  hash = {
    "name"          => name,
    "user"          => user,
    "repo"          => repo,
    "path"          => path.to_s,
    "installed"     => installed?,
    "official"      => official?,
    "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?
  end

  hash
end

#uninstall(manual: false) ⇒ Object

Uninstall this Tap.



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
# File 'tap.rb', line 596

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

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

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

  CacheStoreDatabase.use(:descriptions) do |db|
    DescriptionCacheStore.new(db)
                         .delete_from_formula_names!(formula_names)
  end
  CacheStoreDatabase.use(:cask_descriptions) do |db|
    CaskDescriptionCacheStore.new(db)
                             .delete_from_cask_tokens!(cask_tokens)
  end
  Utils::Link.unlink_manpages(path)
  Utils::Link.unlink_completions(path)
  path.rmtree
  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