Class: Homebrew::Livecheck::Strategy::Hackage

Inherits:
Object
  • Object
show all
Defined in:
brew/Library/Homebrew/livecheck/strategy/hackage.rb

Overview

The Hackage strategy identifies versions of software at hackage.haskell.org by checking directory listing pages.

Hackage URLs take one of the following formats:

  • https://hackage.haskell.org/package/example-1.2.3/example-1.2.3.tar.gz
  • https://downloads.haskell.org/~ghc/8.10.1/ghc-8.10.1-src.tar.xz

The default regex checks for the latest version in an h3 heading element with a format like <h3>example-1.2.3/</h3>.

Constant Summary collapse

PACKAGE_NAME_REGEX =

A Regexp used in determining if the strategy applies to the URL and also as part of extracting the package name from the URL basename.

/(?<package_name>.+?)-\d+/i.freeze
FILENAME_REGEX =

A Regexp used to extract the package name from the URL basename.

/^#{PACKAGE_NAME_REGEX.source.strip}/i.freeze
URL_MATCH_REGEX =

A Regexp used in determining if the strategy applies to the URL.

%r{
  ^https?://(?:downloads|hackage)\.haskell\.org
  (?:/[^/]+)+ # Path before the filename
  #{PACKAGE_NAME_REGEX.source.strip}
}ix.freeze

Class Method Summary collapse

Class Method Details

.find_versions(url, regex = nil, &block) ⇒ Hash

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) (defaults to: nil)

    a regex used for matching versions in content

Returns:

  • (Hash)


48
49
50
51
52
53
54
55
56
57
58
# File 'brew/Library/Homebrew/livecheck/strategy/hackage.rb', line 48

def self.find_versions(url, regex = nil, &block)
  match = File.basename(url).match(FILENAME_REGEX)

  # A page containing a directory listing of the latest source tarball
  page_url = "https://hackage.haskell.org/package/#{match[:package_name]}/src/"

  # Example regex: `%r{<h3>example-(.*?)/?</h3>}i`
  regex ||= %r{<h3>#{Regexp.escape(match[:package_name])}-(.*?)/?</h3>}i

  PageMatch.find_versions(page_url, regex, &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)


38
39
40
# File 'brew/Library/Homebrew/livecheck/strategy/hackage.rb', line 38

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