Class: Homebrew::Livecheck::Strategy::PageMatch
- Inherits:
-
Object
- Object
- Homebrew::Livecheck::Strategy::PageMatch
- Extended by:
- T::Sig
- Defined in:
- brew/Library/Homebrew/livecheck/strategy/page_match.rb
Overview
The PageMatch strategy fetches content at a URL and scans it for matching text using the provided regex.
This strategy can be used in a livecheck
block when no specific
strategies apply to a given URL. Though PageMatch will technically
match any HTTP URL, the strategy also requires a regex to function.
The PageMatch.find_versions method is also used within other strategies, to handle the process of identifying version text in content.
Constant Summary collapse
- NICE_NAME =
"Page match"
- PRIORITY =
A priority of zero causes livecheck to skip the strategy. We do this for PageMatch so we can selectively apply the strategy only when a regex is provided in a
livecheck
block. 0
- URL_MATCH_REGEX =
The
Regexp
used to determine if the strategy applies to the URL. %r{^https?://}i.freeze
Class Method Summary collapse
-
.find_versions(url, regex, provided_content = nil, &block) ⇒ Hash{Symbol => T.untyped}
Checks the content at the URL for new versions, using the provided regex for matching.
-
.match?(url) ⇒ Boolean
Whether the strategy can be applied to the provided URL.
-
.page_matches(content, regex, &block) ⇒ Array
Uses the regex to match text in the content or, if a block is provided, passes the page content to the block to handle matching.
Class Method Details
.find_versions(url, regex, provided_content = nil, &block) ⇒ Hash{Symbol => T.untyped}
Checks the content at the URL for new versions, using the provided regex for matching.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'brew/Library/Homebrew/livecheck/strategy/page_match.rb', line 88 def self.find_versions(url, regex, provided_content = nil, &block) match_data = { matches: {}, regex: regex, url: url } content = if provided_content.is_a?(String) match_data[:cached] = true provided_content else match_data.merge!(Strategy.page_content(url)) match_data[:content] end return match_data if content.blank? page_matches(content, regex, &block).each do |match_text| match_data[:matches][match_text] = Version.new(match_text) end match_data end |
.match?(url) ⇒ Boolean
Whether the strategy can be applied to the provided URL.
PageMatch will technically match any HTTP URL but is only
usable with a livecheck
block containing a regex.
38 39 40 |
# File 'brew/Library/Homebrew/livecheck/strategy/page_match.rb', line 38 def self.match?(url) URL_MATCH_REGEX.match?(url) end |
.page_matches(content, regex, &block) ⇒ Array
Uses the regex to match text in the content or, if a block is provided, passes the page content to the block to handle matching. With either approach, an array of unique matches is returned.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'brew/Library/Homebrew/livecheck/strategy/page_match.rb', line 50 def self.page_matches(content, regex, &block) if block case (value = block.call(content, regex)) when String return [value] when Array return value else raise TypeError, "Return value of `strategy :page_match` block must be a string or array of strings." end end content.scan(regex).map do |match| case match when String match else match.first end end.uniq end |