Class: Homebrew::Livecheck::Strategy::Cpan

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

Overview

The Cpan strategy identifies versions of software at cpan.metacpan.org by checking directory listing pages.

CPAN URLs take the following formats:

  • https://cpan.metacpan.org/authors/id/H/HO/HOMEBREW/Brew-v1.2.3.tar.gz
  • https://cpan.metacpan.org/authors/id/H/HO/HOMEBREW/brew/brew-v1.2.3.tar.gz

In these examples, HOMEBREW is the author name and the preceding H and HO directories correspond to the first letter(s). Some authors also store files in subdirectories, as in the second example above.

Constant Summary collapse

NICE_NAME = 
"CPAN"
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?://cpan\.metacpan\.org
  (?<path>/authors/id(?:/[^/]+){3,}/) # Path before the filename
  (?<prefix>[^/]+) # Filename text before the version
  -v?\d+(?:\.\d+)* # The numeric version
  (?<suffix>[^/]+) # Filename text after the version
}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/cpan.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:



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

def self.generate_input_values(url)
  values = {}

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

  # The directory listing page where the archive files are found
  values[:url] = "https://cpan.metacpan.org#{match[:path]}"

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

  # Use `\.t` instead of specific tarball extensions (e.g. .tar.gz)
  suffix = T.must(match[:suffix]).sub(Strategy::TARBALL_EXTENSION_REGEX, ".t")
  regex_suffix = Regexp.escape(suffix).gsub("\\-", "-")

  # Example regex: `/href=.*?Brew[._-]v?(\d+(?:\.\d+)*)\.t/i`
  values[:regex] = /href=.*?#{regex_prefix}[._-]v?(\d+(?:\.\d+)*)#{regex_suffix}/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) 


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

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