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.
105 lines
3.9 KiB
Ruby
105 lines
3.9 KiB
Ruby
# typed: false
|
|
# frozen_string_literal: true
|
|
|
|
require "livecheck/strategy"
|
|
require "bundle_version"
|
|
|
|
describe Homebrew::Livecheck::Strategy::Sparkle do
|
|
subject(:sparkle) { described_class }
|
|
|
|
let(:url) { "https://www.example.com/example/appcast.xml" }
|
|
|
|
let(:appcast_data) {
|
|
{
|
|
title: "Version 1.2.3",
|
|
pub_date: "Fri, 01 Jan 2021 01:23:45 +0000",
|
|
url: "https://www.example.com/example/example.tar.gz",
|
|
short_version: "1.2.3",
|
|
version: "1234",
|
|
}
|
|
}
|
|
|
|
let(:appcast_xml) {
|
|
<<~EOS
|
|
<?xml version="1.0" encoding="utf-8"?>
|
|
<rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle">
|
|
<channel>
|
|
<title>Example Changelog</title>
|
|
<link>#{url}</link>
|
|
<description>Most recent changes with links to updates.</description>
|
|
<language>en</language>
|
|
<item>
|
|
<title>#{appcast_data[:title]}</title>
|
|
<sparkle:minimumSystemVersion>10.10</sparkle:minimumSystemVersion>
|
|
<sparkle:releaseNotesLink>https://www.example.com/example/1.2.3.html</sparkle:releaseNotesLink>
|
|
<pubDate>#{appcast_data[:pub_date]}</pubDate>
|
|
<enclosure url="#{appcast_data[:url]}" sparkle:shortVersionString="#{appcast_data[:short_version]}" sparkle:version="#{appcast_data[:version]}" length="12345678" type="application/octet-stream" sparkle:dsaSignature="ABCDEF+GHIJKLMNOPQRSTUVWXYZab/cdefghijklmnopqrst/uvwxyz1234567==" />
|
|
</item>
|
|
</channel>
|
|
</rss>
|
|
EOS
|
|
}
|
|
|
|
let(:item) {
|
|
Homebrew::Livecheck::Strategy::Sparkle::Item.new(
|
|
title: appcast_data[:title],
|
|
pub_date: Time.parse(appcast_data[:pub_date]),
|
|
url: appcast_data[:url],
|
|
bundle_version: Homebrew::BundleVersion.new(appcast_data[:short_version], appcast_data[:version]),
|
|
)
|
|
}
|
|
|
|
let(:versions) { [item.bundle_version.nice_version] }
|
|
|
|
describe "::match?" do
|
|
it "returns true for any URL" do
|
|
expect(sparkle.match?(url)).to be true
|
|
end
|
|
end
|
|
|
|
describe "::item_from_content" do
|
|
let(:item_from_appcast_xml) { sparkle.item_from_content(appcast_xml) }
|
|
|
|
it "returns nil if content is blank" do
|
|
expect(sparkle.item_from_content("")).to be nil
|
|
end
|
|
|
|
it "returns an Item when given XML data" do
|
|
expect(item_from_appcast_xml).to be_a(Homebrew::Livecheck::Strategy::Sparkle::Item)
|
|
expect(item_from_appcast_xml).to eq(item)
|
|
expect(item_from_appcast_xml.title).to eq(appcast_data[:title])
|
|
expect(item_from_appcast_xml.pub_date).to eq(Time.parse(appcast_data[:pub_date]))
|
|
expect(item_from_appcast_xml.url).to eq(appcast_data[:url])
|
|
expect(item_from_appcast_xml.short_version).to eq(appcast_data[:short_version])
|
|
expect(item_from_appcast_xml.version).to eq(appcast_data[:version])
|
|
end
|
|
end
|
|
|
|
describe "::versions_from_content" do
|
|
it "returns an array of version strings when given content" do
|
|
expect(sparkle.versions_from_content(appcast_xml)).to eq(versions)
|
|
end
|
|
|
|
it "returns an array of version strings when given content and a block" do
|
|
# Returning a string from block
|
|
expect(
|
|
sparkle.versions_from_content(appcast_xml) do |item|
|
|
item.bundle_version&.nice_version&.sub("3", "4")
|
|
end,
|
|
).to eq([item.bundle_version.nice_version.sub("3", "4")])
|
|
|
|
# Returning an array of strings from block
|
|
expect(sparkle.versions_from_content(appcast_xml) { versions }).to eq(versions)
|
|
end
|
|
|
|
it "allows a nil return from a block" do
|
|
expect(sparkle.versions_from_content(appcast_xml) { next }).to eq([])
|
|
end
|
|
|
|
it "errors on an invalid return type from a block" do
|
|
expect { sparkle.versions_from_content(appcast_xml) { 123 } }
|
|
.to raise_error(TypeError, Homebrew::Livecheck::Strategy::INVALID_BLOCK_RETURN_VALUE_MSG)
|
|
end
|
|
end
|
|
end
|