Class: Tap

Inherits:
Object show all
Extended by:
Cachable, Enumerable
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

AbstractCoreTap

Constant Summary collapse

TAP_DIRECTORY =
(HOMEBREW_LIBRARY/"Taps").freeze
HOMEBREW_TAP_CASK_RENAMES_FILE =
"cask_renames.json"
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"
TAP_MIGRATIONS_STALE_SECONDS =

1 day

86400
HOMEBREW_TAP_JSON_FILES =
%W[
  #{HOMEBREW_TAP_FORMULA_RENAMES_FILE}
  #{HOMEBREW_TAP_CASK_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

Methods included from Enumerable

compact_blank, exclude?

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



99
100
101
# File 'tap.rb', line 99

def full_name
  @full_name
end

#git_repoGitRepository (readonly)

The git repository of this Tap.

Returns:



108
109
110
# File 'tap.rb', line 108

def git_repo
  @git_repo
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



94
95
96
# File 'tap.rb', line 94

def name
  @name
end

#pathPathname (readonly)

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

Returns:



104
105
106
# File 'tap.rb', line 104

def path
  @path
end

#repoObject (readonly)

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



89
90
91
# File 'tap.rb', line 89

def repo
  @repo
end

#userObject (readonly)

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



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

def user
  @user
end

Class Method Details

.cask_files_by_name(tap) ⇒ Hash{String => Pathname}

A cached hash of Cask basenames to Cask file pathnames for a Tap

Parameters:

Returns:



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

def self.cask_files_by_name(tap)
  cache_key = "cask_files_by_name_#{tap}"
  cache.fetch(cache_key) do |key|
    cache[key] = tap.cask_files_by_name
  end
end

.cmd_directoriesArray<Pathname>

An array of all tap cmd directory Pathnames.

Returns:



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

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

.default_cask_tapCoreCaskTap

Returns:



69
70
71
72
73
# File 'tap.rb', line 69

def self.default_cask_tap
  odisabled "`Tap.default_cask_tap`", "`CoreCaskTap.instance`"

  CoreCaskTap.instance
end

.each(&block) ⇒ Object



846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
# File 'tap.rb', line 846

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

  installed_taps = if TAP_DIRECTORY.directory?
    TAP_DIRECTORY.subdirs
                 .flat_map(&:subdirs)
                 .map(&method(:from_path))
  else
    []
  end

  available_taps = if Homebrew::EnvConfig.no_install_from_api?
    installed_taps
  else
    default_taps = T.let([CoreTap.instance], T::Array[Tap])
    default_taps << CoreCaskTap.instance if OS.mac? # rubocop:disable Homebrew/MoveToExtendOS
    installed_taps + default_taps
  end.sort_by(&:name).uniq

  available_taps.each(&block)
end

.fetch(*args) ⇒ Object



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

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)
  return CoreCaskTap.instance if user == "Homebrew" && repo == "cask"

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

.formula_files_by_name(tap) ⇒ Hash{String => Pathname}

A cached hash of Formula basenames to Formula file pathnames for a Tap

Parameters:

Returns:



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

def self.formula_files_by_name(tap)
  cache_key = "formula_files_by_name_#{tap}"
  cache.fetch(cache_key) do |key|
    cache[key] = tap.formula_files_by_name
  end
end

.from_path(path) ⇒ Object



61
62
63
64
65
66
# File 'tap.rb', line 61

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)


5
6
7
8
9
10
11
12
13
14
15
16
# File 'extend/os/mac/tap.rb', line 5

def self.install_default_cask_tap_if_necessary(force: false)
  odisabled "Tap.install_default_cask_tap_if_necessary", "CoreCaskTap.ensure_installed!"

  cask_tap = CoreCaskTap.instance
  return false if cask_tap.installed?
  return false unless Homebrew::EnvConfig.no_install_from_api?
  return false if Homebrew::EnvConfig.automatically_set_no_install_from_api?
  return false if !force && Tap.untapped_official_taps.include?(cask_tap.name)

  cask_tap.install
  true
end

.namesArray<String>

An array of all installed Tap names.

Returns:



870
871
872
# File 'tap.rb', line 870

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

.reverse_tap_migrations_renamesHash{String => Array<String>}

