Class: Homebrew::Cmd::InstallCmd Private

Inherits:
AbstractCommand show all
Defined in:
cmd/install.rb,
sorbet/rbi/dsl/homebrew/cmd/install_cmd.rbi

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.

Defined Under Namespace

Classes: Args

Instance Method Summary collapse

Methods inherited from AbstractCommand

command, command_name, dev_cmd?, #initialize, parser, ruby_cmd?

Constructor Details

This class inherits a constructor from Homebrew::AbstractCommand

Instance Method Details

#args ⇒ Homebrew::Cmd::InstallCmd::Args

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:



10
 
# File 'sorbet/rbi/dsl/homebrew/cmd/install_cmd.rbi', line 10

def args; end

#run ⇒ 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.



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
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
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
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
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'cmd/install.rb', line 166

def run
  if args.env.present?
    # Can't use `replacement: false` because `install_args` are used by
    # `build.rb`. Instead, `hide_from_man_page` and don't do anything with
    # this argument here.
    # This odisabled should stick around indefinitely.
    odisabled "brew install --env", "`env :std` in specific formula files"
  end

  args.named.each do |name|
    if (tap_with_name = Tap.with_formula_name(name))
      tap, = tap_with_name
    elsif (tap_with_token = Tap.with_cask_token(name))
      tap, = tap_with_token
    end

    tap&.ensure_installed!
  end

  if args.ignore_dependencies?
    opoo <<~EOS
      #{Tty.bold}`--ignore-dependencies` is an unsupported Homebrew developer option!#{Tty.reset}
      Adjust your PATH to put any preferred versions of applications earlier in the
      PATH rather than using this unsupported option!

    EOS
  end

  begin
    formulae, casks = T.cast(
      args.named.to_formulae_and_casks(warn: false).partition { _1.is_a?(Formula) },
      [T::Array[Formula], T::Array[Cask::Cask]],
    )
  rescue FormulaOrCaskUnavailableError, Cask::CaskUnavailableError
    cask_tap = CoreCaskTap.instance
    if !cask_tap.installed? && (args.cask? || Tap.untapped_official_taps.exclude?(cask_tap.name))
      cask_tap.ensure_installed!
      retry if cask_tap.installed?
    end

    raise
  end

  if casks.any?
    if args.dry_run?
      if (casks_to_install = casks.reject(&:installed?).presence)
        ohai "Would install #{::Utils.pluralize("cask", casks_to_install.count, include_count: true)}:"
        puts casks_to_install.map(&:full_name).join(" ")
      end
      casks.each do |cask|
        dep_names = CaskDependent.new(cask)
                                 .runtime_dependencies
                                 .reject(&:installed?)
                                 .map(&:to_formula)
                                 .map(&:name)
        next if dep_names.blank?

        ohai "Would install #{::Utils.pluralize("dependenc", dep_names.count, plural: "ies", singular: "y",
                                            include_count: true)} for #{cask.full_name}:"
        puts dep_names.join(" ")
      end
      return
    end

    require "cask/installer"

    installed_casks, new_casks = casks.partition(&:installed?)

    new_casks.each do |cask|
      Cask::Installer.new(
        cask,
        binaries:       args.binaries?,
        verbose:        args.verbose?,
        force:          args.force?,
        adopt:          args.adopt?,
        require_sha:    args.require_sha?,
        skip_cask_deps: args.skip_cask_deps?,
        quarantine:     args.quarantine?,
        quiet:          args.quiet?,
      ).install
    end

    if !Homebrew::EnvConfig.no_install_upgrade? && installed_casks.any?
      require "cask/upgrade"

      Cask::Upgrade.upgrade_casks(
        *installed_casks,
        force:          args.force?,
        dry_run:        args.dry_run?,
        binaries:       args.binaries?,
        quarantine:     args.quarantine?,
        require_sha:    args.require_sha?,
        skip_cask_deps: args.skip_cask_deps?,
        verbose:        args.verbose?,
        quiet:          args.quiet?,
        args:,
      )
    end
  end

  formulae = Homebrew::Attestation.sort_formulae_for_install(formulae) if Homebrew::Attestation.enabled?

  # if the user's flags will prevent bottle only-installations when no
  # developer tools are available, we need to stop them early on
  build_flags = []
  unless DevelopmentTools.installed?
    build_flags << "--HEAD" if args.HEAD?
    build_flags << "--build-bottle" if args.build_bottle?
    build_flags << "--build-from-source" if args.build_from_source?

    raise BuildFlagsError.new(build_flags, bottled: formulae.all?(&:bottled?)) if build_flags.present?
  end

  if build_flags.present? && !Homebrew::EnvConfig.developer?
    opoo "building from source is not supported!"
    puts "You're on your own. Failures are expected so don't create any issues, please!"
  end

  installed_formulae = formulae.select do |f|
    Install.install_formula?(
      f,
      head:              args.HEAD?,
      fetch_head:        args.fetch_HEAD?,
      only_dependencies: args.only_dependencies?,
      force:             args.force?,
      quiet:             args.quiet?,
      overwrite:         args.overwrite?,
    )
  end

  return if formulae.any? && installed_formulae.empty?

  Install.perform_preinstall_checks_once
  Install.check_cc_argv(args.cc)

  Install.install_formulae(
    installed_formulae,
    build_bottle:               args.build_bottle?,
    force_bottle:               args.force_bottle?,
    bottle_arch:                args.bottle_arch,
    ignore_deps:                args.ignore_dependencies?,
    only_deps:                  args.only_dependencies?,
    include_test_formulae:      args.include_test_formulae,
    build_from_source_formulae: args.build_from_source_formulae,
    cc:                         args.cc,
    git:                        args.git?,
    interactive:                args.interactive?,
    keep_tmp:                   args.keep_tmp?,
    debug_symbols:              args.debug_symbols?,
    force:                      args.force?,
    overwrite:                  args.overwrite?,
    debug:                      args.debug?,
    quiet:                      args.quiet?,
    verbose:                    args.verbose?,
    dry_run:                    args.dry_run?,
    skip_post_install:          args.skip_post_install?,
  )

  Upgrade.check_installed_dependents(
    installed_formulae,
    flags:                      args.flags_only,
    installed_on_request:       args.named.present?,
    force_bottle:               args.force_bottle?,
    build_from_source_formulae: args.build_from_source_formulae,
    interactive:                args.interactive?,
    keep_tmp:                   args.keep_tmp?,
    debug_symbols:              args.debug_symbols?,
    force:                      args.force?,
    debug:                      args.debug?,
    quiet:                      args.quiet?,
    verbose:                    args.verbose?,
    dry_run:                    args.dry_run?,
  )

  Cleanup.periodic_clean!(dry_run: args.dry_run?)

  Homebrew.messages.display_messages(display_times: args.display_times?)
