Class: Homebrew::Livecheck::Strategy::Gnome

Inherits:
Object
  • Object
show all
Defined in:
livecheck/strategy/gnome.rb

Overview

The Gnome strategy identifies versions of software at gnome.org by checking the available downloads found in a project's cache.json file.

GNOME URLs generally follow a standard format:

  • https://download.gnome.org/sources/example/1.2/example-1.2.3.tar.xz

Before version 40, GNOME used a version scheme where unstable releases were indicated with a minor that's 90+ or odd. The newer version scheme uses trailing alpha/beta/rc text to identify unstable versions (e.g. 40.alpha).

When a regex isn't provided in a livecheck block, the strategy uses a default regex that matches versions which don't include trailing text after the numeric version (e.g. 40.0 instead of 40.alpha) and it selectively filters out unstable versions below 40 using the rules for the older version scheme.

Constant Summary collapse

NICE_NAME = 
"GNOME"
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?://download\.gnome\.org
  /sources
  /(?<package_name>[^/]+)/ # The GNOME package name
}ix

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.

Generates a URL and regex (if one isn't provided) and passes them to PageMatch.find_versions to identify versions in the content.

Parameters:

  • url (String) —

    the URL of the content to check

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

    a regex used for matching versions in content

  • unused (T.untyped)
  • block (Proc, nil)

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'livecheck/strategy/gnome.rb', line 86

def self.find_versions(url:, regex: nil, **unused, &block)
  generated = generate_input_values(url)

  version_data = PageMatch.find_versions(
    url:   generated[:url],
    regex: regex || generated[:regex],
    **unused,
    &block
  )

  if regex.blank?
    # Filter out unstable versions using the old version scheme where
    # the major version is below 40.
    version_data[:matches].reject! do |_, version|
      next if version.major >= 40
      next if version.minor.blank?

      (version.minor.to_i.odd? || version.minor >= 90) ||
        (version.patch.present? && version.patch >= 90)
    end
  end

  version_data
end

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

Extracts information from a provided URL and uses it to generate various input values used by the strategy to check for new versions. Some of these values act as defaults and can be overridden in a livecheck block.

Parameters:

  • url (String) —

    the URL used to generate values

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'livecheck/strategy/gnome.rb', line 54

def self.generate_input_values(url)
  values = {}

  match = url.match(URL_MATCH_REGEX)
  return values if match.blank?

  values[:url] = "https://download.gnome.org/sources/#{match[:package_name]}/cache.json"

  regex_name = Regexp.escape(T.must(match[:package_name])).gsub("\\-", "-")

  # GNOME archive files seem to use a standard filename format, so we
  # count on the delimiter between the package name and numeric
  # version being a hyphen and the file being a tarball.
  values[:regex] = /#{regex_name}-(\d+(?:\.\d+)*)\.t/i

  values
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) 


42
43
44
 
# File 'livecheck/strategy/gnome.rb', line 42

def self.match?(url)
  URL_MATCH_REGEX.match?(url)
end