Returns:



793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'tap.rb', line 793

def self.reverse_tap_migrations_renames
  Tap.each_with_object({}) do |tap, hash|
    tap.tap_migrations.each do |old_name, new_name|
      new_tap_user, new_tap_repo, new_name = new_name.split("/", 3)
      next unless new_name

      new_tap = Tap.fetch(new_tap_user, new_tap_repo)

      hash["#{new_tap}/#{new_name}"] ||= []
      hash["#{new_tap}/#{new_name}"] << old_name
    end
  end
end

.untapped_official_tapsArray<String>

An array of official taps that have been manually untapped

Returns:



882
883
884
# File 'tap.rb', line 882

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

Instance Method Details

#==(other) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)


841
842
843
844
# File 'tap.rb', line 841

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

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



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
# File 'tap.rb', line 898

def audit_exception(list, formula_or_cask, value = nil)
  return false if audit_exceptions.blank?
  return false unless audit_exceptions.key? list

  list = audit_exceptions[list]

  case list
  when Array
    list.include? formula_or_cask
  when Hash
    return false unless list.include? formula_or_cask
    return list[formula_or_cask] if value.blank?

    list[formula_or_cask] == value
  end
end

#audit_exceptionsHash

Hash with audit exceptions

Returns:



819
820
821
# File 'tap.rb', line 819

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

#cask_dirPathname

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

Returns:



513
514
515
# File 'tap.rb', line 513

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

#cask_filesArray<Pathname>

An array of all Cask files of this Tap.

Returns:



584
585
586
587
588
589
590
# File 'tap.rb', line 584

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

#cask_renamesHash{String => String}

Hash with tap cask renames.

Returns:



756
757
758
759
760
761
762
# File 'tap.rb', line 756

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

#cask_tokensArray<String>

An array of all Cask tokens of this Tap.

Returns:



663
664
665
# File 'tap.rb', line 663

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

#clear_cacheObject

Clear internal cache.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'tap.rb', line 123

def clear_cache
  @remote = nil
  @repo_var_suffix = nil
  @formula_dir = nil
  @cask_dir = nil
  @command_dir = nil
  @formula_files = nil
  @cask_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_dirPathname

Returns:



715
716
717
# File 'tap.rb', line 715

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

#command_filesArray<Pathname>

An array of all commands files of this Tap.

Returns:



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

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

#configObject

TapConfig of this Tap.



239
240
241
242
243
244
245
# File 'tap.rb', line 239

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

    TapConfig.new(self)
  end
end

#contentsObject



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
# File 'tap.rb', line 528

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

#custom_remote?Boolean

True if the #remote of Tap is customized.

Returns:

  • (Boolean)


484
485
486
487
488
# File 'tap.rb', line 484

def custom_remote?
  return true unless remote

  remote.casecmp(default_remote).nonzero?
end

#default_remoteString

The default remote path to this Tap.

Returns:



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

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

#ensure_installed!void

This method returns an undefined value.



148
149
150
151
152
# File 'tap.rb', line 148

def ensure_installed!
  return if installed?

  install
