01cb74e525
Formulae, casks, and resources have a `#livecheckable?` method that indicates whether they contain a `livecheck` block. This is intended to be read as "has a livecheckable?", not "is livecheckable?" (as livecheck can find versions for some packages/resources without a `livecheck` block). Unfortunately, correct understanding of this method's behavior [outside of documentation] relies on historical knowledge that few people possess, so this is often confusing to anyone who hasn't been working on livecheck since 2020. In the olden days, a "livecheckable" was a Ruby file containing a `livecheck` block (originally a hash) with a filename that corresponded to a related formula. The `livecheck` blocks in livecheckable files were integrated into their respective formulae in August 2020, so [first-party] livecheckables ceased to exist at that time. From that point forward, we simply referred to these as `livecheck` blocks. With that in mind, this clarifies the situation by replacing "livecheckable" language. This includes renaming `#livecheckable?` to `#livecheck_defined?`, replacing usage of "livecheckable" as a noun with "`livecheck` block", replacing "livecheckable" as a boolean with "livecheck_defined", and replacing incorrect usage of "livecheckable" as an adjective with "checkable".
164 lines
3.9 KiB
Ruby
164 lines
3.9 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require "formula"
|
|
require "livecheck"
|
|
|
|
RSpec.describe Livecheck do
|
|
let(:f) do
|
|
formula do
|
|
homepage "https://brew.sh"
|
|
url "https://brew.sh/test-0.0.1.tgz"
|
|
head "https://github.com/Homebrew/brew.git"
|
|
end
|
|
end
|
|
let(:livecheck_f) { described_class.new(f.class) }
|
|
|
|
let(:c) do
|
|
Cask::CaskLoader.load(+<<-RUBY)
|
|
cask "test" do
|
|
version "0.0.1,2"
|
|
|
|
url "https://brew.sh/test-0.0.1.dmg"
|
|
name "Test"
|
|
desc "Test cask"
|
|
homepage "https://brew.sh"
|
|
end
|
|
RUBY
|
|
end
|
|
let(:livecheck_c) { described_class.new(c) }
|
|
|
|
describe "#formula" do
|
|
it "returns nil if not set" do
|
|
expect(livecheck_f.formula).to be_nil
|
|
end
|
|
|
|
it "returns the String if set" do
|
|
livecheck_f.formula("other-formula")
|
|
expect(livecheck_f.formula).to eq("other-formula")
|
|
end
|
|
|
|
it "raises a TypeError if the argument isn't a String" do
|
|
expect do
|
|
livecheck_f.formula(123)
|
|
end.to raise_error TypeError
|
|
end
|
|
end
|
|
|
|
describe "#cask" do
|
|
it "returns nil if not set" do
|
|
expect(livecheck_c.cask).to be_nil
|
|
end
|
|
|
|
it "returns the String if set" do
|
|
livecheck_c.cask("other-cask")
|
|
expect(livecheck_c.cask).to eq("other-cask")
|
|
end
|
|
end
|
|
|
|
describe "#regex" do
|
|
it "returns nil if not set" do
|
|
expect(livecheck_f.regex).to be_nil
|
|
end
|
|
|
|
it "returns the Regexp if set" do
|
|
livecheck_f.regex(/foo/)
|
|
expect(livecheck_f.regex).to eq(/foo/)
|
|
end
|
|
end
|
|
|
|
describe "#skip" do
|
|
it "sets @skip to true when no argument is provided" do
|
|
expect(livecheck_f.skip).to be true
|
|
expect(livecheck_f.instance_variable_get(:@skip)).to be true
|
|
expect(livecheck_f.instance_variable_get(:@skip_msg)).to be_nil
|
|
end
|
|
|
|
it "sets @skip to true and @skip_msg to the provided String" do
|
|
expect(livecheck_f.skip("foo")).to be true
|
|
expect(livecheck_f.instance_variable_get(:@skip)).to be true
|
|
expect(livecheck_f.instance_variable_get(:@skip_msg)).to eq("foo")
|
|
end
|
|
end
|
|
|
|
describe "#skip?" do
|
|
it "returns the value of @skip" do
|
|
expect(livecheck_f.skip?).to be false
|
|
|
|
livecheck_f.skip
|
|
expect(livecheck_f.skip?).to be true
|
|
end
|
|
end
|
|
|
|
describe "#strategy" do
|
|
it "returns nil if not set" do
|
|
expect(livecheck_f.strategy).to be_nil
|
|
end
|
|
|
|
it "returns the Symbol if set" do
|
|
livecheck_f.strategy(:page_match)
|
|
expect(livecheck_f.strategy).to eq(:page_match)
|
|
end
|
|
end
|
|
|
|
describe "#throttle" do
|
|
it "returns nil if not set" do
|
|
expect(livecheck_f.throttle).to be_nil
|
|
end
|
|
|
|
it "returns the Integer if set" do
|
|
livecheck_f.throttle(10)
|
|
expect(livecheck_f.throttle).to eq(10)
|
|
end
|
|
end
|
|
|
|
describe "#url" do
|
|
let(:url_string) { "https://brew.sh" }
|
|
|
|
it "returns nil if not set" do
|
|
expect(livecheck_f.url).to be_nil
|
|
end
|
|
|
|
it "returns a string when set to a string" do
|
|
livecheck_f.url(url_string)
|
|
expect(livecheck_f.url).to eq(url_string)
|
|
end
|
|
|
|
it "returns the URL symbol if valid" do
|
|
livecheck_f.url(:head)
|
|
expect(livecheck_f.url).to eq(:head)
|
|
|
|
livecheck_f.url(:homepage)
|
|
expect(livecheck_f.url).to eq(:homepage)
|
|
|
|
livecheck_f.url(:stable)
|
|
expect(livecheck_f.url).to eq(:stable)
|
|
|
|
livecheck_c.url(:url)
|
|
expect(livecheck_c.url).to eq(:url)
|
|
end
|
|
|
|
it "raises an ArgumentError if the argument isn't a valid Symbol" do
|
|
expect do
|
|
livecheck_f.url(:not_a_valid_symbol)
|
|
end.to raise_error ArgumentError
|
|
end
|
|
end
|
|
|
|
describe "#to_hash" do
|
|
it "returns a Hash of all instance variables" do
|
|
expect(livecheck_f.to_hash).to eq(
|
|
{
|
|
"cask" => nil,
|
|
"formula" => nil,
|
|
"regex" => nil,
|
|
"skip" => false,
|
|
"skip_msg" => nil,
|
|
"strategy" => nil,
|
|
"throttle" => nil,
|
|
"url" => nil,
|
|
},
|
|
)
|
|
end
|
|
end
|
|
end
|