Class: Tap

Inherits:
Object
  • Object
show all
Extended by:
Cachable, Enumerable
Defined in:
Library/Homebrew/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 case, user/repo will be used as the #name of this Tap, where #user represents GitHub username and #repo represents repository name without leading homebrew-.

Direct Known Subclasses

CoreTap

Constant Summary collapse

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


70
71
72
# File 'Library/Homebrew/tap.rb', line 70

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


65
66
67
# File 'Library/Homebrew/tap.rb', line 65

def name
  @name
end

#pathObject (readonly)

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


74
75
76
# File 'Library/Homebrew/tap.rb', line 74

def path
  @path
end

#repoObject (readonly)

The repository name of this Tap without leading homebrew-.


60
61
62
# File 'Library/Homebrew/tap.rb', line 60

def repo
  @repo
end

#userObject (readonly)

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


57
58
59
# File 'Library/Homebrew/tap.rb', line 57

def user
  @user
end

Class Method Details

.cmd_directoriesObject

An array of all tap cmd directory Pathnames


573
574
575
# File 'Library/Homebrew/tap.rb', line 573

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

.default_cask_tapObject


49
50
51
# File 'Library/Homebrew/tap.rb', line 49

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

.eachObject


555
556
557
558
559
560
561
562
563
564
565
# File 'Library/Homebrew/tap.rb', line 555

def self.each
  return unless TAP_DIRECTORY.directory?

  return to_enum unless block_given?

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

.fetch(*args) ⇒ Object


18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# File 'Library/Homebrew/tap.rb', line 18

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


39
40
41
42
43
44
45
46
47
# File 'Library/Homebrew/tap.rb', line 39

def self.from_path(path)
  match = File.expand_path(path).match(HOMEBREW_TAP_PATH_REGEX)
  raise "Invalid tap path '#{path}'" unless match

  fetch(match[:user], match[:repo])
rescue
  # No need to error as a nil tap is sufficient to show failure.
  nil
end

.namesObject

An array of all installed Tap names.


568
569
570
# File 'Library/Homebrew/tap.rb', line 568

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

Instance Method Details

#==(other) ⇒ Object


550
551
552
553
# File 'Library/Homebrew/tap.rb', line 550

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

#cask_dirObject

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


361
362
363
# File 'Library/Homebrew/tap.rb', line 361

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

#cask_filesObject

An array of all Cask files of this Tap.


393
394
395
396
397
398
399
# File 'Library/Homebrew/tap.rb', line 393

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.


431
432
433
# File 'Library/Homebrew/tap.rb', line 431

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

#clear_cacheObject

Clear internal cache


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'Library/Homebrew/tap.rb', line 89

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
  @config = nil
  remove_instance_variable(:@private) if instance_variable_defined?(:@private)
end

#command_dirObject


478
479
480
# File 'Library/Homebrew/tap.rb', line 478

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

#command_filesObject

An array of all commands files of this Tap.


483
484
485
486
487
488
489
# File 'Library/Homebrew/tap.rb', line 483

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

#configObject

TapConfig of this Tap


202
203
204
205
206
207
208
# File 'Library/Homebrew/tap.rb', line 202

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

    TapConfig.new(self)
  end
end

#contentsObject


365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
# File 'Library/Homebrew/tap.rb', line 365

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)

345
346
347
348
349
# File 'Library/Homebrew/tap.rb', line 345

def custom_remote?
  return true unless remote

  remote.casecmp(default_remote).nonzero?
end

#default_remoteObject

The default remote path to this Tap.


117
118
119
# File 'Library/Homebrew/tap.rb', line 117

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

#formula_dirObject

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


352
353
354
# File 'Library/Homebrew/tap.rb', line 352

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

#formula_filesObject

An array of all Formula files of this Tap.


384
385
386
387
388
389
390
# File 'Library/Homebrew/tap.rb', line 384

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.


426
427
428
# File 'Library/Homebrew/tap.rb', line 426

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

#formula_renamesObject

Hash with tap formula renames


529
530
531
532
533
534
535
536
537
# File 'Library/Homebrew/tap.rb', line 529

def formula_renames
  require "json"

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

#git?Boolean

True if this Tap is a git repository.

Returns:

  • (Boolean)

129
130
131
# File 'Library/Homebrew/tap.rb', line 129

def git?
  path.git?
end

#git_branchObject

git branch for this Tap.


134
135
136
137
138
# File 'Library/Homebrew/tap.rb', line 134

def git_branch
  raise TapUnavailableError, name unless installed?

  path.git_branch
end

#git_headObject

git HEAD for this Tap.


141
142
143
144
145
# File 'Library/Homebrew/tap.rb', line 141

