Class: Homebrew::Livecheck::Strategy::Npm
- 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
-
.find_versions(url:, regex: nil, **unused, &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.
-
.generate_input_values(url) ⇒ Hash{Symbol => T.untyped}
Extracts information from a provided URL and uses it to generate various input values used by the strategy to check for new versions.
-
.match?(url) ⇒ Boolean
Whether the strategy can be applied to the provided URL.
Class Method Details
.find_versions(url:, regex: nil, **unused, &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.
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}
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.
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
Whether the strategy can be applied to the provided URL.
33 34 35 |
# File 'livecheck/strategy/npm.rb', line 33 def self.match?(url) URL_MATCH_REGEX.match?(url) end |