Class: Homebrew::Livecheck::Strategy::Npm

Inherits:
Object
  • Object
show all
Defined in:
livecheck/strategy/npm.rb

Overview

The Npm strategy identifies versions of software at registry.npmjs.org by checking the listed versions for a package.

npm URLs take one of the following formats:

  • https://registry.npmjs.org/example/-/example-1.2.3.tgz
  • https://registry.npmjs.org/@example/example/-/example-1.2.3.tgz

The default regex matches URLs in the href attributes of version tags on the "Versions" tab of the package page.

Constant Summary collapse

NICE_NAME = 
"npm"
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?://registry\.npmjs\.org
  /(?<package_name>.+?)/-/ # The npm package name
}ix

Class Method Summary collapse

Class Method Details

.find_versions(url:, regex: nil, **unused, &block) ⇒ 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.

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

  • unused (T.untyped)
  • block (Proc, nil)

Returns:



77
78
79
80
81
 
# File 'livecheck/strategy/npm.rb', line 77

def self.find_versions(url:, regex: nil, **unused, &block)
  generated = generate_input_values(url)

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'livecheck/strategy/npm.rb', line 45

def self.generate_input_values(url)
  values = {}

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

  values[:url] = "https://www.npmjs.com/package/#{match[:package_name]}?activeTab=versions"

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

  # Example regexes:
  # * `%r{href=.*?/package/example/v/(\d+(?:\.\d+)+)"}i`
  # * `%r{href=.*?/package/@example/example/v/(\d+(?:\.\d+)+)"}i`
  values[:regex] = %r{href=.*?/package/#{regex_name}/v/(\d+(?:\.\d+)+)"}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) 


33
34
35
 
# File 'livecheck/strategy/npm.rb', line 33

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