Class: Homebrew::Bundle::Winget Private

Inherits:
Extension show all
Defined in:
bundle/extensions/winget.rb

Overview

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.

Support dumping and installing Windows packages through WinGet from WSL.

Defined Under Namespace

Classes: App, self

Constant Summary collapse

DEFAULT_SOURCE =

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

"winget"
SOURCES =

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

T.let([DEFAULT_SOURCE, "msstore"].freeze, T::Array[String])
ELEVATED_INSTALL_FAILURE_PATTERNS =

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

T.let([
  /Installer failed with exit code:\s*1603/i,
  /\b(?:admin|administrator|elevat|UAC)\b/i,
].freeze, T::Array[Regexp])
INSTALLER_UI_FAILURE_PATTERNS =

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

T.let([
  /\b(?:interactive|user input|user cancelled)\b/i,
].freeze, T::Array[Regexp])
INTERNAL_PACKAGE_PATTERNS =

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

T.let([
  /\AApp Installer\z/i,
  /\A9NBLGGH4NNS1\z/i,
  /\AMicrosoft Store\z/i,
  /\AStore Experience Host\z/i,
  /\AWindows (?:Feature|Web) Experience Pack\z/i,
  /\AMicrosoft Edge WebView2 Runtime\z/i,
  /\AMicrosoft Visual C\+\+/i,
  /\AWindows App Runtime/i,
  /\AMicrosoft\.(?:AppInstaller|DesktopAppInstaller|DirectX|DotNet|Edge|EdgeWebView2Runtime|GameInput)\b/i,
  /\AMicrosoft\.(?:HEVCVideoExtension|NET\.Native|RawImageExtension)\b/i,
  /\AMicrosoft\.(?:OneDrive|WSL)\z/i,
  /\AMicrosoft\.(?:Services\.Store\.Engagement|StorePurchaseApp|UI\.Xaml|VCLibs|WindowsAppRuntime)\b/i,
  /\AMicrosoft\.(?:WindowsStore|WebMediaExtensions|WebpImageExtension|VP9VideoExtensions)\b/i,
  /\AMicrosoft\.VCRedist\./i,
  /\ANvidia\.PhysX\z/i,
].freeze, T::Array[Regexp])

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Extension

check, cleanup_disable_description, cleanup_disable_env, cleanup_supported?, disable_predicate_method, dump, dump_disable_description, dump_disable_env, dump_disable_predicate_method, dump_disable_supported?, dump_output, dump_supported?, dump_with, #failure_reason, fetchable_name, flag, inherited, install_package!, install_supported?, install_verb, legacy_check_step, package_description, package_installed?, package_manager_env, package_manager_executable!, package_manager_installed?, package_manager_name, package_record, predicate_method, quote, remove_supported?, uninstall_package!, with_package_manager_env

Methods inherited from PackageType

check, #checkable_entries, dump, dump_output, dump_supported?, #exit_early_check, #failure_reason, fetchable_name, #find_actionable, #full_check, inherited, install_supported?, install_verb

Class Method Details

.add_supported? ⇒ 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) 


63
64
65
 
# File 'bundle/extensions/winget.rb', line 63

def add_supported?
  false
end

.app_installed?(id, source:) ⇒ 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) 


339
340
341
 
# File 'bundle/extensions/winget.rb', line 339

def app_installed?(id, source:)
  installed_app_records.any? { |app_id, app_source| app_id.casecmp?(id) && app_source == source }
end

.apps ⇒ Array<App>

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:



138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'bundle/extensions/winget.rb', line 138

def apps
  apps = @apps
  return apps if apps

  @apps = if (winget = package_manager_executable)
    SOURCES.flat_map do |source|
      export_apps(winget, source:)
    end
  end
  return [] if @apps.nil?

  @apps
end

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:



55
 
# File 'bundle/extensions/winget.rb', line 55

def banner_name = "WinGet packages"

.check_label ⇒ 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:



52
 
# File 'bundle/extensions/winget.rb', line 52

def check_label = "WinGet Package"

.cleanup!(items) ⇒ 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:



326
327
328
329
330
331
332
333
334
335
336
 
# File 'bundle/extensions/winget.rb', line 326

def cleanup!(items)
  winget = package_manager_executable
  return if winget.nil?

  items.each do |item|
    app = parse_cleanup_item(item)
    Bundle.system(winget, "uninstall", "--id", app.id, "--exact", "--source", app.source,
                  "--accept-source-agreements", "--disable-interactivity", verbose: false)
  end
  puts "Uninstalled #{items.size} WinGet package#{"s" if items.size != 1}"
