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

Inherits:
Object
  • Object
show all
Extended by:
Homebrew::Livecheck::Strategic
Defined in:
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 =

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

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

/^#{PACKAGE_NAME_REGEX.source.strip}/i
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.

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

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:



87
88
89
90
91
92
93
94
95
96
 
# File 'livecheck/strategy/hackage.rb', line 87

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:



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

def self.generate_input_values(url)
  values = {}

  match = File.basename(url).match(FILENAME_REGEX)
  return values if match.blank?

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

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

  # Example regex: `%r{<h3>example-(.*?)/?</h3>}i`
  values[:regex] = %r{<h3>#{regex_name}-(.*?)/?</h3>}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) 


43
44
45
 
# File 'livecheck/strategy/hackage.rb', line 43

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