Class: Homebrew::Livecheck::Strategy::Sourceforge

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

Overview

The Sourceforge strategy identifies versions of software at sourceforge.net by checking a project's RSS feed.

SourceForge URLs take a few different formats:

  • https://downloads.sourceforge.net/project/example/example-1.2.3.tar.gz
  • https://svn.code.sf.net/p/example/code/trunk
  • :pserver:anonymous:@example.cvs.sourceforge.net:/cvsroot/example

The RSS feed for a project contains the most recent release archives and while this is fine for most projects, this approach has some shortcomings. Some project releases involve so many files that the one we're interested in isn't present in the feed content. Some projects contain additional software and the archive we're interested in is pushed out of the feed (especially if it hasn't been updated recently).

Usually we address this situation by adding a livecheck block to the formula/cask that checks the page for the relevant directory in the project instead. In this situation, it's necessary to use strategy :page_match to prevent the Sourceforge stratgy from being used.

The default regex matches within url attributes in the RSS feed and identifies versions within directory names or filenames.

Constant Summary collapse

NICE_NAME = 
"SourceForge"
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?://(?:[^/]+?\.)*(?:sourceforge|sf)\.net
  (?:/projects?/(?<project_name>[^/]+)/
  |/p/(?<project_name>[^/]+)/
  |(?::/cvsroot)?/(?<project_name>[^/]+))
}ix

Class Method Summary collapse

Methods included from Homebrew::Livecheck::Strategic

find_versions, match?

Class Method Details

.find_versions(url:, regex: 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 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

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

    options to modify behavior

  • block (Proc, nil)

Returns:



101
102
103
104
105
106
107
108
109
110
 
# File 'livecheck/strategy/sourceforge.rb', line 101

def self.find_versions(url:, regex: nil, options: Options.new, &block)
  generated = generate_input_values(url)

  PageMatch.find_versions(
    url:     generated[:url] || url,
    regex:   regex || generated[:regex],
    options:,
    &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:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'livecheck/strategy/sourceforge.rb', line 65

def self.generate_input_values(url)
  values = {}

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

  # Don't generate a URL if the URL already points to the RSS feed
  unless url.match?(%r{/rss(?:/?$|\?)})
    values[:url] = "https://sourceforge.net/projects/#{match[:project_name]}/rss"
  end

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

  # It may be possible to improve the generated regex but there's quite
  # a bit of variation between projects and it can be challenging to
  # create something that works for most URLs.
  values[:regex] = %r{url=.*?/#{regex_name}/files/.*?[-_/](\d+(?:[-.]\d+)+)[-_/%.]}i

  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) 


53
54
55
 
# File 'livecheck/strategy/sourceforge.rb', line 53

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