Class: Homebrew::Livecheck::Strategy::Gnu

Inherits:
Object
  • Object
show all
Extended by:
Homebrew::Livecheck::Strategic
Defined in:
livecheck/strategy/gnu.rb

Overview

The Gnu strategy identifies versions of software at gnu.org by checking directory listing pages.

GNU URLs use a variety of formats:

  • Archive file URLs:
    • https://ftp.gnu.org/gnu/example/example-1.2.3.tar.gz
    • https://ftp.gnu.org/gnu/example/1.2.3/example-1.2.3.tar.gz
  • Homepage URLs:
    • https://www.gnu.org/software/example/
    • https://example.gnu.org

There are other URL formats that this strategy currently doesn't support:

  • https://ftp.gnu.org/non-gnu/example/source/feature/1.2.3/example-1.2.3.tar.gz
  • https://savannah.nongnu.org/download/example/example-1.2.3.tar.gz
  • https://download.savannah.gnu.org/releases/example/example-1.2.3.tar.gz
  • https://download.savannah.nongnu.org/releases/example/example-1.2.3.tar.gz

The default regex identifies versions in archive files found in href attributes.

Constant Summary collapse

NICE_NAME = 
"GNU"
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.

T.let(%r{
  ^https?://
  (?:(?:[^/]+?\.)*gnu\.org/(?:gnu|software)/(?<project_name>[^/]+)/
  |(?<project_name>[^/]+)\.gnu\.org/?$)
}ix, Regexp)

Class Method Summary collapse

Methods included from Homebrew::Livecheck::Strategic

find_versions, match?

Class Method Details

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

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

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

    options to modify behavior

  • block (Proc, nil)

Returns:



101
102
103
104
105
106
107
108
109
110
 
# File 'livecheck/strategy/gnu.rb', line 101

def self.find_versions(url:, regex: nil, options: Options.new, &block)
  generated = generate_input_values(url)

  PageMatch.find_versions(
    url:     generated[:url],
    regex:   regex || generated[:regex],
    options:,
    &block
  )
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:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'livecheck/strategy/gnu.rb', line 62

def self.generate_input_values(url)
  values = {}

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

  # The directory listing page for the project's files
  values[:url] = "https://ftp.gnu.org/gnu/#{match[:project_name]}/"

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

  # The default regex consists of the following parts:
  # * `href=.*?`: restricts matching to URLs in `href` attributes
  # * The project name
  # * `[._-]`: the generic delimiter between project name and version
  # * `v?(\d+(?:\.\d+)*)`: the numeric version
  # * `(?:\.[a-z]+|/)`: the file extension (a trailing delimiter)
  #
  # Example regex: `%r{href=.*?example[._-]v?(\d+(?:\.\d+)*)(?:\.[a-z]+|/)}i`
  values[:regex] = %r{href=.*?#{regex_name}[._-]v?(\d+(?:\.\d+)*)(?:\.[a-z]+|/)}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) 


50
51
52
 
# File 'livecheck/strategy/gnu.rb', line 50

def self.match?(url)
  URL_MATCH_REGEX.match?(url) && url.exclude?("savannah.")
end