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

Inherits:
Object
  • Object
show all
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

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.

Parameters:

  • url (String)

    the URL of the content to check

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

    a regex for use in a strategy block

  • _unused (Hash{Symbol => T.untyped}, nil)
  • block (T.untyped)

Returns:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'livecheck/strategy/sparkle.rb', line 204

def self.find_versions(url:, regex: nil, **_unused, &block)
  if regex.present? && block.blank?
    raise ArgumentError, "#{T.must(name).demodulize} 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)

  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:



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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'livecheck/strategy/sparkle.rb', line 68

def self.items_from_content(content)
  require "rexml/document"

  parsing_tries = 0
  xml = begin
    REXML::Document.new(content)
  rescue REXML::UndefinedNamespaceException => e
    undefined_prefix = e.to_s[/Undefined prefix ([^ ]+) found/i, 1]
    raise if undefined_prefix.blank?

    # Only retry parsing once after removing prefix from content
    parsing_tries += 1
    raise if parsing_tries > 1

    # When an XML document contains a prefix without a corresponding
    # namespace, it's necessary to remove the prefix from the content
    # to be able to successfully parse it using REXML
    content = content.gsub(%r{(</?| )#{Regexp.escape(undefined_prefix)}:}, '\1')
    retry
  end

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

    if (minimum_system_version = item.elements["minimumSystemVersion"]&.text&.gsub(/\A\D+|\D+\z/, ""))
      macos_minimum_system_version = begin
        OS::Mac::Version.new(minimum_system_version).strip_patch
      rescue MacOSVersionError
        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.

Parameters:

  • url (String)

    the URL to match against

Returns:

  • (Boolean)


31
32
33
# File 'livecheck/strategy/sparkle.rb', line 31

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.

Parameters:

  • content (String)

    the content to check

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

    a regex for use in a strategy block

  • block (T.untyped)

Returns:



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'livecheck/strategy/sparkle.rb', line 169

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]
      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