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

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
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 =

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

%r{
  ^https?://registry\.npmjs\.org
  /(?<package_name>.+?)/-/ # The npm package name
}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:



52
53
54
55
56
57
58
59
60
61
62
63
# File 'livecheck/strategy/npm.rb', line 52

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

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

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


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

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