Class: Homebrew::Bundle::Flatpak Private

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

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.

Constant Summary collapse

Package =

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.type_alias { { name: String, remote: String, remote_url: T.nilable(String) } }
PACKAGE_TYPE =

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. 

:flatpak
PACKAGE_TYPE_NAME =

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. 

"Flatpak"
"Flatpak packages"

Constants inherited from Extension

Extension::EntryOptions

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Extension

add_supported?, banner_name, check, check_label, cleanup_supported?, dump_disable_description, dump_disable_env, dump_disable_predicate_method, dump_disable_supported?, dump_name, dump_supported?, dump_with, flag, inherited, install_package!, install_supported?, package_description, package_manager_executable, package_manager_installed?, package_manager_name, package_record, predicate_method, quote, remove_supported?, type

Methods inherited from Checker::Base

#checkable_entries, #exit_early_check, #find_actionable, #full_check

Class Method Details

.add_remote!(flatpak, remote_name, url, verbose:) ⇒ 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.

Add a remote with appropriate flags

Parameters:

Returns:

  • (Boolean) 


337
338
339
340
341
342
343
344
345
346
 
# File 'bundle/extensions/flatpak.rb', line 337

def add_remote!(flatpak, remote_name, url, verbose:)
  if url.end_with?(".flatpakrepo")
    Bundle.system(flatpak, "remote-add", "--if-not-exists", "--system", remote_name, url, verbose:)
  else
    # For bare repository URLs, add with --no-gpg-verify for user repos
    Bundle.system(
      flatpak, "remote-add", "--if-not-exists", "--system", "--no-gpg-verify", remote_name, url, verbose:
    )
  end
end

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



380
381
382
383
384
385
 
# File 'bundle/extensions/flatpak.rb', line 380

def cleanup!(flatpaks)
  flatpaks.each do |flatpak_name|
    Kernel.system("flatpak", "uninstall", "-y", "--system", flatpak_name)
  end
  puts "Uninstalled #{flatpaks.size} flatpak#{"s" if flatpaks.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:



22
23
24
 
# File 'bundle/extensions/flatpak.rb', line 22

def cleanup_heading
  "flatpaks"
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:



366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'bundle/extensions/flatpak.rb', line 366

def cleanup_items(entries)
  return [].freeze unless Bundle.flatpak_installed?

  kept_flatpaks = entries.filter_map do |entry|
    entry = T.cast(entry, Dsl::Entry)
    entry.name if entry.type == type
  end

  return [].freeze if kept_flatpaks.empty?

  packages - kept_flatpaks
end

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



165
166
167
 
# File 'bundle/extensions/flatpak.rb', line 165

def dump
  packages_with_remotes.map { |package| dump_entry(package) }.join("\n")
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:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'bundle/extensions/flatpak.rb', line 138

def dump_entry(package)
  package = T.cast(package, Package)
  remote = package[:remote]
  remote_url = package[:remote_url]
  name = package[:name]

  if remote == "flathub"
    # Tier 1: Don't specify remote for flathub (default)
    "flatpak #{quote(name)}"
  elsif remote&.end_with?("-origin")
    # Tier 2: Single-app remote - dump with URL only
    if remote_url.present?
      "flatpak #{quote(name)}, remote: #{quote(remote_url)}"
    else
      # Fallback if URL not available (shouldn't happen for -origin remotes)
      "flatpak #{quote(name)}, remote: #{quote(remote)}"
    end
  elsif remote_url.present?
    # Tier 3: Named shared remote - dump with name and URL
    "flatpak #{quote(name)}, remote: #{quote(remote)}, url: #{quote(remote_url)}"
  else
    # Named remote without URL (user-defined or system remote)
    "flatpak #{quote(name)}, remote: #{quote(remote)}"
  end
end

.ensure_named_remote_exists!(flatpak, remote_name, url, verbose:) ⇒ 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.

Ensure a named shared remote exists (Tier 3) Warn but don't change if URL differs (user explicitly named it)

Parameters:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'bundle/extensions/flatpak.rb', line 309

