Class: Homebrew::Livecheck::Strategy::Sparkle Private

Inherits:
Object
  • Object
show all
Extended by:
Homebrew::Livecheck::Strategic
Defined in:
livecheck/strategy/sparkle.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.

The Sparkle strategy fetches content at a URL and parses it as a Sparkle appcast in XML format.

This strategy is not applied automatically and it's necessary to use strategy :sparkle in a livecheck block to apply it.

Defined Under Namespace

Classes: Item

Constant Summary collapse

PRIORITY =

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.

A priority of zero causes livecheck to skip the strategy. We do this for Homebrew::Livecheck::Strategy::Sparkle so we can selectively apply it when appropriate.

0
URL_MATCH_REGEX =

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.

The Regexp used to determine if the strategy applies to the URL.

%r{^https?://}i
APPCAST_MACOS_STRINGS =

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.

Common os values used in appcasts to refer to macOS.

T.let(["macos", "osx"].freeze, T::Array[String])

Class Method Summary collapse

Methods included from Homebrew::Livecheck::Strategic

find_versions, match?

Class Method Details

.filter_items(items) ⇒ Array<Item>

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.

Filters out items that aren't suitable for Homebrew.

Parameters:

Returns:

 158 159 160 161 162 163 164 165 166 167 168
 
# File 'livecheck/strategy/sparkle.rb', line 158 def self.filter_items(items) items.select do |item| # Omit items with an explicit `os` value that isn't macOS  next false if item.os && APPCAST_MACOS_STRINGS.none?(item.os) # Omit items for prerelease macOS versions  next false if item.minimum_system_version&.strip_patch&.prerelease? true end.compact end

.find_versions(url:, regex: nil, options: Options.new, &block) ⇒ Hash{Symbol => T.anything}

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.

Checks the content at the URL for new versions.

Parameters:

  • url (String) —

    the URL of the content to check

  • regex (Regexp, nil) (defaults to: nil) —

    a regex for use in a strategy block

  • options (Options) (defaults to: Options.new) —

    options to modify behavior

  • block (Proc, nil)

Returns:

 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
 
# File 'livecheck/strategy/sparkle.rb', line 230 def self.find_versions(url:, regex: nil, options: Options.new, &block) if regex.present? && !block_given? raise ArgumentError, "#{Utils.demodulize(name)} only supports a regex when using a `strategy` block" end match_data = { matches: {}, regex:, url: } match_data.merge!(Strategy.page_content(url, options:)) content = match_data.delete(:content) return match_data if content.blank? versions_from_content(content, regex, &block).each do |version_text| match_data[:matches][version_text] = Version.new(version_text) end match_data end

.items_from_content(content) ⇒ Array<Item>

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.

Identifies version information from a Sparkle appcast.

Parameters:

  • content (String) —

    the text of the Sparkle appcast

Returns:

 78 79 80 81 82 83 84 85 86 87 88 89 90 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 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
 
# File 'livecheck/strategy/sparkle.rb', line 78 def self.items_from_content(content) require "rexml/document" xml = Xml.parse_xml(content) return [] if xml.blank? # Remove prefixes, so we can reliably identify elements and attributes  xml.root&.each_recursive do |node| node.prefix = "" node.attributes.each_attribute do |attribute| attribute.prefix = "" end end xml.get_elements("//rss//channel//item").filter_map do |item| enclosure = item.elements["enclosure"] if enclosure url = enclosure["url"].presence short_version = enclosure["shortVersionString"].presence version = enclosure["version"].presence os = enclosure["os"].presence end title = Xml.element_text(item, "title") link = Xml.element_text(item, "link") url ||= link channel = Xml.element_text(item, "channel") release_notes_link = Xml.element_text(item, "releaseNotesLink") short_version ||= Xml.element_text(item, "shortVersionString") version ||= Xml.element_text(item, "version") minimum_system_version_text = Xml.element_text(item, "minimumSystemVersion")&.gsub(/\A\D+|\D+\z/, "") if minimum_system_version_text.present? minimum_system_version = begin MacOSVersion.new(minimum_system_version_text) rescue MacOSVersion::Error nil end end pub_date = Xml.element_text(item, "pubDate")&.then do |date_string| Time.parse(date_string) rescue ArgumentError # Omit unparsable strings (e.g. non-English dates)  nil end if (match = title&.match(/(\d+(?:\.\d+)*)\s*(\([^)]+\))?\Z/)) short_version ||= match[1] version ||= match[2] end bundle_version = BundleVersion.new(short_version, version) if short_version || version data = { title:, link:, channel:, release_notes_link:, pub_date:, os:, url:, bundle_version:, minimum_system_version:, }.compact next if data.empty? # Set a default `pub_date` (for sorting) if one isn't provided  data[:pub_date] ||= Time.new(0) Item.new(**data) end end

.match?(url) ⇒ 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.

Whether the strategy can be applied to the provided URL.

Parameters:

  • url (String) —

    the URL to match against

Returns:

  • (Boolean) 
 33 34 35
 
# File 'livecheck/strategy/sparkle.rb', line 33 def self.match?(url) URL_MATCH_REGEX.match?(url) end

.sort_items(items) ⇒ Array<Item>

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.

Sorts items from newest to oldest.

Parameters:

Returns:

 175 176 177 178
 
# File 'livecheck/strategy/sparkle.rb', line 175 def self.sort_items(items) items.sort_by { |item| [item.pub_date, item.bundle_version] } .reverse end

.versions_from_content(content, regex = nil, &block) ⇒ 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.

Uses #items_from_content to identify versions from the Sparkle appcast content or, if a block is provided, passes the content to the block to handle matching.

Parameters:

  • content (String) —

    the content to check

  • regex (Regexp, nil) (defaults to: nil) —

    a regex for use in a strategy block

  • block (Proc, nil)

Returns:

 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
 
# File 'livecheck/strategy/sparkle.rb', line 194 def self.versions_from_content(content, regex = nil, &block) items = sort_items(filter_items(items_from_content(content))) return [] if items.blank? item = items.first if block block_return_value = case block.parameters[0] when [:opt, :item], [:rest], [:req] regex.present? ? yield(item, regex) : yield(item) when [:opt, :items] regex.present? ? yield(items, regex) : yield(items) else raise "First argument of Sparkle `strategy` block must be `item` or `items`" end return Strategy.handle_block_return(block_return_value) end version = T.must(item).bundle_version&.nice_version version.present? ? [version] : [] end