Module: Homebrew::Bundle Private

Defined in:
bundle.rb,
bundle/dsl.rb,
bundle/adder.rb,
bundle/dumper.rb,
bundle/lister.rb,
bundle/checker.rb,
bundle/remover.rb,
bundle/skipper.rb,
bundle/brewfile.rb,
bundle/go_dumper.rb,
bundle/installer.rb,
bundle/go_checker.rb,
bundle/tap_dumper.rb,
bundle/cask_dumper.rb,
bundle/tap_checker.rb,
bundle/brew_checker.rb,
bundle/cask_checker.rb,
bundle/commands/add.rb,
bundle/go_installer.rb,
bundle/brew_services.rb,
bundle/commands/dump.rb,
bundle/commands/exec.rb,
bundle/commands/list.rb,
bundle/tap_installer.rb,
bundle/cask_installer.rb,
bundle/commands/check.rb,
bundle/formula_dumper.rb,
bundle/commands/remove.rb,
bundle/commands/cleanup.rb,
bundle/commands/install.rb,
bundle/whalebrew_dumper.rb,
bundle/formula_installer.rb,
bundle/whalebrew_installer.rb,
bundle/brew_service_checker.rb,
bundle/mac_app_store_dumper.rb,
bundle/mac_app_store_checker.rb,
bundle/mac_app_store_installer.rb,
bundle/vscode_extension_dumper.rb,
bundle/vscode_extension_checker.rb,
bundle/vscode_extension_installer.rb

This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.

Defined Under Namespace

Modules: Adder, BrewServices, Brewfile, CaskDumper, CaskInstaller, Checker, Commands, Dumper, FormulaDumper, GoDumper, GoInstaller, Installer, Lister, MacAppStoreDumper, MacAppStoreInstaller, Remover, Skipper, TapDumper, TapInstaller, VscodeExtensionDumper, VscodeExtensionInstaller, WhalebrewDumper, WhalebrewInstaller Classes: Dsl, FormulaInstaller

Class Method Summary collapse

Class Method Details

.brew(*args, verbose: false) ⇒ 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.

Parameters:

  • args (T.anything)
  • verbose (Boolean) (defaults to: false)

Returns:

  • (Boolean) 


38
39
40
 
# File 'bundle.rb', line 38

def brew(*args, verbose: false)
  system(HOMEBREW_BREW_FILE, *args, verbose:)
end

.cask_installed? ⇒ 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.

Returns:

  • (Boolean) 


76
77
78
79
80
 
# File 'bundle.rb', line 76

def cask_installed?
  @cask_installed ||= File.directory?("#{HOMEBREW_PREFIX}/Caskroom") &&
                      (File.directory?("#{HOMEBREW_LIBRARY}/Taps/homebrew/homebrew-cask") ||
                       !Homebrew::EnvConfig.no_install_from_api?)
end

.exchange_uid_if_needed!(&block) ⇒ 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.

Parameters:

  • block (T.proc.returns(T.anything))

Returns:

  • (T.untyped) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'bundle.rb', line 90

def exchange_uid_if_needed!(&block)
  euid = Process.euid
  uid = Process.uid
  return yield if euid == uid

  old_euid = euid
  process_reexchangeable = Process::UID.re_exchangeable?
  if process_reexchangeable
    Process::UID.re_exchange
  else
    Process::Sys.seteuid(uid)
  end

  home = T.must(Etc.getpwuid(Process.uid)).dir
  return_value = with_env("HOME" => home, &block)

  if process_reexchangeable
    Process::UID.re_exchange
  else
    Process::Sys.seteuid(old_euid)
  end

  return_value
end

.formula_versions_from_env(formula_name) ⇒ 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.

Parameters:

Returns:



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'bundle.rb', line 116

def formula_versions_from_env(formula_name)
  @formula_versions_from_env ||= begin
    formula_versions = {}

    ENV.each do |key, value|
      match = key.match(/^HOMEBREW_BUNDLE_FORMULA_VERSION_(.+)$/)
      next if match.blank?

      env_formula_name = match[1]
      next if env_formula_name.blank?

      ENV.delete(key)
      formula_versions[env_formula_name] = value
    end

    formula_versions
  end

  # Fix up formula name for a valid environment variable name.
  formula_env_name = formula_name.upcase
                                 .gsub("@", "AT")
                                 .tr("+", "X")
                                 .tr("-", "_")

  @formula_versions_from_env[formula_env_name]
