Class: Homebrew::Livecheck::Strategy::Sparkle Private
- 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.freeze
Class Method Summary collapse
-
.find_versions(url:, regex: nil, **_unused, &block) ⇒ Hash{Symbol => T.untyped}
private
Checks the content at the URL for new versions.
-
.items_from_content(content) ⇒ Array<Item>
private
Identifies version information from a Sparkle appcast.
-
.match?(url) ⇒ Boolean
private
Whether the strategy can be applied to the provided URL.
-
.versions_from_content(content, regex = nil, &block) ⇒ Array<String>
private
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.
Class Method Details
.find_versions(url:, regex: nil, **_unused, &block) ⇒ Hash{Symbol => T.untyped}
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.
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'livecheck/strategy/sparkle.rb', line 183 def self.find_versions(url:, regex: nil, **_unused, &block) if regex.present? && block.blank? raise ArgumentError, "#{Utils.demodulize(T.must(name))} only supports a regex when using a `strategy` block" end match_data = { matches: {}, regex: regex, url: url } match_data.merge!(Strategy.page_content(url)) 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.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 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 |
# File 'livecheck/strategy/sparkle.rb', line 64 def self.items_from_content(content) 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").map do |item| enclosure = item.elements["enclosure"] if enclosure url = enclosure["url"] short_version = enclosure["shortVersionString"] version = enclosure["version"] os = enclosure["os"] end channel = item.elements["channel"]&.text url ||= item.elements["link"]&.text short_version ||= item.elements["shortVersionString"]&.text&.strip version ||= item.elements["version"]&.text&.strip title = item.elements["title"]&.text&.strip pub_date = item.elements["pubDate"]&.text&.strip&.presence&.then do |date_string| Time.parse(date_string) rescue ArgumentError # Omit unparseable 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 next if os && !((os == "osx") || (os == "macos")) if (minimum_system_version = item.elements["minimumSystemVersion"]&.text&.gsub(/\A\D+|\D+\z/, "")) macos_minimum_system_version = begin MacOSVersion.new(minimum_system_version).strip_patch rescue MacOSVersion::Error nil end next if macos_minimum_system_version&.prerelease? end data = { title: title, channel: channel, pub_date: pub_date, url: url, bundle_version: bundle_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.compact 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.
29 30 31 |
# File 'livecheck/strategy/sparkle.rb', line 29 def self.match?(url) URL_MATCH_REGEX.match?(url) 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.
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'livecheck/strategy/sparkle.rb', line 148 def self.versions_from_content(content, regex = nil, &block) items = items_from_content(content).sort_by { |item| [item.pub_date, item.bundle_version] }.reverse 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 |