Class: Tap Private
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
Defined Under Namespace
Classes: InvalidNameError
Constant Summary collapse
- 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
-
#full_name ⇒ Object
readonly
The full name of this Tap, including the
homebrew-
prefix. -
#git_repository ⇒ GitRepository
readonly
private
The git repository of this Tap.
-
#name ⇒ Object
readonly
The name of this Tap.
-
#path ⇒ Pathname
readonly
The local path to this Tap.
-
#repository ⇒ Object
(also: #repo)
readonly
The repository name of this Tap without the leading
homebrew-
. -
#user ⇒ Object
readonly
The user name of this Tap.
Class Method Summary collapse
-
.all ⇒ Array<Tap>
private
All locally installed and core taps.
- .allowed_taps ⇒ Set<Tap> private
-
.each(&block) ⇒ Object
Enumerate all available Taps.
-
.fetch(user, repo = T.unsafe(nil)) ⇒ Tap
Fetch a Tap by name.
- .forbidden_taps ⇒ Set<Tap> private
-
.from_path(path) ⇒ Object
Get a Tap from its path or a path inside of it.
-
.installed ⇒ Array<Tap>
All locally installed taps.
-
.names ⇒ Array<String>
private
An array of all installed Tap names.
-
.tap_migration_oldnames(current_tap, name_or_token) ⇒ Array<String>
private
The old names a formula or cask had before getting migrated to the current tap.
-
.untapped_official_taps ⇒ Array<String>
private
An array of official taps that have been manually untapped.
- .with_cask_token(token) ⇒ Array<(Tap, String)>? private
- .with_formula_name(name) ⇒ Array<(Tap, String)>? private
Instance Method Summary collapse
-
#alias_dir ⇒ Pathname
private
Path to the directory of all alias files for this Tap.
- #alias_file_to_name(file) ⇒ String private
-
#alias_files ⇒ Array<Pathname>
private
An array of all alias files of this Tap.
-
#alias_reverse_table ⇒ Hash{String => Array<String>}
private
Mapping from formula names to aliases.
-
#alias_table ⇒ Hash{String => String}
private
Mapping from aliases to formula names.
-
#aliases ⇒ Array<String>
private
An array of all aliases of this Tap.
- #allow_bump?(formula_or_cask_name) ⇒ Boolean private
- #allowed_by_env? ⇒ Boolean private
- #audit_exception(list, formula_or_cask, value = nil) ⇒ Object private
-
#audit_exceptions ⇒ Hash
private
Hash with audit exceptions.
-
#autobump ⇒ Array<String>
private
Array with autobump names.
- #cask_dir ⇒ Pathname
-
#cask_file?(file) ⇒ Boolean
private
accepts the relative path of a file from Tap's path.
- #cask_files ⇒ Array<Pathname> private
- #cask_files_by_name ⇒ Hash{String => Pathname} private
-
#cask_renames ⇒ Hash{String => String}
private
Hash with tap cask renames.
-
#cask_reverse_renames ⇒ Hash{String => Array<String>}
private
Mapping from new to old cask tokens.
- #cask_tokens ⇒ Array<String> private
-
#clear_cache ⇒ Object
private
Clear internal cache.
- #command_dir ⇒ Pathname private
-
#command_files ⇒ Array<Pathname>
private
An array of all commands files of this Tap.
- #config ⇒ TapConfig private
- #contents ⇒ Object private
- #core_cask_tap? ⇒ Boolean private
- #core_tap? ⇒ Boolean private
- #custom_remote? ⇒ Boolean
-
#default_remote ⇒ String
private
The default remote path to this Tap.
- #ensure_installed! ⇒ void private
- #fix_remote_configuration(requested_remote: nil, quiet: false) ⇒ Object private
- #forbidden_by_env? ⇒ Boolean private
- #formula_dir ⇒ Pathname
-
#formula_file?(file) ⇒ Boolean
private
accepts the relative path of a file from Tap's path.
- #formula_file_to_name(file) ⇒ String private
- #formula_files ⇒ Array<Pathname> private
- #formula_files_by_name ⇒ Hash{String => Pathname} private
- #formula_names ⇒ Array<String> private
-
#formula_renames ⇒ Hash{String => String}
private
Hash with tap formula renames.
-
#formula_reverse_renames ⇒ Hash{String => Array<String>}
private
Mapping from new to old formula names.
-
#git? ⇒ Boolean
Check whether this Tap is a Git repository.
-
#git_branch ⇒ Object
Git branch for this Tap.
-
#git_head ⇒ Object
Git HEAD for this Tap.
-
#git_last_commit ⇒ Object
Time since last git commit for this Tap.
-
#initialize(user, repository) ⇒ Tap
constructor
private
A new instance of Tap.
-
#install(quiet: false, clone_target: nil, custom_remote: false, verify: false, force: false) ⇒ Object
Install this Tap.
-
#installed? ⇒ Boolean
Check whether this Tap is installed.
-
#issues_url ⇒ String?
The issues URL of this Tap.
- #link_completions_and_manpages ⇒ Object private
- #new_cask_path(token) ⇒ Pathname private
- #new_formula_path(name) ⇒ Pathname private
-
#official? ⇒ Boolean
Check whether this Tap is an official Homebrew tap.
- #potential_formula_dirs ⇒ Array<Pathname> private
- #prefix_to_versioned_formulae_names ⇒ Hash{String => Array<String>} private
-
#private? ⇒ Boolean
Check whether the remote of this Tap is a private repository.
-
#pypi_formula_mappings ⇒ Hash
private
Hash with pypi formula mappings.
- #relative_cask_path(token) ⇒ String private
-
#remote ⇒ Object
The remote path to this Tap.
-
#remote_repo ⇒ String?
The remote repository name of this Tap.
- #repository_var_suffix ⇒ String (also: #repo_var_suffix) private
- #reverse_tap_migrations_renames ⇒ Hash{String => Array<String>} private
-
#shallow? ⇒ Boolean
private
Check whether this Tap is a shallow clone.
- #should_report_analytics? ⇒ Boolean private
-
#style_exceptions ⇒ Hash
private
Hash with style exceptions.
-
#synced_versions_formulae ⇒ Array<Array<String>>
private
Array with synced versions formulae.
-
#tap_migrations ⇒ Hash{String => String}
private
Hash with tap migrations.
- #to_hash ⇒ Hash private
-
#uninstall(manual: false) ⇒ Object
Uninstall this Tap.
Methods included from Cachable
Methods included from Enumerable
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.
195 196 197 198 199 200 201 202 203 204 |
# File 'tap.rb', line 195 def initialize(user, repository) require "git_repository" @user = user @repository = repository @name = "#{@user}/#{@repository}".downcase @full_name = "#{@user}/homebrew-#{@repository}" @path = HOMEBREW_TAP_DIRECTORY/@full_name.downcase @git_repository = GitRepository.new(@path) end |
Instance Attribute Details
#full_name ⇒ Object (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
179 180 181 |
# File 'tap.rb', line 179 def full_name @full_name 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.
190 191 192 |
# File 'tap.rb', line 190 def git_repository @git_repository end |
#name ⇒ Object (readonly)
The name of this Tap. It combines #user and #repository with a slash.
#name is always in lowercase.
e.g. user/repository
168 169 170 |
# File 'tap.rb', line 168 def name @name end |
#path ⇒ Pathname (readonly)
The local path to this Tap.
e.g. /usr/local/Library/Taps/user/homebrew-repository
186 187 188 |
# File 'tap.rb', line 186 def path @path 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.
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 |
# File 'tap.rb', line 1037 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_taps ⇒ Set<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.
118 119 120 121 122 123 124 125 126 127 128 129 130 |
# File 'tap.rb', line 118 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 |
.each(&block) ⇒ Object
Enumerate all available Taps.
1051 1052 1053 1054 1055 1056 1057 |
# File 'tap.rb', line 1051 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.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'tap.rb', line 53 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_taps ⇒ Set<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.
133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'tap.rb', line 133 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.
77 78 79 80 81 82 83 84 85 |
# File 'tap.rb', line 77 def self.from_path(path) match = File.(path).match(HOMEBREW_TAP_PATH_REGEX) return unless match return unless (user = match[:user]) return unless (repo = match[:repo]) fetch(user, repo) end |
.installed ⇒ Array<Tap>
All locally installed taps.
1027 1028 1029 1030 1031 1032 1033 |
# File 'tap.rb', line 1027 def self.installed cache[:installed] ||= if HOMEBREW_TAP_DIRECTORY.directory? HOMEBREW_TAP_DIRECTORY.subdirs.flat_map(&:subdirs).map { from_path(_1) } else [] end end |
.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 installed Tap names.
1061 1062 1063 1064 1065 |
# File 'tap.rb', line 1061 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.
952 953 954 955 956 957 958 959 960 |
# File 'tap.rb', line 952 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
1069 1070 1071 |
# File 'tap.rb', line 1069 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.
103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'tap.rb', line 103 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.
88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'tap.rb', line 88 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_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.
816 817 818 |
# File 'tap.rb', line 816 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.
1079 1080 1081 |
# File 'tap.rb', line 1079 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.
822 823 824 |
# File 'tap.rb', line 822 def alias_files @alias_files ||= Pathname.glob("#{alias_dir}/*").select(&:file?) 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.
842 843 844 845 846 847 |
# File 'tap.rb', line 842 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_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.
834 835 836 837 838 |
# File 'tap.rb', line 834 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 |
#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.
828 829 830 |
# File 'tap.rb', line 828 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.
974 975 976 |
# File 'tap.rb', line 974 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.
1101 1102 1103 1104 1105 1106 1107 |
# File 'tap.rb', line 1101 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.
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 |
# File 'tap.rb', line 1083 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_exceptions ⇒ Hash
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
980 981 982 |
# File 'tap.rb', line 980 def audit_exceptions @audit_exceptions ||= read_formula_list_directory("#{HOMEBREW_TAP_AUDIT_EXCEPTIONS_DIR}/*") 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
964 965 966 967 968 969 970 |
# File 'tap.rb', line 964 def autobump @autobump ||= if (autobump_file = path/HOMEBREW_TAP_AUTOBUMP_FILE).file? autobump_file.readlines(chomp: true) else [] end end |
#cask_dir ⇒ Pathname
675 676 677 |
# File 'tap.rb', line 675 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.
accepts the relative path of a file from Tap's path
788 789 790 |
# File 'tap.rb', line 788 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.
737 738 739 740 741 742 743 |
# File 'tap.rb', line 737 def cask_files @cask_files ||= if cask_dir.directory? Pathname.glob(cask_dir/"**/*.rb") else [] end 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.
747 748 749 750 751 752 753 754 |
# File 'tap.rb', line 747 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_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.
891 892 893 894 895 896 897 |
# File 'tap.rb', line 891 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_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.
901 902 903 904 905 906 |
# File 'tap.rb', line 901 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_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.
810 811 812 |
# File 'tap.rb', line 810 def cask_tokens @cask_tokens ||= cask_files.map { formula_file_to_name(_1) } end |
#clear_cache ⇒ 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.
Clear internal cache.
207 208 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 |
# File 'tap.rb', line 207 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_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.
850 851 852 |
# File 'tap.rb', line 850 def command_dir @command_dir ||= path/"cmd" 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.
856 857 858 859 860 861 862 |
# File 'tap.rb', line 856 def command_files @command_files ||= if command_dir.directory? Commands.find_commands(command_dir) else [] end 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.
375 376 377 378 379 380 381 |
# File 'tap.rb', line 375 def config @config ||= begin raise TapUnavailableError, name unless installed? TapConfig.new(self) end end |
#contents ⇒ 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.
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 |
# File 'tap.rb', line 690 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.
402 403 404 |
# File 'tap.rb', line 402 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.
397 398 399 |
# File 'tap.rb', line 397 def core_tap? false end |
#custom_remote? ⇒ Boolean
642 643 644 645 646 |
# File 'tap.rb', line 642 def custom_remote? return true unless (remote = self.remote) !remote.casecmp(default_remote).zero? 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.
280 281 282 |
# File 'tap.rb', line 280 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.
249 250 251 252 253 |
# File 'tap.rb', line 249 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.
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 592 593 594 |
# File 'tap.rb', line 564 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.
1110 1111 1112 |
# File 'tap.rb', line 1110 def forbidden_by_env? @forbidden_by_env ||= self.class.forbidden_taps.include?(self) end |
#formula_dir ⇒ Pathname
652 653 654 655 656 657 658 659 |
# File 'tap.rb', line 652 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.
accepts the relative path of a file from Tap's path
779 780 781 |
# File 'tap.rb', line 779 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.
1074 1075 1076 |
# File 'tap.rb', line 1074 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.
710 711 712 713 714 715 716 717 718 719 720 721 722 |
# File 'tap.rb', line 710 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/. Pathname.glob(formula_dir/"*.rb") else Pathname.glob(formula_dir/"**/*.rb") end else [] end 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.
726 727 728 729 730 731 732 733 |
# File 'tap.rb', line 726 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_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.
794 795 796 |
# File 'tap.rb', line 794 def formula_names @formula_names ||= formula_files.map { formula_file_to_name(_1) } 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.
910 911 912 913 914 915 916 |
# File 'tap.rb', line 910 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_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.
920 921 922 923 924 925 |
# File 'tap.rb', line 920 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.
297 298 299 |
# File 'tap.rb', line 297 def git? git_repository.git_repository? end |
#git_branch ⇒ Object
Git branch for this Tap.
304 305 306 307 308 |
# File 'tap.rb', line 304 def git_branch raise TapUnavailableError, name unless installed? git_repository.branch_name end |
#git_head ⇒ Object
Git HEAD for this Tap.
313 314 315 316 317 |
# File 'tap.rb', line 313 def git_head raise TapUnavailableError, name unless installed? @git_head ||= git_repository.head_ref end |
#git_last_commit ⇒ Object
Time since last git commit for this Tap.
322 323 324 325 326 |
# File 'tap.rb', line 322 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.
415 416 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 415 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 = +"The installation of the #{full_name} was requested but #{owner}\n" << "has not allowed this tap in `HOMEBREW_ALLOWED_TAPS`" unless allowed_by_env? << " and\n" if !allowed_by_env? && forbidden_by_env? << "has forbidden this tap in `HOMEBREW_FORBIDDEN_TAPS`" if forbidden_by_env? << ".#{owner_contact}" odie 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 require "description_cache_store" 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.
387 388 389 |
# File 'tap.rb', line 387 def installed? path.directory? end |
#issues_url ⇒ String?
The issues URL of this Tap.
e.g. https://github.com/user/homebrew-repo/issues
333 334 335 336 337 |
# File 'tap.rb', line 333 def issues_url return if !official? && custom_remote? "#{default_remote}/issues" end |
#link_completions_and_manpages ⇒ 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.
549 550 551 552 553 554 555 556 557 558 559 560 561 562 |
# File 'tap.rb', line 549 def link_completions_and_manpages require "utils/link" command = "brew tap --repair" Utils::Link.link_manpages(path, command) require "completions" Homebrew::Completions. 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.
680 681 682 |
# File 'tap.rb', line 680 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.
667 668 669 |
# File 'tap.rb', line 667 def new_formula_path(name) formula_dir/"#{name.downcase}.rb" end |
#official? ⇒ Boolean
Check whether this Tap is an official Homebrew tap.
342 343 344 |
# File 'tap.rb', line 342 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.
662 663 664 |
# File 'tap.rb', line 662 def potential_formula_dirs @potential_formula_dirs ||= [path/"Formula", path/"HomebrewFormula", path].freeze 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.
800 801 802 803 804 805 806 |
# File 'tap.rb', line 800 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.
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 |
# File 'tap.rb', line 350 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_mappings ⇒ Hash
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
992 993 994 |
# File 'tap.rb', line 992 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.
685 686 687 688 |
# File 'tap.rb', line 685 def relative_cask_path(token) new_cask_path(token).to_s .delete_prefix("#{path}/") end |
#remote ⇒ Object
The remote path to this Tap.
e.g. https://github.com/user/homebrew-repository
259 260 261 262 263 |
# File 'tap.rb', line 259 def remote return default_remote unless installed? @remote ||= git_repository.origin_url end |
#remote_repo ⇒ String?
The remote repository name of this Tap.
e.g. user/homebrew-repository
270 271 272 273 274 275 276 |
# File 'tap.rb', line 270 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_suffix ⇒ String 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.
285 286 287 288 289 290 |
# File 'tap.rb', line 285 def repository_var_suffix @repository_var_suffix ||= path.to_s .delete_prefix(HOMEBREW_TAP_DIRECTORY.to_s) .tr("^A-Za-z0-9", "_") .upcase 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.
938 939 940 941 942 943 944 945 946 947 948 |
# File 'tap.rb', line 938 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.
392 393 394 |
# File 'tap.rb', line 392 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.
1007 1008 1009 |
# File 'tap.rb', line 1007 def should_report_analytics? installed? && !private? end |
#style_exceptions ⇒ Hash
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
986 987 988 |
# File 'tap.rb', line 986 def style_exceptions @style_exceptions ||= read_formula_list_directory("#{HOMEBREW_TAP_STYLE_EXCEPTIONS_DIR}/*") 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
998 999 1000 1001 1002 1003 1004 |
# File 'tap.rb', line 998 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_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.
929 930 931 932 933 934 935 |
# File 'tap.rb', line 929 def tap_migrations @tap_migrations ||= if (migration_file = path/HOMEBREW_TAP_MIGRATIONS_FILE).file? JSON.parse(migration_file.read) else {} end end |
#to_hash ⇒ Hash
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.
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 |
# File 'tap.rb', line 865 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.
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 631 632 633 634 635 636 |
# File 'tap.rb', line 599 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(" ") require "description_cache_store" 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 require "utils/link" 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 |