def ensure_named_remote_exists!(flatpak, remote_name, url, verbose:)
  existing_url = get_remote_url(flatpak, remote_name)

  if existing_url && existing_url != url
    # Named remote with different URL - warn but don't change (user explicitly named it)
    puts "Warning: Remote '#{remote_name}' exists with different URL (#{existing_url}), using existing"
    return
  end

  return if existing_url

  puts "Adding named remote #{remote_name} from #{url}" if verbose
  add_remote!(flatpak, remote_name, url, verbose:)
end

.ensure_single_app_remote_exists!(flatpak, remote_name, url, verbose:) ⇒ 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.

Ensure a single-app remote exists (Tier 2) Safe to replace if URL differs since it's isolated per-app

Parameters:



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'bundle/extensions/flatpak.rb', line 290

def ensure_single_app_remote_exists!(flatpak, remote_name, url, verbose:)
  existing_url = get_remote_url(flatpak, remote_name)

  if existing_url && existing_url != url
    # Single-app remote with different URL - safe to replace
    puts "Replacing single-app remote #{remote_name} (URL changed)" if verbose
    Bundle.system(flatpak, "remote-delete", "--system", "--force", remote_name, verbose:)
    existing_url = nil
  end

  return if existing_url

  puts "Adding single-app remote #{remote_name} from #{url}" if verbose
  add_remote!(flatpak, remote_name, url, verbose:)
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:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'bundle/extensions/flatpak.rb', line 34

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

  remote = options[:remote]
  url = options[:url]
  if !remote.nil? && !remote.is_a?(String)
    raise "options[:remote](#{remote.inspect}) should be a String object"
  end
  raise "options[:url](#{url.inspect}) should be a String object" if !url.nil? && !url.is_a?(String)

  # Validate: url: can only be used with a named remote (not a URL remote)
  if url && remote&.start_with?("http://", "https://")
    raise "url: parameter cannot be used when remote: is already a URL"
  end

  normalized_options = {}
  normalized_options[:remote] = remote || "flathub"
  normalized_options[:url] = url if url

  Dsl::Entry.new(type, name, normalized_options)
end

.generate_single_app_remote_name(app_id) ⇒ 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.