rescue FormulaUnreadableError, FormulaClassUnavailableError,
       TapFormulaUnreadableError, TapFormulaClassUnavailableError => e
  require "utils/backtrace"

  # Need to rescue before `FormulaUnavailableError` (superclass of this)
  # is handled, as searching for a formula doesn't make sense here (the
  # formula was found, but there's a problem with its implementation).
  $stderr.puts Utils::Backtrace.clean(e) if Homebrew::EnvConfig.developer?
  ofail e.message
rescue FormulaOrCaskUnavailableError, Cask::CaskUnavailableError => e
  Homebrew.failed = true

  # formula name or cask token
  name = case e
  when FormulaOrCaskUnavailableError then e.name
  when Cask::CaskUnavailableError then e.token
  else T.absurd(e)
  end

  if name == "updog"
    ofail "What's updog?"
    return
  end

  opoo e

  reason = MissingFormula.reason(name, silent: true)
  if !args.cask? && reason
    $stderr.puts reason
    return
  end

  # We don't seem to get good search results when the tap is specified
  # so we might as well return early.
  return if name.include?("/")

  require "search"

  package_types = []
  package_types << "formulae" unless args.cask?
  package_types << "casks" unless args.formula?

  ohai "Searching for similarly named #{package_types.join(" and ")}..."

  # Don't treat formula/cask name as a regex
  string_or_regex = name
  all_formulae, all_casks = Search.search_names(string_or_regex, args)

  if all_formulae.any?
    ohai "Formulae", Formatter.columns(all_formulae)
    first_formula = all_formulae.first.to_s
    puts <<~EOS

      To install #{first_formula}, run:
        brew install #{first_formula}
    EOS
  end
  puts if all_formulae.any? && all_casks.any?
  if all_casks.any?
    ohai "Casks", Formatter.columns(all_casks)
    first_cask = all_casks.first.to_s
    puts <<~EOS

      To install #{first_cask}, run:
        brew install --cask #{first_cask}
    EOS
  end
  return if all_formulae.any? || all_casks.any?

  odie "No #{package_types.join(" or ")} found for #{name}."
end