Class: Homebrew::Livecheck::Strategy::Bitbucket

Inherits:
Object
  • Object
show all
Defined in:
livecheck/strategy/bitbucket.rb

Overview

The Bitbucket strategy identifies versions of software at bitbucket.org by checking a repository's available downloads.

Bitbucket URLs generally take one of the following formats:

  • https://bitbucket.org/example/example/get/1.2.3.tar.gz
  • https://bitbucket.org/example/example/downloads/example-1.2.3.tar.gz

The /get/ archive files are simply automated snapshots of the files for a given tag. The /downloads/ archive files are files that have been uploaded instead.

It's also possible for an archive to come from a repository's wiki, like: https://bitbucket.org/example/example/wiki/downloads/example-1.2.3.zip. This scenario is handled by this strategy as well and the path in this example would be example/example/wiki (instead of example/example with the previous URLs).

The default regex identifies versions in archive files found in href attributes.

Constant Summary collapse

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?://bitbucket\.org
  /(?<path>.+?) # The path leading up to the get or downloads part
  /(?<dl_type>get|downloads) # An indicator of the file download type
  /(?<prefix>(?:[^/]+?[_-])?) # Filename text before the version
  v?\d+(?:\.\d+)+ # The numeric version
  (?<suffix>[^/]+) # Filename text after the version
}ix

Class Method Summary collapse

Class Method Details

.find_versions(url:, regex: nil, **unused, &block) ⇒ 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.

Generates a URL and regex (if one isn't provided) and passes them to PageMatch.find_versions to identify versions in the content.

Parameters:

  • url (String) —

    the URL of the content to check

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

    a regex used for matching versions in content

  • unused (T.untyped)
  • block (Proc, nil)

Returns:



105
106
107
108
109
 
# File 'livecheck/strategy/bitbucket.rb', line 105

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}

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. Some of these values act as defaults and can be overridden in a livecheck block.

Parameters:

  • url (String) —

    the URL used to generate values

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'livecheck/strategy/bitbucket.rb', line 58

def self.generate_input_values(url)
  values = {}

  match = url.match(URL_MATCH_REGEX)
  return values if match.blank?

  regex_prefix = Regexp.escape(T.must(match[:prefix])).gsub("\\-", "-")

  # `/get/` archives are Git tag snapshots, so we need to check that tab
  # instead of the main `/downloads/` page
  if match[:dl_type] == "get"
    values[:url] = "https://bitbucket.org/#{match[:path]}/downloads/?tab=tags"

    # Example tag regexes:
    # * `/<td[^>]*?class="name"[^>]*?>\s*v?(\d+(?:\.\d+)+)\s*?</im`
    # * `/<td[^>]*?class="name"[^>]*?>\s*abc-v?(\d+(?:\.\d+)+)\s*?</im`
    values[:regex] = /<td[^>]*?class="name"[^>]*?>\s*#{regex_prefix}v?(\d+(?:\.\d+)+)\s*?</im
  else
    values[:url] = "https://bitbucket.org/#{match[:path]}/downloads/"

    # Use `\.t` instead of specific tarball extensions (e.g. .tar.gz)
    suffix = T.must(match[:suffix]).sub(Strategy::TARBALL_EXTENSION_REGEX, ".t")
    regex_suffix = Regexp.escape(suffix).gsub("\\-", "-")

    # Example file regexes:
    # * `/href=.*?v?(\d+(?:\.\d+)+)\.t/i`
    # * `/href=.*?abc-v?(\d+(?:\.\d+)+)\.t/i`
    values[:regex] = /href=.*?#{regex_prefix}v?(\d+(?:\.\d+)+)#{regex_suffix}/i
  end

  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) 


46
47
48
 
# File 'livecheck/strategy/bitbucket.rb', line 46

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