end

.cleanup_heading ⇒ 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:



68
69
70
 
# File 'bundle/extensions/winget.rb', line 68

def cleanup_heading
  banner_name
end

.cleanup_item(app) ⇒ 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:



287
288
289
 
# File 'bundle/extensions/winget.rb', line 287

def cleanup_item(app)
  JSON.generate("id" => app.id, "name" => app.name, "source" => app.source)
end

.cleanup_item_name(item) ⇒ 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:



292
293
294
295
296
297
298
299
300
 
# File 'bundle/extensions/winget.rb', line 292

def cleanup_item_name(item)
  app = parse_cleanup_item(item)
  return app.id if app.name == app.id && app.source == DEFAULT_SOURCE
  return "#{app.id} (#{app.source})" if app.name == app.id

  return "#{app.name} (#{app.id})" if app.source == DEFAULT_SOURCE

  "#{app.name} (#{app.id}, #{app.source})"
end

.cleanup_items(entries) ⇒ 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.

Parameters:

Returns:



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'bundle/extensions/winget.rb', line 303

def cleanup_items(entries)
  kept_apps = entries.filter_map do |entry|
    next if entry.type != type

    [entry.options.fetch(:id, entry.name).to_s, entry.options.fetch(:source, DEFAULT_SOURCE).to_s]
  end
  return [].freeze if kept_apps.empty?

  winget = package_manager_executable
  return [].freeze if winget.nil?

  cleanup_packages = SOURCES.flat_map { |source| exported_apps(winget, source:) }
                            .reject { |app| internal_package?(app) }
                            .sort_by do |app|
                              [SOURCES.index(app.source) || SOURCES.length, app.name.downcase]
                            end
  packages_to_cleanup = cleanup_packages.reject do |app|
    kept_apps.any? { |id, source| app.id.casecmp?(id) && app.source == source }
  end
  packages_to_cleanup.map { |app| cleanup_item(app) }
end

.dump_entry(package) ⇒ 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:



277
278
279
280
281
282
283
284
 
# File 'bundle/extensions/winget.rb', line 277

def dump_entry(package)
  app = T.cast(package, App)
  line = "winget #{quote(app.name)}"
  line += ", id: #{quote(app.id)}" if app.id != app.name
  return line if app.source == DEFAULT_SOURCE

  "#{line}, source: #{quote(app.source)}"
end

.dump_name(package) ⇒ 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:



272
273
274
 
# File 'bundle/extensions/winget.rb', line 272

def dump_name(package)
  T.cast(package, App).name
end

.elevation_failure?(output) ⇒ 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) 


477
478
479
 
# File 'bundle/extensions/winget.rb', line 477

def elevation_failure?(output)
  ELEVATED_INSTALL_FAILURE_PATTERNS.any? { |pattern| output.match?(pattern) }
end

.entry(name, options = {}) ⇒ Dsl::Entry

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:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'bundle/extensions/winget.rb', line 73

def entry(name, options = {})
  unknown_options = options.keys - [:id, :source]
  raise "unknown options(#{unknown_options.inspect}) for winget" if unknown_options.present?

  id = options.fetch(:id, name)
  raise "options[:id](#{id.inspect}) should be a String object" unless id.is_a?(String)

  source = options.fetch(:source, DEFAULT_SOURCE)
  raise "options[:source](#{source.inspect}) should be a String object" unless source.is_a?(String)
  unless SOURCES.include?(source)
    raise "options[:source](#{source.inspect}) should be one of #{SOURCES.inspect}"
  end

  Dsl::Entry.new(type, name, id:, source:)
end

.export_apps(winget, source:) ⇒ Array<App>

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:



153
154
155
156
157
158
 
# File 'bundle/extensions/winget.rb', line 153

def export_apps(winget, source:)
  names = listed_app_names(winget, source:)
  exported_apps(winget, source:).map do |app|
    App.new(id: app.id, name: names.fetch(app.id.downcase, app.name), source: app.source)
  end
end

.exported_apps(winget, source:) ⇒ Array<App>

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:



161
162
163
164
165
166
167
168
169
 
# File 'bundle/extensions/winget.rb', line 161

def exported_apps(winget, source:)
  Tempfile.create(["brew-bundle-winget", ".json"]) do |file|
    next [] unless Kernel.system(winget.to_s, "export", "--source", source, "--output",
                                 windows_export_path(file.path), "--accept-source-agreements",
                                 "--disable-interactivity", out: File::NULL, err: File::NULL)

    parse_export(File.read(file.path), source:)
  end