end

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



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
# File 'tap.rb', line 415

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_repo.origin_branch_name)
  return if requested_remote.blank? && git_repo.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_repo.set_head_origin_auto

  new_upstream_head = T.must(git_repo.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_repo.rename_branch old: current_upstream_head, new: new_upstream_head
  git_repo.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

#formula_dirPathname

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

Returns:



492
493
494
495
496
497
498
499
# File 'tap.rb', line 492

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_filesArray<Pathname>

An array of all Formula files of this Tap.

Returns:



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

def formula_files
  @formula_files ||= if formula_dir.directory?
    if formula_dir == path
      # We only want the top level here so we don't treat commands & casks as formulae.
      # Sharding is only supported in Formula/ and HomebrewFormula/.
      formula_dir.children
    else
      formula_dir.find
    end.select(&method(:formula_file?))
  else
    []
  end
end

#formula_namesArray<String>

An array of all Formula names of this Tap.

Returns:



646
647
648
# File 'tap.rb', line 646

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

#formula_renamesHash{String => String}

Hash with tap formula renames.

Returns:



775
776
777
778
779
780
781
# File 'tap.rb', line 775

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

#formula_reverse_renamesHash{String => Array<String>}

Hash with tap formula old names. Reverse of #formula_renames.

Returns:



785
786
787
788
789
790
# File 'tap.rb', line 785

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

True if this Tap is a Git repository.

Returns:

  • (Boolean)


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

def git?
  git_repo.git_repo?
end

#git_branchObject

Git branch for this Tap.



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

def git_branch
  raise TapUnavailableError, name unless installed?

  git_repo.branch_name
end

#git_headObject

Git HEAD for this Tap.



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

def git_head
  raise TapUnavailableError, name unless installed?

  @git_head ||= git_repo.head_ref
end

#git_last_commitObject

Time since last git commit for this Tap.



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

def git_last_commit
  raise TapUnavailableError, name unless installed?

  git_repo.last_committed
end

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

Install this Tap.

Parameters:

  • clone_target (String) (defaults to: nil)

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

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

  • custom_remote (Boolean) (defaults to: false)

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

  • verify (Boolean) (defaults to: false)

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

  • force (Boolean) (defaults to: false)

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

Raises:



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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
# File 'tap.rb', line 278

def install(quiet: false, clone_target: nil, force_auto_update: 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 if force_auto_update.nil? && !shallow?
  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: requested_remote, quiet: quiet)
    end

    unless force_auto_update.nil?
      if force_auto_update
        config["forceautoupdate"] = force_auto_update
      elsif config["forceautoupdate"] == "true"
        config.delete("forceautoupdate")
      end
      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
  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 done."
  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="
  # prevent fsmonitor from watching this repo
  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

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

True if this Tap has been installed.

Returns:

  • (Boolean)


248
249
250
# File 'tap.rb', line 248

def installed?
  path.directory?
end

#issues_urlString?

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

Returns:



216
217
218
219
220
# File 'tap.rb', line 216

def issues_url
  return if !official? && custom_remote?

  "#{default_remote}/issues"
end


403
404
405
406
407
408
409
410
411
412
413
# File 'tap.rb', line 403

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

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

#new_cask_path(token) ⇒ Pathname

Parameters:

Returns:



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

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

#new_formula_path(name) ⇒ Pathname

Parameters:

Returns:



507
508
509
# File 'tap.rb', line 507

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

#official?Boolean

True if this Tap is an official Homebrew tap.

Returns:

  • (Boolean)


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

def official?
  user == "Homebrew"
end

#potential_formula_dirsArray<Pathname>

Returns:



502
503
504
# File 'tap.rb', line 502

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)


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

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

  @private = read_or_set_private_config
end

#pypi_formula_mappingsObject

Hash with pypi formula mappings



830
831
832
# File 'tap.rb', line 830

def pypi_formula_mappings
  @pypi_formula_mappings = read_formula_list path/HOMEBREW_TAP_PYPI_FORMULA_MAPPINGS
end

#relative_cask_path(token) ⇒ String

Parameters:

Returns:



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

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

#remoteObject

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



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

def remote
  return default_remote unless installed?

  @remote ||= git_repo.origin_url
end

#remote_repoObject

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



164
165
166
167
168
169
170
# File 'tap.rb', line 164

def remote_repo
  return unless remote

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

#reverse_cask_renamesHash{String => Array<String>}

Hash with tap formula old names. Reverse of #formula_renames.

Returns:



766
767
768
769
770
771
# File 'tap.rb', line 766

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

#shallow?Boolean

True if this Tap is not a full clone.

Returns:

  • (Boolean)


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

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

#style_exceptionsHash

Hash with style exceptions

Returns:



825
826
827
# File 'tap.rb', line 825

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

#tap_migrationsHash{String => String}

Hash with tap migrations.

Returns:



809
810
811
812
813
814
815
# File 'tap.rb', line 809

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

#to_hashHash

Returns:



730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
# File 'tap.rb', line 730

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

#to_sObject



222
223
224
# File 'tap.rb', line 222

def to_s
  name
end

#uninstall(manual: false) ⇒ Object

Uninstall this Tap.



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
# File 'tap.rb', line 448

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

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

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

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

  Commands.rebuild_commands_completion_list
  clear_cache

  return if !manual || !official?

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

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