Class: Tap Private
- Extended by:
- Cachable, Enumerable, T::Generic
- Defined in:
- tap.rb
Overview
This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.
A Tap is used to encapsulate Homebrew formulae, casks and custom commands.
Usually, it's synced with a remote Git repository. And it's likely
a GitHub repository with the name of user/homebrew-repository
. In such
cases, user/repository
will be used as the #name of this Tap, where
#user represents the GitHub username and #repository represents the
repository name without the leading homebrew-
.
Direct Known Subclasses
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.
T.let(%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_DISABLED_NEW_USR_LOCAL_RELOCATION_FORMULAE_FILE} #{HOMEBREW_TAP_AUDIT_EXCEPTIONS_DIR}/*.json #{HOMEBREW_TAP_STYLE_EXCEPTIONS_DIR}/*.json ].freeze, T::Array[String])
- Elem =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
type_member(:out) { { fixed: Tap } }
Instance Attribute Summary collapse
-
#full_name ⇒ String
readonly
The full name of this Tap, including the
homebrew-
prefix. -
#git_repository ⇒ GitRepository
readonly
private
The git repository of this Tap.
-
#name ⇒ String
readonly
The name of this Tap.
-
#path ⇒ Pathname
readonly
The local path to this Tap.
-
#repository ⇒ String
readonly
The repository name of this Tap without the leading
homebrew-
. -
#user ⇒ String
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
- .core_taps ⇒ Array<Tap> private
-
.each(&block) ⇒ Array<Tap>, T::Enumerator[Tap]
Enumerate all available Taps.
-
.fetch(user, repository = T.unsafe(nil)) ⇒ Tap
Fetch a Tap by name.
- .forbidden_taps ⇒ Set<Tap> private
-
.from_path(path) ⇒ Tap?
Get a Tap from its path or a path inside of it.
-
.installed ⇒ Array<Tap>
All locally installed taps.
-
.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) ⇒ Boolean, String private
-
#audit_exceptions ⇒ Hash{Symbol => T.untyped}
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 ⇒ void
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 ⇒ Array<String> private
- #core_cask_tap? ⇒ Boolean private
- #core_tap? ⇒ Boolean private
- #custom_remote? ⇒ Boolean
-
#default_remote ⇒ String
private
The default remote path to this Tap.
-
#disabled_new_usr_local_relocation_formulae ⇒ Array<String>
private
Array with formulae that should not be relocated to new /usr/local.
- #ensure_installed! ⇒ void private
- #fix_remote_configuration(requested_remote: nil, quiet: false) ⇒ void 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 ⇒ String?
Git branch for this Tap.
-
#git_head ⇒ String?
Git HEAD for this Tap.
-
#git_last_commit ⇒ String?
Time since last git commit for this Tap.
- #initialize(user, repository) ⇒ void constructor private
-
#install(quiet: false, clone_target: nil, custom_remote: false, verify: false, force: false) ⇒ void
Install this Tap.
-
#installed? ⇒ Boolean
Check whether this Tap is installed.
-
#issues_url ⇒ String?
The issues URL of this Tap.
- #link_completions_and_manpages ⇒ void 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{String => T.untyped}
private
Hash with pypi formula mappings.
- #relative_cask_path(token) ⇒ String private
-
#remote ⇒ String?
The remote path to this Tap.
-
#remote_repository ⇒ String?
The remote repository name of this Tap.
- #repository_var_suffix ⇒ String 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{Symbol => T.untyped}
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{String => T.untyped} private
-
#uninstall(manual: false) ⇒ void
Uninstall this Tap.
Methods included from Enumerable
Methods included from Cachable
Constructor Details
#initialize(user, repository) ⇒ void
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
204 205 206 207 208 209 210 211 212 213 |
# File 'tap.rb', line 204 def initialize(user, repository) require "git_repository" @user = user @repository = repository @name = T.let("#{@user}/#{@repository}".downcase, String) @full_name = T.let("#{@user}/homebrew-#{@repository}", String) @path = T.let(HOMEBREW_TAP_DIRECTORY/@full_name.downcase, Pathname) @git_repository = T.let(GitRepository.new(@path), GitRepository) end |
Instance Attribute Details
#full_name ⇒ String (readonly)
The full name of this Tap, including the homebrew-
prefix.
It combines #user and 'homebrew-'-prefixed #repository with a slash.
e.g. user/homebrew-repository
187 188 189 |
# File 'tap.rb', line 187 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.
198 199 200 |
# File 'tap.rb', line 198 def git_repository @git_repository end |
#name ⇒ String (readonly)
The name of this Tap. It combines #user and #repository with a slash.
#name is always in lowercase.
e.g. user/repository
175 176 177 |
# File 'tap.rb', line 175 def name @name end |
#path ⇒ Pathname (readonly)
The local path to this Tap.
e.g. /usr/local/Library/Taps/user/homebrew-repository
194 195 196 |
# File 'tap.rb', line 194 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.
1150 1151 1152 |
# File 'tap.rb', line 1150 def self.all cache[:all] ||= installed | core_taps 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 |
.core_taps ⇒ Array<Tap>
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
1155 1156 1157 |
# File 'tap.rb', line 1155 def self.core_taps [CoreTap.instance].freeze end |
.each(&block) ⇒ Array<Tap>, T::Enumerator[Tap]
Enumerate all available Taps.
1163 1164 1165 1166 1167 1168 1169 1170 1171 |
# File 'tap.rb', line 1163 def self.each(&block) return to_enum unless block_given? if Homebrew::EnvConfig.no_install_from_api? installed.each(&block) else all.each(&block) end end |
.fetch(user, repository = T.unsafe(nil)) ⇒ Tap
Fetch a Tap by name.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
# File 'tap.rb', line 53 def self.fetch(user, repository = T.unsafe(nil)) user, repository = user.split("/", 2) if repository.nil? if [user, repository].any? { |part| part.nil? || part.include?("/") } raise InvalidNameError, "Invalid tap name: '#{[*user, *repository].join("/")}'" end user = T.must(user) # We special case homebrew and linuxbrew so that users don't have to shift in a terminal. user = user.capitalize if ["homebrew", "linuxbrew"].include?(user) repository = repository.sub(HOMEBREW_OFFICIAL_REPO_PREFIXES_REGEX, "") return CoreTap.instance if ["Homebrew", "Linuxbrew"].include?(user) && ["core", "homebrew"].include?(repository) return CoreCaskTap.instance if user == "Homebrew" && repository == "cask" cache_key = "#{user}/#{repository}".downcase cache.fetch(cache_key) { |key| cache[key] = new(user, repository) } end |
.forbidden_taps ⇒ 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) ⇒ Tap?
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 (repository = match[:repository]) fetch(user, repository) end |
.installed ⇒ Array<Tap>
All locally installed taps.
1140 1141 1142 1143 1144 1145 1146 |
# File 'tap.rb', line 1140 def self.installed cache[:installed] ||= if HOMEBREW_TAP_DIRECTORY.directory? HOMEBREW_TAP_DIRECTORY.subdirs.flat_map(&:subdirs).map { from_path(_1) } else [] end 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.
1018 1019 1020 1021 1022 1023 1024 1025 1026 |
# File 'tap.rb', line 1018 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
1175 1176 1177 |
# File 'tap.rb', line 1175 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]) repository = T.must(match[:repository]) token = T.must(match[:token]) # Relative paths are not taps. return if [user, repository].intersect?([".", ".."]) tap = fetch(user, repository) [tap, token.downcase] end |
.with_formula_name(name) ⇒ Array<(Tap, String)>?
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
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]) repository = T.must(match[:repository]) name = T.must(match[:name]) # Relative paths are not taps. return if [user, repository].intersect?([".", ".."]) tap = fetch(user, repository) [tap, name.downcase] end |
Instance Method Details
#alias_dir ⇒ Pathname
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Path to the directory of all alias files for this Tap.
861 862 863 |
# File 'tap.rb', line 861 def alias_dir @alias_dir ||= T.let(path/"Aliases", T.nilable(Pathname)) end |
#alias_file_to_name(file) ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
1185 1186 1187 |
# File 'tap.rb', line 1185 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.
867 868 869 |
# File 'tap.rb', line 867 def alias_files @alias_files ||= T.let(Pathname.glob("#{alias_dir}/*").select(&:file?), T.nilable(T::Array[Pathname])) end |
#alias_reverse_table ⇒ Hash{String => Array<String>}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Mapping from formula names to aliases.
887 888 889 890 891 892 893 894 895 |
# File 'tap.rb', line 887 def alias_reverse_table @alias_reverse_table ||= T.let( alias_table.each_with_object({}) do |(alias_name, formula_name), alias_reverse_table| alias_reverse_table[formula_name] ||= [] alias_reverse_table[formula_name] << alias_name end, T.nilable(T::Hash[String, T::Array[String]]), ) end |
#alias_table ⇒ Hash{String => String}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Mapping from aliases to formula names.
879 880 881 882 883 |
# File 'tap.rb', line 879 def alias_table @alias_table ||= T.let(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, T.nilable(T::Hash[String, String])) end |
#aliases ⇒ Array<String>
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
An array of all aliases of this Tap.
873 874 875 |
# File 'tap.rb', line 873 def aliases @aliases ||= T.let(alias_table.keys, T.nilable(T::Array[String])) end |
#allow_bump?(formula_or_cask_name) ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Whether this Tap allows running bump commands on the given Formula or Cask.
1063 1064 1065 |
# File 'tap.rb', line 1063 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.
1213 1214 1215 1216 1217 1218 1219 |
# File 'tap.rb', line 1213 def allowed_by_env? @allowed_by_env ||= T.let(begin allowed_taps = self.class.allowed_taps official? || allowed_taps.blank? || allowed_taps.include?(self) end, T.nilable(T::Boolean)) end |
#audit_exception(list, formula_or_cask, value = nil) ⇒ Boolean, String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 |
# File 'tap.rb', line 1193 def audit_exception(list, formula_or_cask, value = nil) return false if audit_exceptions.blank? return false unless audit_exceptions.key? list list = audit_exceptions[list] case list when Array list.include? formula_or_cask when Hash return false unless list.include? formula_or_cask return list[formula_or_cask] if value.blank? return list[formula_or_cask].include?(value) if list[formula_or_cask].is_a?(Array) list[formula_or_cask] == value end end |
#audit_exceptions ⇒ Hash{Symbol => T.untyped}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Hash with audit exceptions
1069 1070 1071 1072 |
# File 'tap.rb', line 1069 def audit_exceptions @audit_exceptions ||= T.let(read_formula_list_directory("#{HOMEBREW_TAP_AUDIT_EXCEPTIONS_DIR}/*"), T.nilable(T::Hash[Symbol, T.untyped])) end |
#autobump ⇒ Array<String>
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Array with autobump names
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 |
# File 'tap.rb', line 1030 def autobump autobump_packages = if core_cask_tap? Homebrew::API::Cask.all_casks elsif core_tap? Homebrew::API::Formula.all_formulae else {} end @autobump ||= T.let(autobump_packages.select do |_, p| next if p["disabled"] next if p["deprecated"] && p["deprecation_reason"] != "unsigned" next if p["skip_livecheck"] p["autobump"] == true end.keys, T.nilable(T::Array[String])) if @autobump.blank? @autobump = T.let( if (autobump_file = path/HOMEBREW_TAP_AUTOBUMP_FILE).file? autobump_file.readlines(chomp: true) else [] end, T.nilable(T::Array[String]), ) end T.must(@autobump) end |
#cask_dir ⇒ Pathname
710 711 712 |
# File 'tap.rb', line 710 def cask_dir @cask_dir ||= T.let(path/"Casks", T.nilable(Pathname)) end |
#cask_file?(file) ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
accepts the relative path of a file from Tap's path
833 834 835 |
# File 'tap.rb', line 833 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.
776 777 778 779 780 781 782 783 784 785 |
# File 'tap.rb', line 776 def cask_files @cask_files ||= T.let( if cask_dir.directory? Pathname.glob(cask_dir/"**/*.rb") else [] end, T.nilable(T::Array[Pathname]), ) end |
#cask_files_by_name ⇒ Hash{String => Pathname}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
789 790 791 792 793 794 795 796 |
# File 'tap.rb', line 789 def cask_files_by_name @cask_files_by_name ||= T.let(cask_files.each_with_object({}) do |file, hash| # If there's more than one file with the same basename: use the longer one to prioritise more specific results. basename = file.basename(".rb").to_s existing_file = hash[basename] hash[basename] = file if existing_file.nil? || existing_file.to_s.length < file.to_s.length end, T.nilable(T::Hash[String, Pathname])) end |
#cask_renames ⇒ Hash{String => String}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Hash with tap cask renames.
946 947 948 949 950 951 952 953 954 955 |
# File 'tap.rb', line 946 def cask_renames @cask_renames ||= T.let( if (rename_file = path/HOMEBREW_TAP_CASK_RENAMES_FILE).file? JSON.parse(rename_file.read) else {} end, T.nilable(T::Hash[String, String]), ) end |
#cask_reverse_renames ⇒ Hash{String => Array<String>}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Mapping from new to old cask tokens. Reverse of #cask_renames.
959 960 961 962 963 964 |
# File 'tap.rb', line 959 def cask_reverse_renames @cask_reverse_renames ||= T.let(cask_renames.each_with_object({}) do |(old_name, new_name), hash| hash[new_name] ||= [] hash[new_name] << old_name end, T.nilable(T::Hash[String, T::Array[String]])) end |
#cask_tokens ⇒ Array<String>
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
855 856 857 |
# File 'tap.rb', line 855 def cask_tokens @cask_tokens ||= T.let(cask_files.map { formula_file_to_name(_1) }, T.nilable(T::Array[String])) end |
#clear_cache ⇒ void
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
This method returns an undefined value.
Clear internal cache.
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 249 250 251 252 253 254 255 |
# File 'tap.rb', line 217 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 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.
898 899 900 |
# File 'tap.rb', line 898 def command_dir @command_dir ||= T.let(path/"cmd", T.nilable(Pathname)) end |
#command_files ⇒ Array<Pathname>
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
An array of all commands files of this Tap.
904 905 906 907 908 909 910 911 912 913 |
# File 'tap.rb', line 904 def command_files @command_files ||= T.let( if command_dir.directory? Commands.find_commands(command_dir) else [] end, T.nilable(T::Array[Pathname]), ) end |
#config ⇒ TapConfig
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
391 392 393 394 395 396 397 |
# File 'tap.rb', line 391 def config @config ||= T.let(begin raise TapUnavailableError, name unless installed? TapConfig.new(self) end, T.nilable(TapConfig)) end |
#contents ⇒ Array<String>
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 |
# File 'tap.rb', line 726 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.
419 420 421 |
# File 'tap.rb', line 419 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.
414 415 416 |
# File 'tap.rb', line 414 def core_tap? false end |
#custom_remote? ⇒ Boolean
674 675 676 677 678 |
# File 'tap.rb', line 674 def custom_remote? return true unless (remote = self.remote) !T.must(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.
289 290 291 |
# File 'tap.rb', line 289 def default_remote "https://github.com/#{full_name}" end |
#disabled_new_usr_local_relocation_formulae ⇒ Array<String>
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Array with formulae that should not be relocated to new /usr/local
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 |
# File 'tap.rb', line 1108 def disabled_new_usr_local_relocation_formulae @disabled_new_usr_local_relocation_formulae ||= T.let( if (synced_file = path/HOMEBREW_TAP_DISABLED_NEW_USR_LOCAL_RELOCATION_FORMULAE_FILE).file? JSON.parse(synced_file.read) else [] end, T.nilable(T::Array[String]), ) end |
#ensure_installed! ⇒ void
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
This method returns an undefined value.
258 259 260 261 262 |
# File 'tap.rb', line 258 def ensure_installed! return if installed? install end |
#fix_remote_configuration(requested_remote: nil, quiet: false) ⇒ void
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
This method returns an undefined value.
592 593 594 595 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 |
# File 'tap.rb', line 592 def fix_remote_configuration(requested_remote: nil, quiet: false) if requested_remote.present? path.cd do safe_system "git", "remote", "set-url", "origin", requested_remote safe_system "git", "config", "remote.origin.fetch", "+refs/heads/*:refs/remotes/origin/*" end $stderr.ohai "#{name}: changed remote from #{remote} to #{requested_remote}" unless quiet end return unless remote current_upstream_head = git_repository.origin_branch_name return if current_upstream_head.present? && requested_remote.blank? && git_repository.origin_has_branch?(current_upstream_head) args = %w[fetch] args << "--quiet" if quiet args << "origin" args << "+refs/heads/*:refs/remotes/origin/*" safe_system "git", "-C", path, *args git_repository.set_head_origin_auto current_upstream_head ||= T.must(git_repository.origin_branch_name) new_upstream_head = T.must(git_repository.origin_branch_name) return if new_upstream_head == current_upstream_head safe_system "git", "-C", path, "config", "remote.origin.fetch", "+refs/heads/*:refs/remotes/origin/*" git_repository.rename_branch old: current_upstream_head, new: new_upstream_head git_repository.set_upstream_branch local: new_upstream_head, origin: new_upstream_head return if quiet $stderr.ohai "#{name}: changed default branch name from #{current_upstream_head} to #{new_upstream_head}!" end |
#forbidden_by_env? ⇒ 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.
1222 1223 1224 |
# File 'tap.rb', line 1222 def forbidden_by_env? @forbidden_by_env ||= T.let(self.class.forbidden_taps.include?(self), T.nilable(T::Boolean)) end |
#formula_dir ⇒ Pathname
684 685 686 687 688 689 690 691 692 693 694 |
# File 'tap.rb', line 684 def formula_dir # Official formulae taps always use this directory, saves time to hardcode. @formula_dir ||= T.let( if official? path/"Formula" else potential_formula_dirs.find(&:directory?) || (path/"Formula") end, T.nilable(Pathname), ) end |
#formula_file?(file) ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
accepts the relative path of a file from Tap's path
824 825 826 |
# File 'tap.rb', line 824 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.
1180 1181 1182 |
# File 'tap.rb', line 1180 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.
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 |
# File 'tap.rb', line 746 def formula_files @formula_files ||= T.let( if formula_dir.directory? if formula_dir == path # We only want the top level here so we don't treat commands & casks as formulae. # Sharding is only supported in Formula/ and HomebrewFormula/. Pathname.glob(formula_dir/"*.rb") else Pathname.glob(formula_dir/"**/*.rb") end else [] end, T.nilable(T::Array[Pathname]), ) end |
#formula_files_by_name ⇒ Hash{String => Pathname}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
765 766 767 768 769 770 771 772 |
# File 'tap.rb', line 765 def formula_files_by_name @formula_files_by_name ||= T.let(formula_files.each_with_object({}) do |file, hash| # If there's more than one file with the same basename: use the longer one to prioritise more specific results. basename = file.basename(".rb").to_s existing_file = hash[basename] hash[basename] = file if existing_file.nil? || existing_file.to_s.length < file.to_s.length end, T.nilable(T::Hash[String, Pathname])) end |
#formula_names ⇒ Array<String>
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
839 840 841 |
# File 'tap.rb', line 839 def formula_names @formula_names ||= T.let(formula_files.map { formula_file_to_name(_1) }, T.nilable(T::Array[String])) end |
#formula_renames ⇒ Hash{String => String}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Hash with tap formula renames.
968 969 970 971 972 973 974 975 976 977 |
# File 'tap.rb', line 968 def formula_renames @formula_renames ||= T.let( if (rename_file = path/HOMEBREW_TAP_FORMULA_RENAMES_FILE).file? JSON.parse(rename_file.read) else {} end, T.nilable(T::Hash[String, String]), ) end |
#formula_reverse_renames ⇒ Hash{String => Array<String>}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Mapping from new to old formula names. Reverse of #formula_renames.
981 982 983 984 985 986 |
# File 'tap.rb', line 981 def formula_reverse_renames @formula_reverse_renames ||= T.let(formula_renames.each_with_object({}) do |(old_name, new_name), hash| hash[new_name] ||= [] hash[new_name] << old_name end, T.nilable(T::Hash[String, T::Array[String]])) end |
#git? ⇒ Boolean
Check whether this Tap is a Git repository.
305 306 307 |
# File 'tap.rb', line 305 def git? git_repository.git_repository? end |
#git_branch ⇒ String?
Git branch for this Tap.
313 314 315 316 317 |
# File 'tap.rb', line 313 def git_branch raise TapUnavailableError, name unless installed? git_repository.branch_name end |
#git_head ⇒ String?
Git HEAD for this Tap.
323 324 325 326 327 |
# File 'tap.rb', line 323 def git_head raise TapUnavailableError, name unless installed? @git_head ||= T.let(git_repository.head_ref, T.nilable(String)) end |
#git_last_commit ⇒ String?
Time since last git commit for this Tap.
333 334 335 336 337 |
# File 'tap.rb', line 333 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) ⇒ void
This method returns an undefined value.
Install this Tap.
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 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 |
# File 'tap.rb', line 441 def install(quiet: false, clone_target: nil, custom_remote: false, verify: false, force: false) require "descriptions" require "readall" if official? && DEPRECATED_OFFICIAL_TAPS.include?(repository) odie "#{name} was deprecated. This tap is now empty and all its contents were either deleted or migrated." elsif user == "caskroom" || name == "phinze/cask" new_repository = (repository == "cask") ? "cask" : "cask-#{repository}" odie "#{name} was moved. Tap homebrew/#{new_repository} instead." end raise TapNoCustomRemoteError, name if custom_remote && clone_target.nil? requested_remote = clone_target || default_remote 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&.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.
403 404 405 |
# File 'tap.rb', line 403 def installed? path.directory? end |
#issues_url ⇒ String?
The issues URL of this Tap.
e.g. https://github.com/user/homebrew-repository/issues
344 345 346 347 348 |
# File 'tap.rb', line 344 def issues_url return if !official? && custom_remote? "#{default_remote}/issues" end |
#link_completions_and_manpages ⇒ void
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
This method returns an undefined value.
576 577 578 579 580 581 582 583 584 585 586 587 588 589 |
# File 'tap.rb', line 576 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.
715 716 717 |
# File 'tap.rb', line 715 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.
702 703 704 |
# File 'tap.rb', line 702 def new_formula_path(name) formula_dir/"#{name.downcase}.rb" end |
#official? ⇒ Boolean
Check whether this Tap is an official Homebrew tap.
354 355 356 |
# File 'tap.rb', line 354 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.
697 698 699 |
# File 'tap.rb', line 697 def potential_formula_dirs @potential_formula_dirs ||= T.let([path/"Formula", path/"HomebrewFormula", path].freeze, T.nilable(T::Array[Pathname])) end |
#prefix_to_versioned_formulae_names ⇒ Hash{String => Array<String>}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
A hash of all Formula name prefixes to versioned Formula in this Tap.
845 846 847 848 849 850 851 |
# File 'tap.rb', line 845 def prefix_to_versioned_formulae_names @prefix_to_versioned_formulae_names ||= T.let(formula_names .select { |name| name.include?("@") } .group_by { |name| name.gsub(/(@[\d.]+)?$/, "") } .transform_values(&:sort) .freeze, T.nilable(T::Hash[String, T::Array[String]])) end |
#private? ⇒ Boolean
Check whether the remote of this Tap is a private repository.
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 |
# File 'tap.rb', line 362 def private? return @private unless @private.nil? @private = T.let( 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, T.nilable(T::Boolean), ) T.must(@private) end |
#pypi_formula_mappings ⇒ Hash{String => T.untyped}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Hash with pypi formula mappings
1083 1084 1085 1086 1087 1088 1089 1090 1091 |
# File 'tap.rb', line 1083 def pypi_formula_mappings return @pypi_formula_mappings if @pypi_formula_mappings @pypi_formula_mappings = T.let( T.cast(read_formula_list(path/HOMEBREW_TAP_PYPI_FORMULA_MAPPINGS_FILE), T::Hash[String, T.untyped]), T.nilable(T::Hash[String, T.untyped]), ) T.must(@pypi_formula_mappings) 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.
720 721 722 723 |
# File 'tap.rb', line 720 def relative_cask_path(token) new_cask_path(token).to_s .delete_prefix("#{path}/") end |
#remote ⇒ String?
The remote path to this Tap.
e.g. https://github.com/user/homebrew-repository
269 270 271 272 273 |
# File 'tap.rb', line 269 def remote return default_remote unless installed? @remote ||= T.let(git_repository.origin_url, T.nilable(String)) end |
#remote_repository ⇒ String?
The remote repository name of this Tap.
e.g. user/homebrew-repository
280 281 282 283 284 285 |
# File 'tap.rb', line 280 def remote_repository return unless (remote = self.remote) return unless (match = remote.match(HOMEBREW_TAP_REPOSITORY_REGEX)) @remote_repository ||= T.let(T.must(match[:remote_repository]), T.nilable(String)) end |
#repository_var_suffix ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
294 295 296 297 298 299 |
# File 'tap.rb', line 294 def repository_var_suffix @repository_var_suffix ||= T.let(path.to_s .delete_prefix(HOMEBREW_TAP_DIRECTORY.to_s) .tr("^A-Za-z0-9", "_") .upcase, T.nilable(String)) end |
#reverse_tap_migrations_renames ⇒ Hash{String => Array<String>}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 |
# File 'tap.rb', line 1001 def reverse_tap_migrations_renames @reverse_tap_migrations_renames ||= T.let( tap_migrations.each_with_object({}) do |(old_name, new_name), hash| # Only include renames: # + `homebrew/cask/water-buffalo` # - `homebrew/cask` next if new_name.count("/") != 2 hash[new_name] ||= [] hash[new_name] << old_name end, T.nilable(T::Hash[String, T::Array[String]]), ) end |
#shallow? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Check whether this Tap is a shallow clone.
409 410 411 |
# File 'tap.rb', line 409 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.
1120 1121 1122 |
# File 'tap.rb', line 1120 def should_report_analytics? installed? && !private? end |
#style_exceptions ⇒ Hash{Symbol => T.untyped}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Hash with style exceptions
1076 1077 1078 1079 |
# File 'tap.rb', line 1076 def style_exceptions @style_exceptions ||= T.let(read_formula_list_directory("#{HOMEBREW_TAP_STYLE_EXCEPTIONS_DIR}/*"), T.nilable(T::Hash[Symbol, T.untyped])) end |
#synced_versions_formulae ⇒ Array<Array<String>>
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Array with synced versions formulae
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 |
# File 'tap.rb', line 1095 def synced_versions_formulae @synced_versions_formulae ||= T.let( if (synced_file = path/HOMEBREW_TAP_SYNCED_VERSIONS_FORMULAE_FILE).file? JSON.parse(synced_file.read) else [] end, T.nilable(T::Array[T::Array[String]]), ) end |
#tap_migrations ⇒ Hash{String => String}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Hash with tap migrations.
990 991 992 993 994 995 996 997 998 |
# File 'tap.rb', line 990 def tap_migrations @tap_migrations ||= T.let( if (migration_file = path/HOMEBREW_TAP_MIGRATIONS_FILE).file? JSON.parse(migration_file.read) else {} end, T.nilable(T::Hash[String, String]) ) end |
#to_hash ⇒ Hash{String => T.untyped}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 |
# File 'tap.rb', line 916 def to_hash hash = { "name" => name, "user" => user, "repo" => repository, "repository" => repository, "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? hash["HEAD"] = git_head || "(none)" hash["last_commit"] = git_last_commit || "never" hash["branch"] = git_branch || "(none)" end hash end |
#uninstall(manual: false) ⇒ void
This method returns an undefined value.
Uninstall this Tap.
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 |
# File 'tap.rb', line 631 def uninstall(manual: false) require "descriptions" raise TapUnavailableError, name unless installed? $stderr.puts "Untapping #{name}..." abv = path.abv formatted_contents = contents.presence&.to_sentence&.prepend(" ") require "description_cache_store" CacheStoreDatabase.use(:descriptions) do |db| DescriptionCacheStore.new(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) FileUtils.rm_r(path) 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 |