rubocops/livecheck: Rework LivecheckUrlProvided

The existing `LivecheckUrlProvided` RuboCop requires a `url` for all
`livecheck` blocks except those using `skip`, `formula`, or `cask`,
as those only appear in a `livecheck` block with no other DSL methods.

We now have a `throttle` method that can be used alongside other DSL
methods (e.g., `url`, `regex`, `strategy`) or by itself. `brew style`
currently fails when `throttle` is used by itself, so this reworks
the conditions to allow this usage.
This commit is contained in:
Sam Ford 2024-03-21 15:34:13 -04:00
parent 857838ab7a
commit b3ab410215
No known key found for this signature in database
GPG Key ID: 7AF5CBEE1DD6F76D
2 changed files with 36 additions and 13 deletions

View File

@ -45,20 +45,19 @@ module RuboCop
class LivecheckUrlProvided < FormulaCop class LivecheckUrlProvided < FormulaCop
def audit_formula(_node, _class_node, _parent_class_node, body_node) def audit_formula(_node, _class_node, _parent_class_node, body_node)
livecheck_node = find_block(body_node, :livecheck) livecheck_node = find_block(body_node, :livecheck)
return if livecheck_node.blank? return unless livecheck_node
skip = find_every_method_call_by_name(livecheck_node, :skip).first url_node = find_every_method_call_by_name(livecheck_node, :url).first
return if skip.present? return if url_node
formula_node = find_every_method_call_by_name(livecheck_node, :formula).first # A regex and/or strategy is specific to a particular URL, so we
cask_node = find_every_method_call_by_name(livecheck_node, :cask).first # should require an explicit URL.
return if formula_node.present? || cask_node.present? regex_node = find_every_method_call_by_name(livecheck_node, :regex).first
strategy_node = find_every_method_call_by_name(livecheck_node, :strategy).first
livecheck_url = find_every_method_call_by_name(livecheck_node, :url).first return if !regex_node && !strategy_node
return if livecheck_url.present?
offending_node(livecheck_node) offending_node(livecheck_node)
problem "A `url` must be provided to livecheck." problem "A `url` should be provided when `regex` or `strategy` are used."
end end
end end

View File

@ -5,20 +5,31 @@ require "rubocops/livecheck"
RSpec.describe RuboCop::Cop::FormulaAudit::LivecheckUrlProvided do RSpec.describe RuboCop::Cop::FormulaAudit::LivecheckUrlProvided do
subject(:cop) { described_class.new } subject(:cop) { described_class.new }
it "reports an offense when a `url` is not specified in the livecheck block" do it "reports an offense when a `url` is not specified in a livecheck block" do
expect_offense(<<~RUBY) expect_offense(<<~RUBY)
class Foo < Formula class Foo < Formula
url "https://brew.sh/foo-1.0.tgz" url "https://brew.sh/foo-1.0.tgz"
livecheck do livecheck do
^^^^^^^^^^^^ FormulaAudit/LivecheckUrlProvided: A `url` must be provided to livecheck. ^^^^^^^^^^^^ FormulaAudit/LivecheckUrlProvided: A `url` should be provided when `regex` or `strategy` are used.
regex(%r{href=.*?/formula[._-]v?(\\d+(?:\\.\\d+)+)\\.t}i) regex(%r{href=.*?/formula[._-]v?(\\d+(?:\\.\\d+)+)\\.t}i)
end end
end end
RUBY RUBY
expect_offense(<<~RUBY)
class Foo < Formula
url "https://brew.sh/foo-1.0.tgz"
livecheck do
^^^^^^^^^^^^ FormulaAudit/LivecheckUrlProvided: A `url` should be provided when `regex` or `strategy` are used.
strategy :page_match
end
end
RUBY
end end
it "reports no offenses when a `url` is specified in the livecheck block" do it "reports no offenses when a `url` and `regex` are specified in the livecheck block" do
expect_no_offenses(<<~RUBY) expect_no_offenses(<<~RUBY)
class Foo < Formula class Foo < Formula
url "https://brew.sh/foo-1.0.tgz" url "https://brew.sh/foo-1.0.tgz"
@ -30,4 +41,17 @@ RSpec.describe RuboCop::Cop::FormulaAudit::LivecheckUrlProvided do
end end
RUBY RUBY
end end
it "reports no offenses when a `url` and `strategy` are specified in the livecheck block" do
expect_no_offenses(<<~RUBY)
class Foo < Formula
url "https://brew.sh/foo-1.0.tgz"
livecheck do
url :stable
strategy :page_match
end
end
RUBY
end
end end