Class: Homebrew::Livecheck::Strategy::Apache

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
livecheck/strategy/apache.rb

Overview

The Apache strategy identifies versions of software at apache.org by checking directory listing pages.

Apache URLs start with https://www.apache.org/dyn/closer.lua?path=. The path parameter takes one of the following formats:

  • example/1.2.3/example-1.2.3.tar.gz
  • example/example-1.2.3/example-1.2.3.tar.gz
  • example/example-1.2.3-bin.tar.gz

When the path contains a version directory (e.g. /1.2.3/, /example-1.2.3/, etc.), the default regex matches numeric versions in directory names. Otherwise, the default regex matches numeric versions in filenames.

Constant Summary collapse

URL_MATCH_REGEX =

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

%r{
  ^https?://www\.apache\.org
  /dyn/.+path=
  (?<path>.+?)/      # Path to directory of files or version directories
  (?<prefix>[^/]*?)  # Any text in filename or directory before version
  v?\d+(?:\.\d+)+    # The numeric version
  (?<suffix>/|[^/]*) # Any text in filename or directory after version
}ix.freeze

Class Method Summary collapse

Class Method Details

.find_versions(url, regex, cask: nil, &block) ⇒ Hash{Symbol => T.untyped}

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)

    a regex used for matching versions in content

  • cask (Cask::Cask, nil) (defaults to: nil)
  • block (T.proc.params(arg0: String).returns(T.any(T::Array[String], String)), nil)

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'livecheck/strategy/apache.rb', line 58

def self.find_versions(url, regex, cask: nil, &block)
  match = url.match(URL_MATCH_REGEX)

  # Use `\.t` instead of specific tarball extensions (e.g. .tar.gz)
  suffix = match[:suffix].sub(/\.t(?:ar\..+|[a-z0-9]+)$/i, "\.t")

  # Example URL: `https://archive.apache.org/dist/example/`
  page_url = "https://archive.apache.org/dist/#{match[:path]}/"

  # Example directory regex: `%r{href=["']?v?(\d+(?:\.\d+)+)/}i`
  # Example file regexes:
  # * `/href=["']?example-v?(\d+(?:\.\d+)+)\.t/i`
  # * `/href=["']?example-v?(\d+(?:\.\d+)+)-bin\.zip/i`
  regex ||= /href=["']?#{Regexp.escape(match[:prefix])}v?(\d+(?:\.\d+)+)#{Regexp.escape(suffix)}/i

  PageMatch.find_versions(page_url, regex, cask: cask, &block)
end

.match?(url) ⇒ Boolean

Whether the strategy can be applied to the provided URL.

Parameters:

  • url (String)

    the URL to match against

Returns:

  • (Boolean)


40
41
42
# File 'livecheck/strategy/apache.rb', line 40

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