end

.install!(name, id: nil, with: nil, preinstall: true, no_upgrade: false, verbose: false, force: false, source: DEFAULT_SOURCE, **options) ⇒ 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:

  • name (String)
  • id (String, nil) (defaults to: nil)
  • with (Array<String>, nil) (defaults to: nil)
  • preinstall (Boolean) (defaults to: true)
  • no_upgrade (Boolean) (defaults to: false)
  • verbose (Boolean) (defaults to: false)
  • force (Boolean) (defaults to: false)
  • source (String) (defaults to: DEFAULT_SOURCE)
  • options (Homebrew::Bundle::EntryOption)

Returns:

  • (Boolean) 


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
414
415
416
417
418
419
420
 
# File 'bundle/extensions/winget.rb', line 387

def install!(name, id: nil, with: nil, preinstall: true, no_upgrade: false, verbose: false, force: false,
             source: DEFAULT_SOURCE, **options)
  _ = with
  _ = no_upgrade
  _ = force
  _ = options

  return true unless preinstall

  id ||= name
  winget = package_manager_executable!
  args = ["install", "--id", id, "--exact", "--source", source,
          "--accept-source-agreements", "--accept-package-agreements",
          "--disable-interactivity"]
  success, output = run_install_command(winget, args, verbose:, elevated: false)
  if !success && elevation_failure?(output)
    puts "WinGet install for #{name} may require Windows UAC/elevation; retrying elevated."
    success, elevated_output = run_install_command(winget, args, verbose:, elevated: true)
    output = elevated_output.presence || output
  end
  unless success
    report_install_failure(name, id:, source:, output:)
    return false
  end

  unless apps.any? { |app| app.id.casecmp?(id) && app.source == source }
    apps << App.new(id:, name:, source:)
    @packages = nil
  end
  installed_app_records << [id, source] unless installed_app_records.any? do |app_id, app_source|
    app_id.casecmp?(id) && app_source == source
  end
  true
end

.installed_app_records ⇒ Array<Array<(String, 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:



264
265
266
267
268
269
 
# File 'bundle/extensions/winget.rb', line 264

def installed_app_records
  installed_app_records = @installed_app_records
  return installed_app_records if installed_app_records

  @installed_app_records = apps.map { |app| [app.id, app.source] }
end

.installed_packages ⇒ Array<App>

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:



252
253
254
 
# File 'bundle/extensions/winget.rb', line 252

def installed_packages
  apps
end

.installer_ui_failure?(output) ⇒ 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) 


482
483
484
 
# File 'bundle/extensions/winget.rb', line 482

def installer_ui_failure?(output)
  INSTALLER_UI_FAILURE_PATTERNS.any? { |pattern| output.match?(pattern) }
end

.internal_package?(app) ⇒ 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) 


257
258
259
260
261
 
# File 'bundle/extensions/winget.rb', line 257

def internal_package?(app)
  INTERNAL_PACKAGE_PATTERNS.any? do |pattern|
    pattern.match?(app.id) || pattern.match?(app.name)
  end
end

