From 5139b9b468e60e4504d2ce52d8967147541f6c7b Mon Sep 17 00:00:00 2001 From: Sean Molenaar Date: Tue, 18 Apr 2023 15:42:26 +0200 Subject: [PATCH] feat: add github_release strategy --- Library/Homebrew/.rubocop.yml | 1 + Library/Homebrew/livecheck/strategy.rb | 1 + .../livecheck/strategy/github_latest.rb | 64 +-------- .../livecheck/strategy/github_release.rb | 130 ++++++++++++++++++ 4 files changed, 136 insertions(+), 60 deletions(-) create mode 100644 Library/Homebrew/livecheck/strategy/github_release.rb diff --git a/Library/Homebrew/.rubocop.yml b/Library/Homebrew/.rubocop.yml index 7c0b5f7255..303197f1ce 100644 --- a/Library/Homebrew/.rubocop.yml +++ b/Library/Homebrew/.rubocop.yml @@ -43,6 +43,7 @@ Style/Documentation: - livecheck/strategy/extract_plist.rb - livecheck/strategy/git.rb - livecheck/strategy/github_latest.rb + - livecheck/strategy/github_release.rb - livecheck/strategy/gnome.rb - livecheck/strategy/gnu.rb - livecheck/strategy/hackage.rb diff --git a/Library/Homebrew/livecheck/strategy.rb b/Library/Homebrew/livecheck/strategy.rb index 6cee9ded13..17bbcb27cc 100644 --- a/Library/Homebrew/livecheck/strategy.rb +++ b/Library/Homebrew/livecheck/strategy.rb @@ -270,6 +270,7 @@ require_relative "strategy/electron_builder" require_relative "strategy/extract_plist" require_relative "strategy/git" require_relative "strategy/github_latest" +require_relative "strategy/github_release" require_relative "strategy/gnome" require_relative "strategy/gnu" require_relative "strategy/hackage" diff --git a/Library/Homebrew/livecheck/strategy/github_latest.rb b/Library/Homebrew/livecheck/strategy/github_latest.rb index 92792059b3..7caa270c06 100644 --- a/Library/Homebrew/livecheck/strategy/github_latest.rb +++ b/Library/Homebrew/livecheck/strategy/github_latest.rb @@ -34,28 +34,13 @@ module Homebrew # `strategy :github_latest` in a `livecheck` block. PRIORITY = 0 - # The `Regexp` used to determine if the strategy applies to the URL. - URL_MATCH_REGEX = %r{ - ^https?://github\.com - /(?:downloads/)?(?[^/]+) # The GitHub username - /(?[^/]+) # The GitHub repository name - }ix.freeze - - # The default regex used to identify a version from a tag when a regex - # isn't provided. - DEFAULT_REGEX = /v?(\d+(?:\.\d+)+)/i.freeze - - # Keys in the release JSON that could contain the version. - # Tag name first since that is closer to other livechecks. - VERSION_KEYS = ["tag_name", "name"].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) + GitHubRelease.match?(url) end # Extracts information from a provided URL and uses it to generate @@ -69,7 +54,7 @@ module Homebrew def self.generate_input_values(url) values = {} - match = url.sub(/\.git$/i, "").match(URL_MATCH_REGEX) + match = url.delete_suffix(".git").match(GitHubRelease::URL_MATCH_REGEX) return values if match.blank? values[:url] = "https://api.github.com/repos/#{match[:username]}/#{match[:repository]}/releases/latest" @@ -79,46 +64,6 @@ module Homebrew values end - # Uses a regex to match the version from release JSON or, if a block is - # provided, passes the JSON to the block to handle matching. With - # either approach, an array of unique matches is returned. - # - # @param content [Array, Hash] list of releases or a single release - # @param regex [Regexp] a regex used for matching versions in the content - # @param block [Proc, nil] a block to match the content - # @return [Array] - sig { - params( - content: T.any(T::Array[T::Hash[String, T.untyped]], T::Hash[String, T.untyped]), - regex: Regexp, - block: T.nilable(Proc), - ).returns(T::Array[String]) - } - def self.versions_from_content(content, regex, &block) - if block.present? - block_return_value = if regex.present? - yield(content, regex) - else - yield(content) - end - return Strategy.handle_block_return(block_return_value) - end - - content = [content] unless content.is_a?(Array) - content.reject(&:blank?).map do |release| - next if release["draft"] || release["prerelease"] - - value = T.let(nil, T.untyped) - VERSION_KEYS.find do |key| - match = release[key]&.match(regex) - next if match.blank? - - value = match[1] - end - value - end.compact.uniq - end - # Generates the GitHub API URL for the repository's "latest" release # and identifies the version from the JSON response. # @@ -133,16 +78,15 @@ module Homebrew block: T.nilable(Proc), ).returns(T::Hash[Symbol, T.untyped]) } - def self.find_versions(url:, regex: DEFAULT_REGEX, **_unused, &block) + def self.find_versions(url:, regex: GitHubRelease::DEFAULT_REGEX, **_unused, &block) match_data = { matches: {}, regex: regex, url: url } - generated = generate_input_values(url) return match_data if generated.blank? match_data[:url] = generated[:url] release = GitHub.get_latest_release(generated[:username], generated[:repository]) - versions_from_content(release, regex, &block).each do |match_text| + GitHubRelease.versions_from_content(release, regex, &block).each do |match_text| match_data[:matches][match_text] = Version.new(match_text) end diff --git a/Library/Homebrew/livecheck/strategy/github_release.rb b/Library/Homebrew/livecheck/strategy/github_release.rb new file mode 100644 index 0000000000..7525b75018 --- /dev/null +++ b/Library/Homebrew/livecheck/strategy/github_release.rb @@ -0,0 +1,130 @@ +# typed: true +# frozen_string_literal: true + +module Homebrew + module Livecheck + module Strategy + # The {GithubRelease} strategy identifies versions of software at + # github.com by checking a repository's release page. + # + # GitHub URLs take a few different formats: + # + # * `https://github.com/example/example/releases/download/1.2.3/example-1.2.3.tar.gz` + # * `https://github.com/example/example/archive/v1.2.3.tar.gz` + # * `https://github.com/downloads/example/example/example-1.2.3.tar.gz` + # + # This strategy should only be used when we know the upstream repository + # has releases and the tagged release is appropriate to use + # The strategy can only be applied by using `strategy :github_latest` + # in a `livecheck` block. + # + # The default regex identifies versions like `1.2.3`/`v1.2.3` in the name or tag. + # This is a common tag format but a modified regex can be provided in a `livecheck` + # block to override the default if a repository uses a different format (e.g. + # `example-1.2.3`, `1.2.3d`, `1.2.3-4`, etc.). + # + # @api public + class GithubRelease + NICE_NAME = "GitHub - Releases" + + # A priority of zero causes livecheck to skip the strategy. We do this + # for {GithubRelease} so we can selectively apply the strategy using + # `strategy :github_release` in a `livecheck` block. + PRIORITY = 0 + + # The `Regexp` used to determine if the strategy applies to the URL. + URL_MATCH_REGEX = %r{ + ^https?://github\.com + /(?:downloads/)?(?[^/]+) # The GitHub username + /(?[^/]+) # The GitHub repository name + }ix.freeze + + # The default regex used to identify a version from a tag when a regex + # isn't provided. + DEFAULT_REGEX = /v?(\d+(?:\.\d+)+)/i.freeze + + # Keys in the JSON that could contain the version. + VERSION_KEYS = ["tag_name", "name"].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 + + # Uses a regex to match the version from release JSON or, if a block is + # provided, passes the JSON to the block to handle matching. With + # either approach, an array of unique matches is returned. + # + # @param content [Array, Hash] list of releases or a single release + # @param regex [Regexp] a regex used for matching versions in the content + # @param block [Proc, nil] a block to match the content + # @return [Array] + sig { + params( + content: T.any(T::Array[T::Hash[String, T.untyped]], T::Hash[String, T.untyped]), + regex: Regexp, + block: T.nilable(Proc), + ).returns(T::Array[String]) + } + def self.versions_from_content(content, regex, &block) + if block.present? + block_return_value = if regex.present? + yield(content, regex) + else + yield(content) + end + return Strategy.handle_block_return(block_return_value) + end + + content = [content] unless content.is_a?(Array) + content.reject(&:blank?).map do |release| + next if release["draft"] || release["prerelease"] + + value = T.let(nil, T.untyped) + VERSION_KEYS.find do |key| + match = release[key]&.match(regex) + next if match.blank? + + value = match[1] + end + value + end.compact.uniq + end + + # Generates a URL and regex (if one isn't provided) and passes them + # to {PageMatch.find_versions} to identify versions in the content. + # + # @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), + _unused: T.nilable(T::Hash[Symbol, T.untyped]), + block: T.nilable(Proc), + ).returns(T::Hash[Symbol, T.untyped]) + } + def self.find_versions(url:, regex: GithubRelease::DEFAULT_REGEX, **_unused, &block) + match_data = { matches: {}, regex: regex } + match = url.delete_suffix(".git") + .match(URL_MATCH_REGEX) + return match_data if match.blank? + + releases = GitHub::API.open_rest("https://api.github.com/repos/#{match[:username]}/#{match[:repository]}/releases") + + GithubRelease.versions_from_content(releases, regex, &block).each do |match_text| + match_data[:matches][match_text] = Version.new(match_text) + end + + match_data + end + end + end + GitHubRelease = Homebrew::Livecheck::Strategy::GithubRelease + end +end