Class: Homebrew::Bundle::MacAppStore Private

Inherits:
Extension show all
Defined in:
bundle/extensions/mac_app_store.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.

Defined Under Namespace

Classes: App, self

Constant Summary collapse

CheckablePackages =

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 { T.any(T::Array[Object], T::Hash[Integer, 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. 

:mas
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. 

"App"
"Mac App Store dependencies"

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Extension

banner_name, check, check_label, 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_name, dump_output, dump_supported?, dump_with, fetchable_name, flag, inherited, install_package!, install_supported?, install_verb, package_description, package_installed?, package_manager_env, package_manager_executable, package_manager_executable!, package_manager_installed?, package_manager_name, package_record, predicate_method, quote, remove_supported?, switch_description, type, uninstall_package!, with_package_manager_env

Methods inherited from PackageType

check, #checkable_entries, dump, dump_output, dump_supported?, fetchable_name, #find_actionable, inherited, install_supported?, install_verb, type

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) 


27
28
29
 
# File 'bundle/extensions/mac_app_store.rb', line 27

def add_supported?
  false
end

.app_id_installed?(id) ⇒ 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) 


144
145
146
 
# File 'bundle/extensions/mac_app_store.rb', line 144

def app_id_installed?(id)
  installed_app_ids.any? { |app_id| app_id.to_i == id }
end

.app_id_installed_and_up_to_date?(id, 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:

  • id (Integer)
  • no_upgrade (Boolean) (defaults to: false)

Returns:

  • (Boolean) 


154
155
156
157
158
159
 
# File 'bundle/extensions/mac_app_store.rb', line 154

def app_id_installed_and_up_to_date?(id, no_upgrade: false)
  return false unless app_id_installed?(id)
  return true if no_upgrade

  !app_id_upgradable?(id)
end

.app_id_upgradable?(id) ⇒ 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) 


149
150
151
 
# File 'bundle/extensions/mac_app_store.rb', line 149

def app_id_upgradable?(id)
  outdated_app_ids.any? { |app_id| app_id.to_i == id }
end

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



77
78
79
 
# File 'bundle/extensions/mac_app_store.rb', line 77

def app_ids
  apps.map(&:first)
end

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'bundle/extensions/mac_app_store.rb', line 53

def apps
  apps = @apps
  return apps if apps

  @apps = if (mas = package_manager_executable)
    `#{mas} list 2>/dev/null`.split("\n").filter_map do |app|
      app_details = app.match(/\A\s*(?<id>\d+)\s+(?<name>.*?)\s+\((?<version>[\d.]*)\)\Z/)
      next if app_details.nil?

      id = app_details[:id]
      name = app_details[:name]
      next if id.nil? || name.nil?

      # Only add the application details should we have a valid match.
      # Strip unprintable characters
      [id, name.gsub(/[[:cntrl:]]|\p{C}/, "")]
    end
  end
  return [] if @apps.nil?

  @apps
end

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



133
134
135
136
137
138
139
140
141
 
# File 'bundle/extensions/mac_app_store.rb', line 133

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

  items.each do |item|
    Bundle.system(mas, "uninstall", parse_cleanup_item(item).id, verbose: false)
  end
  puts "Uninstalled #{items.size} Mac App Store app#{"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:



32
33
34
 
# File 'bundle/extensions/mac_app_store.rb', line 32

def cleanup_heading
  "Mac App Store apps"
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:



109
110
111
 
# File 'bundle/extensions/mac_app_store.rb', line 109

def cleanup_item(app)
  JSON.generate("id" => app.id, "name" => app.name)
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:



114
115
116
117
 
# File 'bundle/extensions/mac_app_store.rb', line 114

def cleanup_item_name(item)
  app = parse_cleanup_item(item)
  "#{app.name} (#{app.id})"
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:



120
121
122
123
124
125
126
127
128
129
130
 
# File 'bundle/extensions/mac_app_store.rb', line 120

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

  kept_app_ids = entries.filter_map do |entry|
    entry.options[:id].to_s if entry.type == type
  end
  return [].freeze if kept_app_ids.empty?

  packages.reject { |app| app.id.to_i.zero? || kept_app_ids.any? { |id| app.id.to_i == id.to_i } }
          .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:



103
104
105
106
 
# File 'bundle/extensions/mac_app_store.rb', line 103

def dump_entry(package)
  app = T.cast(package, App)
  "mas #{quote(app.name)}, id: #{app.id}"
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:



37
38
39
40
41
42
 
# File 'bundle/extensions/mac_app_store.rb', line 37

def entry(name, options = {})
  id = options[:id]
  raise "options[:id](#{id}) should be an Integer object" unless id.is_a? Integer

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

.install!(name, id = nil, with: nil, preinstall: true, no_upgrade: false, verbose: false, force: false, **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 (Integer, 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)
  • options (Homebrew::Bundle::EntryOption)

Returns:

  • (Boolean)

Raises:

  • (ArgumentError) 


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

def install!(name, id = nil, with: nil, preinstall: true, no_upgrade: false, verbose: false, force: false,
             **options)
  _ = with
  id ||= T.cast(options[:id], T.nilable(Integer))
  raise ArgumentError, "missing keyword: id" if id.nil?

  _ = no_upgrade
  _ = force

  return true unless preinstall

  mas = package_manager_executable!

  if app_id_installed?(id)
    puts "Upgrading #{name} app. It is installed but not up-to-date." if verbose
    return false unless Bundle.system(mas, "upgrade", id.to_s, verbose:)

    return true
  end

  puts "Installing #{name} app. It is not currently installed." if verbose
  installed = Bundle.system(mas, "install", id.to_s, verbose:) ||
              Bundle.system(mas, "get", id.to_s, verbose:)
  return false unless installed

  apps << [id.to_s, name] unless apps.any? { |app_id, _app_name| app_id.to_i == id }
  packages << App.new(id: id.to_s, name:) unless packages.any? { |app| app.id.to_i == id }
  installed_app_ids << id.to_s unless installed_app_ids.include?(id.to_s)
  true
end

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



95
96
97
98
99
100
 
# File 'bundle/extensions/mac_app_store.rb', line 95

def installed_app_ids
  installed_app_ids = @installed_app_ids
  return installed_app_ids if installed_app_ids

  @installed_app_ids = app_ids
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:



90
91
92
 
# File 'bundle/extensions/mac_app_store.rb', line 90

def installed_packages
  packages
end

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



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

def legacy_check_step
  :apps_to_install
end

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



162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'bundle/extensions/mac_app_store.rb', line 162

def outdated_app_ids
  outdated_app_ids = @outdated_app_ids
  return outdated_app_ids if outdated_app_ids

  @outdated_app_ids = if (mas = package_manager_executable)
    `#{mas} outdated 2>/dev/null`.split("\n").map do |app|
      app.split(" ", 2).first.to_s
    end
  end
  return [] if @outdated_app_ids.nil?

  @outdated_app_ids
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:



82
83
84
85
86
87
 
# File 'bundle/extensions/mac_app_store.rb', line 82

def packages
  packages = @packages
  return packages if packages

  @packages = apps.sort_by { |_, name| name.downcase }.map { |id, name| App.new(id:, name:) }
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) 


250
251
252
253
254
255
256
257
258
259
 
# File 'bundle/extensions/mac_app_store.rb', line 250

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

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

  App.new(id:, name:)
end

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

Raises:

  • (ArgumentError) 


186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'bundle/extensions/mac_app_store.rb', line 186

def preinstall!(name, id = nil, with: nil, no_upgrade: false, verbose: false, **options)
  _ = with
  id ||= T.cast(options[:id], T.nilable(Integer))
  raise ArgumentError, "missing keyword: id" if id.nil?

  unless package_manager_installed?
    puts "Installing mas. It is not currently installed." if verbose
    Bundle.system(HOMEBREW_BREW_FILE, "install", "mas", verbose:)
    raise "Unable to install #{name} app. mas installation failed." unless package_manager_installed?
  end

  if app_id_installed?(id) &&
     (no_upgrade || !app_id_upgradable?(id))
    puts "Skipping install of #{name} app. It is already installed." if verbose
    return false
  end

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



45
46
47
48
49
50
 
# File 'bundle/extensions/mac_app_store.rb', line 45

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

Instance Method Details

#exit_early_check(packages, no_upgrade:) ⇒ 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:



271
272
273
274
275
276
277
 
# File 'bundle/extensions/mac_app_store.rb', line 271

def exit_early_check(packages, no_upgrade:)
  work_to_be_done = (packages.is_a?(Hash) ? packages.to_a : packages).find do |id, _name|
    !installed_and_up_to_date?(id, no_upgrade:)
  end

  Array(work_to_be_done)
end

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



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

def failure_reason(package, no_upgrade:)
  reason = no_upgrade ? "needs to be installed." : "needs to be installed or updated."
  "#{self.class.check_label} #{package} #{reason}"
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:



263
264
265
266
267
268
 
# File 'bundle/extensions/mac_app_store.rb', line 263

def format_checkable(entries)
  checkable_entries(entries).map do |entry|
    entry = T.cast(entry, Dsl::Entry)
    [T.cast(entry.options.fetch(:id), Integer), entry.name]
  end
end

#full_check(packages, no_upgrade:) ⇒ 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:



280
281
282
283
284
 
# File 'bundle/extensions/mac_app_store.rb', line 280

def full_check(packages, no_upgrade:)
  (packages.is_a?(Hash) ? packages.to_a : packages)
    .reject { |id, _name| installed_and_up_to_date?(id, no_upgrade:) }
    .map { |_id, name| failure_reason(name, no_upgrade:) }
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) 


293
294
295
 
# File 'bundle/extensions/mac_app_store.rb', line 293

def installed_and_up_to_date?(package, no_upgrade: false)
  self.class.app_id_installed_and_up_to_date?(T.cast(package, Integer), no_upgrade:)
end