def git_head
  raise TapUnavailableError, name unless installed?

  path.git_head
end

#git_last_commitObject

Time since git last commit for this Tap.


155
156
157
158
159
# File 'Library/Homebrew/tap.rb', line 155

def git_last_commit
  raise TapUnavailableError, name unless installed?

  path.git_last_commit
end

#git_last_commit_dateObject

git last commit date for this Tap.


162
163
164
165
166
# File 'Library/Homebrew/tap.rb', line 162

def git_last_commit_date
  raise TapUnavailableError, name unless installed?

  path.git_last_commit_date
end

#git_short_headObject

git HEAD in short format for this Tap.


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

def git_short_head
  raise TapUnavailableError, name unless installed?

  path.git_short_head
end

#install(full_clone: true, 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.

  • full_clone (Boolean) (defaults to: true)

    If set as true, full clone will be used. If unset/nil, means "no change".

  • quiet (Boolean) (defaults to: false)

    If set, suppress all output.


232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
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
# File 'Library/Homebrew/tap.rb', line 232

def install(full_clone: true, 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"
    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 if !full_clone || !shallow?
    end

    ohai "Unshallowing #{name}" unless quiet
    args = %w[fetch --unshallow]
    args << "-q" if quiet
    path.cd { safe_system "git", *args }
    return
  end

  clear_cache

  ohai "Tapping #{name}" unless quiet
  args =  %W[clone #{requested_remote} #{path}]
  args << "--depth=1" unless full_clone
  args << "-q" if quiet

  begin
    safe_system "git", *args
    unless Readall.valid_tap?(self, aliases: true)
      raise "Cannot tap #{name}: invalid syntax in tap!" unless Homebrew::EnvConfig.developer?
    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(" ")
  puts "Tapped#{formatted_contents} (#{path.abv})." unless quiet
  CacheStoreDatabase.use(:descriptions) do |db|
    DescriptionCacheStore.new(db)
                         .update_from_formula_names!(formula_names)
  end

  return if clone_target
  return unless private?
  return if quiet

  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 [email protected]:#{full_name}.git
  EOS
end

#installed?Boolean

True if this Tap has been installed.

Returns:

  • (Boolean)

211
212
213
# File 'Library/Homebrew/tap.rb', line 211

def installed?
  path.directory?
end

#issues_urlObject

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


170
171
172
173
174
# File 'Library/Homebrew/tap.rb', line 170

def issues_url
  return unless official? || !custom_remote?

  "#{default_remote}/issues"
end

313
314
315
316
317
# File 'Library/Homebrew/tap.rb', line 313

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

#official?Boolean

True if this Tap is an official Homebrew tap.

Returns:

  • (Boolean)

190
191
192
# File 'Library/Homebrew/tap.rb', line 190

def official?
  user == "Homebrew"
end

#pinned?Boolean

True if this Tap has been pinned.

Returns:

  • (Boolean)

498
499
500
501
502
# File 'Library/Homebrew/tap.rb', line 498

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

  @pinned = pinned_symlink_path.directory?
end

#potential_formula_dirsObject


356
357
358
# File 'Library/Homebrew/tap.rb', line 356

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)

195
196
197
198
199
# File 'Library/Homebrew/tap.rb', line 195

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

  @private = read_or_set_private_config
end

#remoteObject

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


110
111
112
113
114
# File 'Library/Homebrew/tap.rb', line 110

def remote
  raise TapUnavailableError, name unless installed?

  @remote ||= path.git_origin
end

#repo_varObject


121
122
123
124
125
126
# File 'Library/Homebrew/tap.rb', line 121

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)

216
217
218
# File 'Library/Homebrew/tap.rb', line 216

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

#tap_migrationsObject

Hash with tap migrations


540
541
542
543
544
545
546
547
548
# File 'Library/Homebrew/tap.rb', line 540

def tap_migrations
  require "json"

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

#to_hashObject


504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
# File 'Library/Homebrew/tap.rb', line 504

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


176
177
178
# File 'Library/Homebrew/tap.rb', line 176

def to_s
  name
end

#uninstallObject

Uninstall this Tap.


320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
# File 'Library/Homebrew/tap.rb', line 320

def uninstall
  require "descriptions"
  raise TapUnavailableError, name unless installed?

  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
  puts "Untapped#{formatted_contents} (#{abv})."

  Commands.rebuild_commands_completion_list
  clear_cache
end

#version_stringObject


180
181
182
183
184
185
186
187
# File 'Library/Homebrew/tap.rb', line 180

def version_string
  return "N/A" unless installed?

  pretty_revision = git_short_head
  return "(no git repository)" unless pretty_revision

  "(git revision #{pretty_revision}; last commit #{git_last_commit_date})"
end