Generate a single-app remote name (Tier 2) Pattern: -origin (matches Flatpak's native behavior for .flatpakref)

Parameters:

Returns:



283
284
285
 
# File 'bundle/extensions/flatpak.rb', line 283

def generate_single_app_remote_name(app_id)
  "#{app_id}-origin"
end

.get_remote_url(flatpak, remote_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.

Get URL for an existing remote, or nil if not found

Parameters:

Returns:



326
327
328
329
330
331
332
333
 
# File 'bundle/extensions/flatpak.rb', line 326

def get_remote_url(flatpak, remote_name)
  output = `#{flatpak} remote-list --system --columns=name,url 2>/dev/null`.chomp
  output.split("\n").each do |line|
    parts = line.split("\t")
    return parts[1] if parts[0] == remote_name
  end
  nil
end

.install!(name, with: nil, preinstall: true, no_upgrade: false, verbose: false, force: false, remote: "flathub", url: nil, **_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)
  • 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)
  • remote (String) (defaults to: "flathub")
  • url (String, nil) (defaults to: nil)
  • _options (T.anything)

Returns:

  • (Boolean) 


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

def install!(name, with: nil, preinstall: true, no_upgrade: false, verbose: false, force: false,
             remote: "flathub", url: nil, **_options)
  _ = with
  _ = no_upgrade
  _ = force

  return true unless Bundle.flatpak_installed?
  return true unless preinstall

  flatpak = Bundle.which_flatpak.to_s

  # 3-tier remote handling:
  # - Tier 1: no URL → use named remote (default: flathub)
  # - Tier 2: URL only → single-app remote (<app-id>-origin)
  # - Tier 3: URL + name → named shared remote

  if url.present?
    # Tier 3: Named remote with URL - create shared remote
    puts "Installing #{name} Flatpak from #{remote} (#{url}). It is not currently installed." if verbose
    ensure_named_remote_exists!(flatpak, remote, url, verbose:)
    actual_remote = remote
  elsif remote.start_with?("http://", "https://")
    if remote.end_with?(".flatpakref")
      # .flatpakref files - install directly (Flatpak handles single-app remote natively)
      puts "Installing #{name} Flatpak from #{remote}. It is not currently installed." if verbose
      return install_flatpakref!(flatpak, name, remote, verbose:)
    else
      # Tier 2: URL only - create single-app remote
      actual_remote = generate_single_app_remote_name(name)
      if verbose
        puts "Installing #{name} Flatpak from #{actual_remote} (#{remote}). It is not currently installed."
      end
      ensure_single_app_remote_exists!(flatpak, actual_remote, remote, verbose:)
    end
  else
    # Tier 1: Named remote (default: flathub)
    puts "Installing #{name} Flatpak from #{remote}. It is not currently installed." if verbose
    actual_remote = remote
  end

  # Install from the remote
  return false unless Bundle.system(flatpak, "install", "-y", "--system", actual_remote, name, verbose:)

  package = { name:, remote: actual_remote, remote_url: url }
  packages_with_remotes = T.let(@packages_with_remotes || [], T::Array[Package])
  packages_with_remotes << package
  @packages_with_remotes = packages_with_remotes
  @installed_packages = packages_with_remotes.dup
  @packages = packages_with_remotes.map { |pkg| pkg[:name] }
  true
end

.install_flatpakref!(flatpak, name, url, verbose:) ⇒ 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.

Install from a .flatpakref file (Tier 2 variant - Flatpak handles single-app remote natively)

Parameters:

Returns:

  • (Boolean) 


263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'bundle/extensions/flatpak.rb', line 263

def install_flatpakref!(flatpak, name, url, verbose:)
  return false unless Bundle.system(flatpak, "install", "-y", "--system", url, verbose:)

  # Get the actual remote name used by Flatpak
  output = `#{flatpak} list --app --columns=application,origin 2>/dev/null`.chomp
  installed = output.split("\n").find { |line| line.start_with?(name) }
  actual_remote = installed ? installed.split("\t")[1] : "#{name}-origin"
  actual_remote ||= "#{name}-origin"
  package = { name:, remote: actual_remote, remote_url: nil }
  packages_with_remotes = T.let(@packages_with_remotes || [], T::Array[Package])
  packages_with_remotes << package
  @packages_with_remotes = packages_with_remotes
  @installed_packages = packages_with_remotes.dup
  @packages = packages_with_remotes.map { |pkg| pkg[:name] }
  true
end

.installed_packages ⇒ Array<Package>

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:



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

def installed_packages
  installed_packages = @installed_packages
  return installed_packages if installed_packages

  @installed_packages = packages_with_remotes.dup
end

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



27
28
29
30
31
 
# File 'bundle/extensions/flatpak.rb', line 27

def legacy_cleanup_method
  # TODO: Remove this legacy cleanup hook once the direct cleanup specs
  # stop stubbing the old command-level flatpak helper.
  :flatpaks_to_uninstall
end

.package_installed?(name, with: nil, remote: nil) ⇒ 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) 


355
356
357
358
359
360
361
362
363
 
# File 'bundle/extensions/flatpak.rb', line 355

def package_installed?(name, with: nil, remote: nil)
  _ = with

  if remote
    installed_packages.any? { |pkg| pkg[:name] == name && pkg[:remote] == remote }
  else
    installed_packages.any? { |pkg| pkg[:name] == name }
  end
end

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



122
123
124
125
126
127
 
# File 'bundle/extensions/flatpak.rb', line 122

def packages
  packages = @packages
  return packages if packages

  @packages = packages_with_remotes.map { |pkg| pkg[:name] }
end

.packages_with_remotes ⇒ Array<Package>

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:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'bundle/extensions/flatpak.rb', line 91

def packages_with_remotes
  packages_with_remotes = @packages_with_remotes
  return packages_with_remotes if packages_with_remotes

  @packages_with_remotes = if Bundle.flatpak_installed?
    flatpak = Bundle.which_flatpak
    return [] if flatpak.nil?

    # List applications with their origin remote
    # Using --app to filter applications only
    # Using --columns=application,origin to get app IDs and their remotes
    output = `#{flatpak} list --app --columns=application,origin 2>/dev/null`.chomp

    packages = output.split("\n").filter_map do |line|
      parts = line.strip.split("\t")
      name = parts[0]
      next if parts.empty? || name.nil? || name.empty?

      remote = parts[1] || "flathub"
      package = T.let({ name:, remote:, remote_url: T.let(nil, T.nilable(String)) }, Package)
      remote_url = remote_urls[remote]
      package[:remote_url] = remote_url
      package
    end
    packages.sort_by { |pkg| pkg[:name].to_s }
  else
    []
  end