end

.go_installed? ⇒ 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.

Returns:

  • (Boolean) 


71
72
73
 
# File 'bundle.rb', line 71

def go_installed?
  @go_installed ||= which_go.present?
end

.mas_installed? ⇒ 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.

Returns:

  • (Boolean) 


43
44
45
 
# File 'bundle.rb', line 43

def mas_installed?
  @mas_installed ||= which_formula?("mas")
end

.prepend_pkgconf_path_if_needed! ⇒ 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.



144
 
# File 'bundle.rb', line 144

def prepend_pkgconf_path_if_needed!; end

.reset! ⇒ 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.



147
148
149
150
151
152
153
154
155
156
157
 
# File 'bundle.rb', line 147

def reset!
  @mas_installed = T.let(nil, T.nilable(T::Boolean))
  @vscode_installed = T.let(nil, T.nilable(T::Boolean))
  @which_vscode = T.let(nil, T.nilable(Pathname))
  @which_go = T.let(nil, T.nilable(Pathname))
  @whalebrew_installed = T.let(nil, T.nilable(T::Boolean))
  @go_installed = T.let(nil, T.nilable(T::Boolean))
  @cask_installed = T.let(nil, T.nilable(T::Boolean))
  @formula_versions_from_env = T.let(nil, T.nilable(T::Hash[String, String]))
  @upgrade_formulae = T.let(nil, T.nilable(T::Array[String]))
end

.system(cmd, *args, verbose: false) ⇒ 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.

Parameters:

  • cmd (String, Pathname)
  • args (T.anything)
  • verbose (Boolean) (defaults to: false)

Returns:

  • (Boolean) 


20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'bundle.rb', line 20

def system(cmd, *args, verbose: false)
  return super cmd, *args if verbose

  logs = []
  success = T.let(false, T::Boolean)
  IO.popen([cmd, *args], err: [:child, :out]) do |pipe|
    while (buf = pipe.gets)
      logs << buf
    end
    Process.wait(pipe.pid)
    success = $CHILD_STATUS.success?
    pipe.close
  end
  puts logs.join unless success
  success
end

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

Returns:



15
16
17
 
# File 'bundle.rb', line 15

def upgrade_formulae
  @upgrade_formulae || []
end

.upgrade_formulae=(args_upgrade_formula) ⇒ 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.

Parameters:

  • args_upgrade_formula (String, nil) 


10
11
12
 
# File 'bundle.rb', line 10

def upgrade_formulae=(args_upgrade_formula)
  @upgrade_formulae = args_upgrade_formula.to_s.split(",")
end

.vscode_installed? ⇒ 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.

Returns:

  • (Boolean) 


48
49
50
 
# File 'bundle.rb', line 48

def vscode_installed?
  @vscode_installed ||= which_vscode.present?
end

.whalebrew_installed? ⇒ 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.

Returns:

  • (Boolean) 


61
62
63
 
# File 'bundle.rb', line 61

def whalebrew_installed?
  @whalebrew_installed ||= which_formula?("whalebrew")
end

.which_formula?(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.

Parameters:

Returns:

  • (Boolean) 


83
84
85
86
87
 
# File 'bundle.rb', line 83

def which_formula?(name)
  formula = Formulary.factory(name)
  ENV["PATH"] = "#{formula.opt_bin}:#{ENV.fetch("PATH", nil)}" if formula.any_version_installed?
  which(name).present?
end

.which_go ⇒ 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.

Returns:



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

def which_go
  @which_go ||= which("go", ORIGINAL_PATHS)
end

.which_vscode ⇒ 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.

Returns:



53
54
55
56
57
58
 
# File 'bundle.rb', line 53

def which_vscode
  @which_vscode ||= which("code", ORIGINAL_PATHS)
  @which_vscode ||= which("codium", ORIGINAL_PATHS)
  @which_vscode ||= which("cursor", ORIGINAL_PATHS)
  @which_vscode ||= which("code-insiders", ORIGINAL_PATHS)
end