.listed_app_names(winget, source:) ⇒ Hash{String => 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:



172
173
174
175
176
177
 
# File 'bundle/extensions/winget.rb', line 172

def listed_app_names(winget, source:)
  output = Utils.popen_read(winget, "list", "--source", source, "--accept-source-agreements",
                            "--disable-interactivity", "--nowarn", err: :close)

  parse_list_names(output)
end

.package_manager_executable ⇒ 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:



90
91
92
93
94
 
# File 'bundle/extensions/winget.rb', line 90

def package_manager_executable
  return unless OS.wsl?

  which("winget.exe", ORIGINAL_PATHS) || windows_apps_executables.find(&:executable?)
end

.packages ⇒ Array<App>

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:



243
244
245
246
247
248
249
 
# File 'bundle/extensions/winget.rb', line 243

def packages
  packages = @packages
  return packages if packages

  @packages = apps.reject { |app| internal_package?(app) }
                  .sort_by { |app| [SOURCES.index(app.source) || SOURCES.length, app.name.downcase] }
end

.parse_cleanup_item(item) ⇒ App

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:

Raises:

  • (TypeError) 


504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'bundle/extensions/winget.rb', line 504

def parse_cleanup_item(item)
  parsed = JSON.parse(item)
  raise TypeError, "Invalid WinGet cleanup item: #{item}" unless parsed.is_a?(Hash)

  id = parsed["id"]
  name = parsed["name"]
  source = parsed["source"]
  if !id.is_a?(String) || !name.is_a?(String) || !source.is_a?(String)
    raise TypeError, "Invalid WinGet cleanup item: #{item}"
  end

  App.new(id:, name:, source:)
end

.parse_export(output, source:) ⇒ Array<App>

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:



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
 
# File 'bundle/extensions/winget.rb', line 216

def parse_export(output, source:)
  export = JSON.parse(output)
  return [] unless export.is_a?(Hash)

  sources = export["Sources"]
  return [] unless sources.is_a?(Array)

  sources.flat_map do |source_export|
    next [] unless source_export.is_a?(Hash)

    packages = source_export["Packages"]
    next [] unless packages.is_a?(Array)

    packages.filter_map do |package|
      next unless package.is_a?(Hash)

      id = package["PackageIdentifier"]
      next if !id.is_a?(String) || id.blank?

      App.new(id:, name: id, source:)
    end
  end
rescue JSON::ParserError
  []
end

.parse_list_names(output) ⇒ Hash{String => 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:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'bundle/extensions/winget.rb', line 180

def parse_list_names(output)
  lines = output.encode("UTF-8", invalid: :replace, undef: :replace)
                .delete("\r")
                .lines
                .map(&:chomp)
  header_index = lines.index { |line| line.match?(/\bName\s+Id\s+Version\b/) }
  return {} if header_index.nil?

  header = lines[header_index]
  return {} if header.nil?

  header_start = header.index("Name")
  id_column = header.index("Id", header_start || 0)
  version_column = header.index("Version", header_start || 0)
  return {} if header_start.nil? || id_column.nil? || version_column.nil?

  lines.drop(header_index + 1).each_with_object({}) do |line, names|
    next if line.blank? || line[header_start..].to_s.match?(/\A-+\z/)

    name = line[header_start...id_column].to_s.strip
    id = line[id_column...version_column].to_s.strip
    names[id.downcase] = name if name.present? && id.present?
  end
end

.powershell_quote(value) ⇒ 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:



472
473
474
 
# File 'bundle/extensions/winget.rb', line 472

def powershell_quote(value)
  "'#{value.gsub("'", "''")}'"
end

.preinstall!(name, id: nil, with: nil, no_upgrade: false, verbose: false, source: DEFAULT_SOURCE, **options) ⇒ 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) 


354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'bundle/extensions/winget.rb', line 354

def preinstall!(name, id: nil, with: nil, no_upgrade: false, verbose: false, source: DEFAULT_SOURCE,
                **options)
  _ = with
  _ = no_upgrade
  _ = options

  id ||= name

  unless package_manager_installed?
    raise "Unable to install #{name} WinGet package. winget.exe is not installed."
  end

  if app_installed?(id, source:)
    puts "Skipping install of #{name} WinGet package. It is already installed." if verbose
    return false
  end

  true
end

.report_install_failure(name, id:, source:, output:) ⇒ 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:



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'bundle/extensions/winget.rb', line 487

def report_install_failure(name, id:, source:, output:)
  puts "WinGet failed to install #{name} (#{id}) from #{source}."
  if elevation_failure?(output)
    puts "The installer may require Windows UAC/elevation."
    puts "Try installing it from an elevated Windows Terminal:"
    puts "  winget install --id #{id} --exact --source #{source} --disable-interactivity"
  elsif installer_ui_failure?(output)
    puts "The installer appears to require installer UI or user input, which brew bundle does not automate."
    puts "Install it manually from Windows:"
    puts "  winget install --id #{id} --exact --source #{source}"
  else
    puts "Try installing it manually from Windows:"
    puts "  winget install --id #{id} --exact --source #{source}"
  end
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.



131
132
133
134
135
 
# File 'bundle/extensions/winget.rb', line 131

def reset!
  @apps = T.let(nil, T.nilable(T::Array[App]))
  @packages = T.let(nil, T.nilable(T::Array[App]))
  @installed_app_records = T.let(nil, T.nilable(T::Array[[String, String]]))
end

.run_elevated_install_command(winget, args, verbose:) ⇒ Array<(Boolean, 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:



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'bundle/extensions/winget.rb', line 448

def run_elevated_install_command(winget, args, verbose:)
  powershell = which("powershell.exe", ORIGINAL_PATHS) ||
               Pathname.new("/mnt/c/Windows/System32/WindowsPowerShell/v1.0/powershell.exe")
  return [false, "powershell.exe is not available.\n"] unless powershell.executable?

  winget_path = winget.to_s.include?("/") ? windows_export_path(winget.to_s) : winget.to_s
  argument_list = args.map { |arg| powershell_quote(arg) }.join(", ")
  script = <<~POWERSHELL
    $startProcessArgs = @{
      FilePath = #{powershell_quote(winget_path)}
      ArgumentList = @(#{argument_list})
      Verb = 'RunAs'
      Wait = $true
      PassThru = $true
    }
    $process = Start-Process @startProcessArgs
    $process.WaitForExit()
    exit $process.ExitCode
  POWERSHELL

  [Bundle.system(powershell, "-NoProfile", "-Command", script, verbose:), ""]
end

.run_install_command(winget, args, verbose:, elevated:) ⇒ Array<(Boolean, 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:



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'bundle/extensions/winget.rb', line 430

def run_install_command(winget, args, verbose:, elevated:)
  return run_elevated_install_command(winget, args, verbose:) if elevated

  logs = T.let([], T::Array[String])
  success = T.let(false, T::Boolean)
  IO.popen([winget.to_s, *args], err: [:child, :out]) do |pipe|
    while (line = pipe.gets)
      print line if verbose
      logs << line
    end
    Process.wait(pipe.pid)
    success = $CHILD_STATUS.success?
    pipe.close
  end
  [success, logs.join]
end

.switch_description(description) ⇒ 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:



58
59
60
 
# File 'bundle/extensions/winget.rb', line 58

def switch_description(description)
  "#{super} Note: WSL only."
end

.type ⇒ Symbol

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:



49
 
# File 'bundle/extensions/winget.rb', line 49

def type = :winget

.windows_apps_executables ⇒ Array<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:



97
98
99
100
101
102
103
104
105
 
# File 'bundle/extensions/winget.rb', line 97

def windows_apps_executables
  [
    ENV.fetch("LOCALAPPDATA", nil)&.+("\\Microsoft\\WindowsApps\\winget.exe"),
    ENV.fetch("USERPROFILE", nil)&.+("\\AppData\\Local\\Microsoft\\WindowsApps\\winget.exe"),
    windows_local_appdata&.+("\\Microsoft\\WindowsApps\\winget.exe"),
  ].compact.uniq.filter_map do |path|
    windows_path_to_wsl_path(path) if path.exclude?("%")
  end
end

.windows_export_path(path) ⇒ 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:



206
207
208
209
210
211
212
213
 
# File 'bundle/extensions/winget.rb', line 206

def windows_export_path(path)
  wslpath = which("wslpath", ORIGINAL_PATHS)
  return path if wslpath.nil?

  Utils.safe_popen_read(wslpath, "-w", path, err: :close).chomp.presence || path
rescue ErrorDuringExecution
  path
end

.windows_local_appdata ⇒ 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:



108
109
110
111
112
113
 
# File 'bundle/extensions/winget.rb', line 108

def windows_local_appdata
  cmd = which("cmd.exe", ORIGINAL_PATHS) || Pathname.new("/mnt/c/Windows/System32/cmd.exe")
  return unless cmd.executable?

  `"#{cmd}" /d /c echo %LOCALAPPDATA% 2>/dev/null`.strip.presence
end

.windows_path_to_wsl_path(path) ⇒ 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.

Parameters:

Returns:



116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'bundle/extensions/winget.rb', line 116

def windows_path_to_wsl_path(path)
  path = path.tr("\\", "/")
  return Pathname.new(path) if path.start_with?("/")

  match = path.match(%r{\A([A-Za-z]):/(.+)\z})
  return if match.nil?

  drive = match[1]
  relative_path = match[2]
  return if drive.nil? || relative_path.nil?

  Pathname.new("/mnt/#{drive.downcase}/#{relative_path}")
end

Instance Method Details

#format_checkable(entries) ⇒ Array<Object>

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:



520
521
522
523
524
525
 
# File 'bundle/extensions/winget.rb', line 520

def format_checkable(entries)
  checkable_entries(entries).map do |entry|
    App.new(id: T.cast(entry.options.fetch(:id), String), name: entry.name,
            source: T.cast(entry.options.fetch(:source), String))
  end
end

#installed_and_up_to_date?(package, no_upgrade: 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:

  • package (Object)
  • no_upgrade (Boolean) (defaults to: false)

Returns:

  • (Boolean) 


528
529
530
531
532
533
 
# File 'bundle/extensions/winget.rb', line 528

def installed_and_up_to_date?(package, no_upgrade: false)
  _ = no_upgrade

  app = T.cast(package, App)
  self.class.app_installed?(app.id, source: app.source)
end