end

.preinstall!(name, with: nil, no_upgrade: false, verbose: false, remote: "flathub", url: nil, **_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)
  • with (Array<String>, nil) (defaults to: nil)
  • no_upgrade (Boolean) (defaults to: false)
  • verbose (Boolean) (defaults to: false)
  • remote (String) (defaults to: "flathub")
  • url (String, nil) (defaults to: nil)
  • _options (T.anything)

Returns:

  • (Boolean) 


180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'bundle/extensions/flatpak.rb', line 180

def preinstall!(name, with: nil, no_upgrade: false, verbose: false, remote: "flathub", url: nil, **_options)
  _ = with
  _ = no_upgrade
  _ = url

  return false unless Bundle.flatpak_installed?

  # Check if package is installed at all (regardless of remote)
  if package_installed?(name)
    puts "Skipping install of #{name} Flatpak. It is already installed." if verbose
    return false
  end

  true
end

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

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'bundle/extensions/flatpak.rb', line 66

def remote_urls
  remote_urls = @remote_urls
  return remote_urls if remote_urls

  @remote_urls = if Bundle.flatpak_installed?
    flatpak = Bundle.which_flatpak
    return {} if flatpak.nil?

    output = `#{flatpak} remote-list --system --columns=name,url 2>/dev/null`.chomp
    urls = {}
    output.split("\n").each do |line|
      parts = line.strip.split("\t")
      next if parts.size < 2

      name = parts[0]
      url = parts[1]
      urls[name] = url if name && url
    end
    urls
  else
    {}
  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.



58
59
60
61
62
63
 
# File 'bundle/extensions/flatpak.rb', line 58

def reset!
  @packages = T.let(nil, T.nilable(T::Array[String]))
  @packages_with_remotes = T.let(nil, T.nilable(T::Array[Package]))
  @remote_urls = T.let(nil, T.nilable(T::Hash[String, String]))
  @installed_packages = T.let(nil, T.nilable(T::Array[Package]))
end

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

Returns:



17
18
19
 
# File 'bundle/extensions/flatpak.rb', line 17

def switch_description
  "#{super} Note: Linux only."
end

Instance Method Details

#failure_reason(package, no_upgrade:) ⇒ 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:

  • package (Object)
  • no_upgrade (Boolean)

Returns:



397
398
399
400
401
402
403
404
405
406
 
# File 'bundle/extensions/flatpak.rb', line 397

def failure_reason(package, no_upgrade:)
  _ = no_upgrade

  name = if package.is_a?(Hash)
    package[:name]
  else
    package
  end
  "#{self.class.check_label} #{name} needs to be installed."
end

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



389
390
391
392
393
394
 
# File 'bundle/extensions/flatpak.rb', line 389

def format_checkable(entries)
  checkable_entries(entries).map do |entry|
    entry = T.cast(entry, Dsl::Entry)
    { name: entry.name, options: entry.options || {} }
  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) 


409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'bundle/extensions/flatpak.rb', line 409

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

  return self.class.package_installed?(T.cast(package, String)) unless package.is_a?(Hash)

  flatpak = package
  name = T.cast(flatpak[:name], String)
  options = T.cast(flatpak[:options], T::Hash[Symbol, String])
  remote = options.fetch(:remote, "flathub")
  url = options[:url]

  # 3-tier remote handling:
  # - Tier 1: Named remote → check with that remote name
  # - Tier 2: URL only → resolve to single-app remote name (<app-id>-origin)
  # - Tier 3: URL + name → check with the named remote
  actual_remote = if url.blank? && remote.start_with?("http://", "https://")
    # Tier 2: URL only - resolve to single-app remote name
    # (.flatpakref - check by name only since remote name varies)
    return self.class.package_installed?(name) if remote.end_with?(".flatpakref")

    self.class.generate_single_app_remote_name(name)
  else
    # Tier 1 (named remote) and Tier 3 (named remote with URL) both use the remote name
    remote
  end

  self.class.package_installed?(name, remote: actual_remote)
end