Class: Tap

Inherits:
Object
  • Object
show all
Extended by:
Cachable, Enumerable, T::Sig
Defined in:
extend/os/mac/tap.rb,
tap.rb

Overview

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-repo. In such cases, user/repo will be used as the #name of this Tap, where #user represents the GitHub username and #repo represents the repository name without the leading homebrew-.

Direct Known Subclasses

CoreTap

Constant Summary collapse

TAP_DIRECTORY =
(HOMEBREW_LIBRARY/"Taps").freeze
HOMEBREW_TAP_FORMULA_RENAMES_FILE =
"formula_renames.json"
HOMEBREW_TAP_MIGRATIONS_FILE =
"tap_migrations.json"
HOMEBREW_TAP_AUDIT_EXCEPTIONS_DIR =
"audit_exceptions"
HOMEBREW_TAP_STYLE_EXCEPTIONS_DIR =
"style_exceptions"
HOMEBREW_TAP_PYPI_FORMULA_MAPPINGS =
"pypi_formula_mappings.json"
HOMEBREW_TAP_JSON_FILES =
%W[
  #{HOMEBREW_TAP_FORMULA_RENAMES_FILE}
  #{HOMEBREW_TAP_MIGRATIONS_FILE}
  #{HOMEBREW_TAP_AUDIT_EXCEPTIONS_DIR}/*.json
  #{HOMEBREW_TAP_STYLE_EXCEPTIONS_DIR}/*.json
  #{HOMEBREW_TAP_PYPI_FORMULA_MAPPINGS}
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Cachable

cache

Instance Attribute Details

#full_nameObject (readonly)

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



92
93
94
# File 'tap.rb', line 92

def full_name
  @full_name
end

#nameObject (readonly)

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



87
88
89
# File 'tap.rb', line 87

def name
  @name
end

#pathObject (readonly)

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



96
97
98
# File 'tap.rb', line 96

def path
  @path
end

#repoObject (readonly)

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



82
83
84
# File 'tap.rb', line 82

def repo
  @repo
end

#userObject (readonly)

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



79
80
81
# File 'tap.rb', line 79

def user
  @user
end

Class Method Details

.cmd_directoriesArray<Pathname>

An array of all tap cmd directory Pathnames.

Returns:



654
655
656
# File 'tap.rb', line 654

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

.default_cask_tapT.attached_class

Returns:

  • (T.attached_class)


66
67
68
# File 'tap.rb', line 66

def self.default_cask_tap
  @default_cask_tap ||= fetch("Homebrew", "cask")
end

.each(&block) ⇒ Object



635
636
637
638
639
640
641
642
643
644
645
# File 'tap.rb', line 635

def self.each(&block)
  return unless TAP_DIRECTORY.directory?

  return to_enum unless block

  TAP_DIRECTORY.subdirs.each do |user|
    user.subdirs.each do |repo|
      block.call fetch(user.basename.to_s, repo.basename.to_s)
    end
  end
end

.fetch(*args) ⇒ Object



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'tap.rb', line 37

def self.fetch(*args)
  case args.length
  when 1
    user, repo = args.first.split("/", 2)
  when 2
    user = args.first
    repo = args.second
  end

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

  # We special case homebrew and linuxbrew so that users don't have to shift in a terminal.
  user = user.capitalize if ["homebrew", "linuxbrew"].include? user
  repo = repo.sub(HOMEBREW_OFFICIAL_REPO_PREFIXES_REGEX, "")

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

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

.from_path(path) ⇒ Object



58
59
60
61
62
63
# File 'tap.rb', line 58

def self.from_path(path)
  match = File.expand_path(path).match(HOMEBREW_TAP_PATH_REGEX)
  return if match.blank? || match[:user].blank? || match[:repo].blank?

  fetch(match[:user], match[:repo])
end

.install_default_cask_tap_if_necessary(force: false) ⇒ Boolean

Parameters:

  • force (Boolean) (defaults to: false)

Returns:

  • (Boolean)


71
72
73
74
75
76
77
78
# File 'tap.rb', line 71

def self.install_default_cask_tap_if_necessary(force: false)
  return false if default_cask_tap.installed?

  return false if !force && Tap.untapped_official_taps.include?(default_cask_tap.name)

  default_cask_tap.install
  true
end

.namesObject

An array of all installed Tap names.



648
649
650
# File 'tap.rb', line 648

def self.names
  map(&:name).sort
end

.untapped_official_tapsArray<String>

An array of official taps that have been manually untapped

Returns:



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

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

Instance Method Details

#==(other) ⇒ Object



630
631
632
633
# File 'tap.rb', line 630

def ==(other)
  other = Tap.fetch(other) if other.is_a?(String)
  self.class == other.class && name == other.name
end

#audit_exceptionsHash

Hash with audit exceptions

Returns:

  • (Hash)


614
615
616
# File 'tap.rb', line 614

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

#cask_dirObject

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



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

def cask_dir
  @cask_dir ||= path/"Casks"
end

#cask_filesObject

An array of all Cask files of this Tap.



459
460
461
462
463
464
465
# File 'tap.rb', line 459

def cask_files
  @cask_files ||= if cask_dir.directory?
    cask_dir.children.select(&method(:ruby_file?))
  else
    []
  end
end

#cask_tokensObject

An array of all Cask tokens of this Tap.



497
498
499
# File 'tap.rb', line 497

def cask_tokens
  @cask_tokens ||= cask_files.map(&method(:formula_file_to_name))
end

#clear_cacheObject

Clear internal cache.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File 'tap.rb', line 111

def clear_cache
  @remote = nil
  @repo_var = nil
  @formula_dir = nil
  @cask_dir = nil
  @command_dir = nil
  @formula_files = nil
  @alias_dir = nil
  @alias_files = nil
  @aliases = nil
  @alias_table = nil
  @alias_reverse_table = nil
  @command_files = nil
  @formula_renames = nil
  @tap_migrations = nil
  @audit_exceptions = nil
  @style_exceptions = nil
  @pypi_formula_mappings = nil
  @config = nil
  @spell_checker = nil
  remove_instance_variable(:@private) if instance_variable_defined?(:@private)
end

#command_dirObject



544
545
546
# File 'tap.rb', line 544

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

#command_filesObject

An array of all commands files of this Tap.



549
550
551
552
553
554
555
# File 'tap.rb', line 549

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

#configObject

TapConfig of this Tap.



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

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

    TapConfig.new(self)
  end
end

#contentsObject



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
# File 'tap.rb', line 431

def contents
  contents = []

  if (command_count = command_files.count).positive?
    contents << "#{command_count} #{"command".pluralize(command_count)}"
  end

  if (cask_count = cask_files.count).positive?
    contents << "#{cask_count} #{"cask".pluralize(cask_count)}"
  end

  if (formula_count = formula_files.count).positive?
    contents << "#{formula_count} #{"formula".pluralize(formula_count)}"
  end

  contents
end

#custom_remote?Boolean

True if the #remote of Tap is customized.

Returns:

  • (Boolean)


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

def custom_remote?
  return true unless remote

  remote.casecmp(default_remote).nonzero?
end

#default_remoteString

The default remote path to this Tap.

Returns:



156
157
158
# File 'tap.rb', line 156

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

#fix_remote_configurationObject



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'tap.rb', line 361

def fix_remote_configuration
  return unless remote.include? "github.com"

  current_upstream_head = path.git_origin_branch
  return if path.git_origin_has_branch? current_upstream_head

  safe_system "git", "-C", path, "fetch", "origin"
  path.git_origin_set_head_auto

  new_upstream_head = path.git_origin_branch
  path.git_rename_branch old: current_upstream_head, new: new_upstream_head
  path.git_branch_set_upstream local: new_upstream_head, origin: new_upstream_head

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

#formula_dirObject

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



418
419
420
# File 'tap.rb', line 418

def formula_dir
  @formula_dir ||= potential_formula_dirs.find(&:directory?) || path/"Formula"
end

#formula_filesObject

An array of all Formula files of this Tap.



450
451
452
453
454
455
456
# File 'tap.rb', line 450

def formula_files
  @formula_files ||= if formula_dir.directory?
    formula_dir.children.select(&method(:ruby_file?))
  else
    []
  end
end

#formula_namesObject

An array of all Formula names of this Tap.



492
493
494
# File 'tap.rb', line 492

def formula_names
  @formula_names ||= formula_files.map(&method(:formula_file_to_name))
end

#formula_renamesObject

Hash with tap formula renames.



595
596
597
598
599
600
601
# File 'tap.rb', line 595

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

#git?Boolean

True if this Tap is a Git repository.

Returns:

  • (Boolean)


168
169
170
# File 'tap.rb', line 168

def git?
  path.git?
end

#git_branchObject

git branch for this Tap.



173
174
175
176
177
# File 'tap.rb', line 173

def git_branch
  raise TapUnavailableError, name unless installed?

  path.git_branch
end

#git_headObject

git HEAD for this Tap.



180
181
182
183
184
# File 'tap.rb', line 180

def git_head
  raise TapUnavailableError, name unless installed?

  path.git_head
end

#git_last_commitObject

Time since last git commit for this Tap.



187
188
189
190
191
# File 'tap.rb', line 187

def git_last_commit
  raise TapUnavailableError, name unless installed?

  path.git_last_commit
end

#install(quiet: false, clone_target: nil, force_auto_update: nil) ⇒ Object

Install this Tap.

Parameters:

  • clone_target (String) (defaults to: nil)

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

  • force_auto_update (Boolean, nil) (defaults to: nil)

    If present, whether to override the logic that skips non-GitHub repositories during auto-updates.

  • quiet (Boolean) (defaults to: false)

    If set, suppress all output.



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
# File 'tap.rb', line 249

def install(quiet: false, clone_target: nil, force_auto_update: nil)
  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

  requested_remote = clone_target || default_remote

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

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

  if installed?
    unless force_auto_update.nil?
      config["forceautoupdate"] = force_auto_update
      return
    end

    $stderr.ohai "Unshallowing #{name}" if shallow? && !quiet
    args = %w[fetch]
    # Git throws an error when attempting to unshallow a full clone
    args << "--unshallow" if shallow?
    args << "-q" if quiet
    path.cd { safe_system "git", *args }
    return
  end

  clear_cache

  $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="

  begin
    safe_system "git", *args
    if !Readall.valid_tap?(self, aliases: true) && !Homebrew::EnvConfig.developer?
      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

  config["forceautoupdate"] = force_auto_update unless force_auto_update.nil?

  Commands.rebuild_commands_completion_list
  link_completions_and_manpages

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

  $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

True if this Tap has been installed.

Returns:

  • (Boolean)


228
229
230
# File 'tap.rb', line 228

def installed?
  path.directory?
end

#issues_urlString?

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

Returns:



196
197
198
199
200
# File 'tap.rb', line 196

def issues_url
  return if !official? && custom_remote?

  "#{default_remote}/issues"
end


349
350
351
352
353
354
355
356
357
358
359
# File 'tap.rb', line 349

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

  Homebrew::Completions.show_completions_message_if_needed
  if official? || Homebrew::Completions.link_completions?
    Utils::Link.link_completions(path, command)
  else
    Utils::Link.unlink_completions(path)
  end
end

#official?Boolean

True if this Tap is an official Homebrew tap.

Returns:

  • (Boolean)


207
208
209
# File 'tap.rb', line 207

def official?
  user == "Homebrew"
end

#pinned?Boolean

True if this Tap has been pinned.

Returns:

  • (Boolean)


564
565
566
567
568
# File 'tap.rb', line 564

def pinned?
  return @pinned if instance_variable_defined?(:@pinned)

  @pinned = pinned_symlink_path.directory?
end

#potential_formula_dirsObject



422
423
424
# File 'tap.rb', line 422

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

#private?Boolean

True if the remote of this Tap is a private repository.

Returns:

  • (Boolean)


212
213
214
215
216
# File 'tap.rb', line 212

def private?
  return @private if instance_variable_defined?(:@private)

  @private = read_or_set_private_config
end

#pypi_formula_mappingsHash

Hash with pypi formula mappings

Returns:

  • (Hash)


626
627
628
# File 'tap.rb', line 626

def pypi_formula_mappings
  @pypi_formula_mappings = read_formula_list path/HOMEBREW_TAP_PYPI_FORMULA_MAPPINGS
end

#remoteObject

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



136
137
138
139
140
# File 'tap.rb', line 136

def remote
  raise TapUnavailableError, name unless installed?

  @remote ||= path.git_origin
end

#remote_repoObject

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



144
145
146
147
148
149
150
151
152
# File 'tap.rb', line 144

def remote_repo
  raise TapUnavailableError, name unless installed?

  return unless remote

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

#repo_varObject



160
161
162
163
164
165
# File 'tap.rb', line 160

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

#shallow?Boolean

True if this Tap is not a full clone.

Returns:

  • (Boolean)


233
234
235
# File 'tap.rb', line 233

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

#style_exceptionsHash

Hash with style exceptions

Returns:

  • (Hash)


620
621
622
# File 'tap.rb', line 620

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

#tap_migrationsObject

Hash with tap migrations.



604
605
606
607
608
609
610
# File 'tap.rb', line 604

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

#to_hashObject



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
# File 'tap.rb', line 570

def to_hash
  hash = {
    "name"          => name,
    "user"          => user,
    "repo"          => repo,
    "path"          => path.to_s,
    "installed"     => installed?,
    "official"      => official?,
    "formula_names" => formula_names,
    "formula_files" => formula_files.map(&:to_s),
    "cask_tokens"   => cask_tokens,
    "cask_files"    => cask_files.map(&:to_s),
    "command_files" => command_files.map(&:to_s),
  }

  if installed?
    hash["remote"] = remote
    hash["custom_remote"] = custom_remote?
    hash["private"] = private?
  end

  hash
end

#to_sObject



202
203
204
# File 'tap.rb', line 202

def to_s
  name
end

#uninstall(manual: false) ⇒ Object

Uninstall this Tap.



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
# File 'tap.rb', line 378

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(" ")

  unpin if pinned?
  CacheStoreDatabase.use(:descriptions) do |db|
    DescriptionCacheStore.new(db)
                         .delete_from_formula_names!(formula_names)
  end
  Utils::Link.unlink_manpages(path)
  Utils::Link.unlink_completions(path)
  path.rmtree
  path.parent.rmdir_if_possible
  $stderr.puts "Untapped#{formatted_contents} (#{abv})."

  Commands.rebuild_commands_completion_list
  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