Class: Homebrew::UnversionedCaskChecker Private
- Defined in:
- unversioned_cask_checker.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.
Check unversioned casks for updates by extracting their contents and guessing the version from contained files.
Instance Attribute Summary collapse
-
#cask ⇒ Cask::Cask
readonly
private
Instance Method Summary collapse
-
#all_versions ⇒ Hash{String => BundleVersion}
private
-
#apps ⇒ Array<Cask::Artifact::App>
private
-
#colorpickers ⇒ Array<Cask::Artifact::Colorpicker>
private
-
#dictionaries ⇒ Array<Cask::Artifact::Dictionary>
private
-
#guess_cask_version ⇒ String?
private
-
#initialize(cask) ⇒ void
constructor
private
-
#installer ⇒ Cask::Installer
private
-
#installers ⇒ Array<Cask::Artifact::Installer>
private
-
#keyboard_layouts ⇒ Array<Cask::Artifact::KeyboardLayout>
private
-
#mdimporters ⇒ Array<Cask::Artifact::Mdimporter>
private
-
#pkgs ⇒ Array<Cask::Artifact::Pkg>
private
-
#qlplugins ⇒ Array<Cask::Artifact::Qlplugin>
private
-
#screen_savers ⇒ Array<Cask::Artifact::ScreenSaver>
private
-
#single_app_cask? ⇒ Boolean
private
-
#single_pkg_cask? ⇒ Boolean
private
-
#single_qlplugin_cask? ⇒ Boolean
private
-
#top_level_info_plists(paths) ⇒ Array<Pathname>
private
Filter paths to
Info.plist
files so that ones belonging to e.g.
Constructor Details
#initialize(cask) ⇒ 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.
18 19 20 |
# File 'unversioned_cask_checker.rb', line 18 def initialize(cask) @cask = cask end |
Instance Attribute Details
#cask ⇒ Cask::Cask (readonly)
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.
15 16 17 |
# File 'unversioned_cask_checker.rb', line 15 def cask @cask end |
Instance Method Details
#all_versions ⇒ Hash{String => BundleVersion}
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.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 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 163 164 165 166 167 168 169 |
# File 'unversioned_cask_checker.rb', line 102 def all_versions versions = {} parse_info_plist = proc do |info_plist_path| plist = system_command!("plutil", args: ["-convert", "xml1", "-o", "-", info_plist_path]).plist id = plist["CFBundleIdentifier"] version = BundleVersion.from_info_plist_content(plist) versions[id] = version if id && version end Dir.mktmpdir do |dir| dir = Pathname(dir) installer.extract_primary_container(to: dir) info_plist_paths = [ *apps, *keyboard_layouts, *mdimporters, *colorpickers, *dictionaries, *qlplugins, *installers, *screen_savers, ].flat_map do |artifact| sources = if artifact.is_a?(Cask::Artifact::Installer) # Installers are sometimes contained within an `.app`, so try both. installer_path = artifact.path installer_path.ascend .select { |path| path == installer_path || path.extname == ".app" } .sort else [artifact.source.basename] end sources.flat_map do |source| top_level_info_plists(Pathname.glob(dir/"**"/source/"Contents"/"Info.plist")).sort end end info_plist_paths.each(&parse_info_plist) pkg_paths = pkgs.flat_map { |pkg| Pathname.glob(dir/"**"/pkg.path.basename).sort } pkg_paths = Pathname.glob(dir/"**"/"*.pkg").sort if pkg_paths.empty? pkg_paths.each do |pkg_path| Dir.mktmpdir do |extract_dir| extract_dir = Pathname(extract_dir) FileUtils.rmdir extract_dir system_command! "pkgutil", args: ["--expand-full", pkg_path, extract_dir] top_level_info_plist_paths = top_level_info_plists(Pathname.glob(extract_dir/"**/Contents/Info.plist")) top_level_info_plist_paths.each(&parse_info_plist) ensure Cask::Utils.(extract_dir) Pathname(extract_dir).mkpath end end nil end versions end |
#apps ⇒ Array<Cask::Artifact::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.
28 29 30 |
# File 'unversioned_cask_checker.rb', line 28 def apps @apps ||= @cask.artifacts.select { |a| a.is_a?(Cask::Artifact::App) } end |
#colorpickers ⇒ Array<Cask::Artifact::Colorpicker>
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.
53 54 55 |
# File 'unversioned_cask_checker.rb', line 53 def colorpickers @colorpickers ||= @cask.artifacts.select { |a| a.is_a?(Cask::Artifact::Colorpicker) } end |
#dictionaries ⇒ Array<Cask::Artifact::Dictionary>
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.
43 44 45 |
# File 'unversioned_cask_checker.rb', line 43 def dictionaries @dictionaries ||= @cask.artifacts.select { |a| a.is_a?(Cask::Artifact::Dictionary) } end |
#guess_cask_version ⇒ 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.
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 |
# File 'unversioned_cask_checker.rb', line 172 def guess_cask_version if apps.empty? && pkgs.empty? && qlplugins.empty? opoo "Cask #{cask} does not contain any apps, qlplugins or PKG installers." return end Dir.mktmpdir do |dir| dir = Pathname(dir) installer.then do |i| i.extract_primary_container(to: dir) rescue ErrorDuringExecution => e onoe e return nil end info_plist_paths = apps.flat_map do |app| top_level_info_plists(Pathname.glob(dir/"**"/app.source.basename/"Contents"/"Info.plist")).sort end info_plist_paths.each do |info_plist_path| if (version = BundleVersion.from_info_plist(info_plist_path)) return version.nice_version end end pkg_paths = pkgs.flat_map do |pkg| Pathname.glob(dir/"**"/pkg.path.basename).sort end pkg_paths.each do |pkg_path| packages = system_command!("installer", args: ["-plist", "-pkginfo", "-pkg", pkg_path]) .plist .map { |package| package.fetch("Package") } Dir.mktmpdir do |extract_dir| extract_dir = Pathname(extract_dir) FileUtils.rmdir extract_dir begin system_command! "pkgutil", args: ["--expand-full", pkg_path, extract_dir] rescue ErrorDuringExecution => e onoe "Failed to extract #{pkg_path.basename}: #{e}" next end top_level_info_plist_paths = top_level_info_plists(Pathname.glob(extract_dir/"**/Contents/Info.plist")) unique_info_plist_versions = top_level_info_plist_paths.map { |i| BundleVersion.from_info_plist(i)&.nice_version } .compact.uniq return unique_info_plist_versions.first if unique_info_plist_versions.count == 1 package_info_path = extract_dir/"PackageInfo" if package_info_path.exist? if (version = BundleVersion.from_package_info(package_info_path)) return version.nice_version end elsif packages.count == 1 onoe "#{pkg_path.basename} does not contain a `PackageInfo` file." end distribution_path = extract_dir/"Distribution" if distribution_path.exist? require "rexml/document" xml = REXML::Document.new(distribution_path.read) product = xml.get_elements("//installer-gui-script//product").first product_version = product["version"] if product return product_version if product_version.present? end opoo "#{pkg_path.basename} contains multiple packages: #{packages}" if packages.count != 1 $stderr.puts Pathname.glob(extract_dir/"**/*") .map { |path| regex = %r{\A(.*?\.(app|qlgenerator|saver|plugin|kext|bundle|osax))/.*\Z} path.to_s.sub(regex, '\1') }.uniq ensure Cask::Utils.(extract_dir) Pathname(extract_dir).mkpath end end nil end end |
#installer ⇒ Cask::Installer
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.
23 24 25 |
# File 'unversioned_cask_checker.rb', line 23 def installer @installer ||= Cask::Installer.new(cask, verify_download_integrity: false) end |
#installers ⇒ Array<Cask::Artifact::Installer>
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.
63 64 65 |
# File 'unversioned_cask_checker.rb', line 63 def installers @installers ||= @cask.artifacts.select { |a| a.is_a?(Cask::Artifact::Installer) } end |
#keyboard_layouts ⇒ Array<Cask::Artifact::KeyboardLayout>
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.
33 34 35 |
# File 'unversioned_cask_checker.rb', line 33 def keyboard_layouts @keyboard_layouts ||= @cask.artifacts.select { |a| a.is_a?(Cask::Artifact::KeyboardLayout) } end |
#mdimporters ⇒ Array<Cask::Artifact::Mdimporter>
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.
58 59 60 |
# File 'unversioned_cask_checker.rb', line 58 def mdimporters @mdimporters ||= @cask.artifacts.select { |a| a.is_a?(Cask::Artifact::Mdimporter) } end |
#pkgs ⇒ Array<Cask::Artifact::Pkg>
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.
68 69 70 |
# File 'unversioned_cask_checker.rb', line 68 def pkgs @pkgs ||= @cask.artifacts.select { |a| a.is_a?(Cask::Artifact::Pkg) } end |
#qlplugins ⇒ Array<Cask::Artifact::Qlplugin>
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.
38 39 40 |
# File 'unversioned_cask_checker.rb', line 38 def qlplugins @qlplugins ||= @cask.artifacts.select { |a| a.is_a?(Cask::Artifact::Qlplugin) } end |
#screen_savers ⇒ Array<Cask::Artifact::ScreenSaver>
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.
48 49 50 |
# File 'unversioned_cask_checker.rb', line 48 def screen_savers @screen_savers ||= @cask.artifacts.select { |a| a.is_a?(Cask::Artifact::ScreenSaver) } end |
#single_app_cask? ⇒ 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.
73 74 75 |
# File 'unversioned_cask_checker.rb', line 73 def single_app_cask? apps.count == 1 end |
#single_pkg_cask? ⇒ 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.
83 84 85 |
# File 'unversioned_cask_checker.rb', line 83 def single_pkg_cask? pkgs.count == 1 end |
#single_qlplugin_cask? ⇒ 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.
78 79 80 |
# File 'unversioned_cask_checker.rb', line 78 def single_qlplugin_cask? qlplugins.count == 1 end |
#top_level_info_plists(paths) ⇒ 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.
Filter paths to Info.plist
files so that ones belonging
to e.g. nested .app
s are ignored.
90 91 92 93 94 95 96 97 98 99 |
# File 'unversioned_cask_checker.rb', line 90 def top_level_info_plists(paths) # Go from `./Contents/Info.plist` to `./`. top_level_paths = paths.map { |path| path.parent.parent } paths.reject do |path| top_level_paths.any? do |_other_top_level_path| path.ascend.drop(3).any? { |parent_path| top_level_paths.include?(parent_path) } end end end |