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!, cleanup_heading, cleanup_items, cleanup_supported?, dump, dump_disable_description, dump_disable_env, dump_disable_predicate_method, 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) 


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

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) 


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

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) 


118
119
120
121
122
123
 
# File 'bundle/extensions/mac_app_store.rb', line 118

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) 


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

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:



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

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:



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

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

.dump_disable_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) 


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

def dump_disable_supported?
  false
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:



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

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:



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

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) 


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

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
  return false unless Bundle.system(mas, "get", id.to_s, verbose:)

  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:



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

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:



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

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:



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

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:



126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'bundle/extensions/mac_app_store.rb', line 126

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:



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

def packages
  packages = @packages
  return packages if packages

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


150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'bundle/extensions/mac_app_store.rb', line 150

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.



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

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:



221
222
223
224
225
226
227
 
# File 'bundle/extensions/mac_app_store.rb', line 221

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:



237
238
239
240
 
# File 'bundle/extensions/mac_app_store.rb', line 237

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:



213
214
215
216
217
218
 
# File 'bundle/extensions/mac_app_store.rb', line 213

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:



230
231
232
233
234
 
# File 'bundle/extensions/mac_app_store.rb', line 230

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) 


243
244
245
 
# File 'bundle/extensions/mac_app_store.rb', line 243

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