mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
56dd89114d
Valid `strategy` block return types currently vary between strategies. Some only accept a string whereas others accept a string or array of strings. [`strategy` blocks also accept a `nil` return (to simplify early returns) but this was already standardized across strategies.] While some strategies only identify one version by default (where a string is an appropriate return type), it could be that a strategy block identifies more than one version. In this situation, the strategy would need to be modified to accept (and work with) an array from a `strategy` block. Rather than waiting for this to become a problem, this modifies all strategies to standardize on allowing `strategy` blocks to return a string or array of strings (even if only one of these is currently used in practice). Standardizing valid return types helps to further simplify the mental model for `strategy` blocks and reduce cognitive load. This commit extracts related logic from `#find_versions` into methods like `#versions_from_content`, which is conceptually similar to `PageMatch#page_matches` (renamed to `#versions_from_content` for consistency). This allows us to write tests for the related code without having to make network requests (or stub them) at this point. In general, this also helps to better align the structure of strategies and how the various `#find_versions` methods work with versions. There's still more planned work to be done here but this is a step in the right direction.
88 lines
2.8 KiB
Ruby
88 lines
2.8 KiB
Ruby
# typed: true
|
|
# frozen_string_literal: true
|
|
|
|
module Homebrew
|
|
module Livecheck
|
|
module Strategy
|
|
# The {ElectronBuilder} strategy fetches content at a URL and parses
|
|
# it as an electron-builder appcast in YAML format.
|
|
#
|
|
# @api private
|
|
class ElectronBuilder
|
|
extend T::Sig
|
|
|
|
NICE_NAME = "electron-builder"
|
|
|
|
# A priority of zero causes livecheck to skip the strategy. We do this
|
|
# for {ElectronBuilder} so we can selectively apply the strategy using
|
|
# `strategy :electron_builder` in a `livecheck` block.
|
|
PRIORITY = 0
|
|
|
|
# The `Regexp` used to determine if the strategy applies to the URL.
|
|
URL_MATCH_REGEX = %r{^https?://.+/[^/]+\.ya?ml(?:\?[^/?]+)?$}i.freeze
|
|
|
|
# Whether the strategy can be applied to the provided URL.
|
|
#
|
|
# @param url [String] the URL to match against
|
|
# @return [Boolean]
|
|
sig { params(url: String).returns(T::Boolean) }
|
|
def self.match?(url)
|
|
URL_MATCH_REGEX.match?(url)
|
|
end
|
|
|
|
# Parses YAML text and identifies versions in it.
|
|
#
|
|
# @param content [String] the YAML text to parse and check
|
|
# @return [Array]
|
|
sig {
|
|
params(
|
|
content: String,
|
|
block: T.nilable(
|
|
T.proc.params(arg0: T::Hash[String, T.untyped]).returns(T.any(String, T::Array[String], NilClass)),
|
|
),
|
|
).returns(T::Array[String])
|
|
}
|
|
def self.versions_from_content(content, &block)
|
|
require "yaml"
|
|
|
|
yaml = YAML.safe_load(content)
|
|
return [] if yaml.blank?
|
|
|
|
return Strategy.handle_block_return(block.call(yaml)) if block
|
|
|
|
version = yaml["version"]
|
|
version.present? ? [version] : []
|
|
end
|
|
|
|
# Checks the content at the URL for new versions.
|
|
#
|
|
# @param url [String] the URL of the content to check
|
|
# @param regex [Regexp] a regex used for matching versions in content
|
|
# @return [Hash]
|
|
sig {
|
|
params(
|
|
url: String,
|
|
regex: T.nilable(Regexp),
|
|
cask: T.nilable(Cask::Cask),
|
|
block: T.nilable(T.proc.params(arg0: T::Hash[String, T.untyped]).returns(T.nilable(String))),
|
|
).returns(T::Hash[Symbol, T.untyped])
|
|
}
|
|
def self.find_versions(url, regex, cask: nil, &block)
|
|
raise ArgumentError, "The #{T.must(name).demodulize} strategy does not support a regex." if regex
|
|
|
|
match_data = { matches: {}, regex: regex, url: url }
|
|
|
|
match_data.merge!(Strategy.page_content(url))
|
|
content = match_data.delete(:content)
|
|
|
|
versions_from_content(content, &block).each do |version_text|
|
|
match_data[:matches][version_text] = Version.new(version_text)
|
|
end
|
|
|
|
match_data
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|