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

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

Overview

The Npm strategy identifies versions of software at registry.npmjs.org by checking the latest version 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

Constant Summary collapse

NICE_NAME = 
"npm"
DEFAULT_BLOCK =

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 default strategy block used to extract version information when a strategy block isn't provided.

T.let(proc do |json|
  json["version"]
end.freeze, T.proc.params(
  arg0: T::Hash[String, T.anything],
).returns(T.any(String, T::Array[String])))
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

Methods included from Homebrew::Livecheck::Strategic

find_versions, match?

Class Method Details

.find_versions(url:, regex: nil, provided_content: 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 checks the content at the URL for new versions using Json.versions_from_content.

Parameters:

  • url (String) —

    the URL of the content to check

  • regex (Regexp, nil) (defaults to: nil) —

    a regex for matching versions in content

  • provided_content (String, nil) (defaults to: nil) —

    content to check instead of fetching

  • options (Options) (defaults to: Options.new) —

    options to modify behavior

  • block (Proc, nil)

Returns:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'livecheck/strategy/npm.rb', line 79

def self.find_versions(url:, regex: nil, provided_content: nil, options: Options.new, &block)
  match_data = { matches: {}, regex:, url: }
  match_data[:cached] = true if provided_content.is_a?(String)

  generated = generate_input_values(url)
  return match_data if generated.blank?

  match_data[:url] = generated[:url]

  content = if provided_content
    provided_content
  else
    match_data.merge!(Strategy.page_content(match_data[:url], options:))
    match_data[:content]
  end
  return match_data unless content

  Json.versions_from_content(content, regex, &block || DEFAULT_BLOCK).each do |match_text|
    match_data[:matches][match_text] = Version.new(match_text)
  end

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

Parameters:

  • url (String) —

    the URL used to generate values

Returns:



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

def self.generate_input_values(url)
  values = {}
  return values unless (match = url.match(URL_MATCH_REGEX))

  values[:url] = "https://registry.npmjs.org/#{URI.encode_www_form_component(match[:package_name])}/latest"

  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) 


42
43
44
 
# File 'livecheck/strategy/npm.rb', line 42

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