Merge pull request #16351 from Rylan12/rubocop-for-cask-discontinued

Create rubocop requiring `deprecate!` over `discontinued` for casks

Library/Homebrew/rubocops/cask/discontinued.rb

@@ -0,0 +1,42 @@
+# typed: true
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Cask
+      # This cop corrects `caveats { discontinued }` to `deprecate!`.
+      class Discontinued < Base
+        include CaskHelp
+        extend AutoCorrector
+
+        MESSAGE = "Use `deprecate!` instead of `caveats { discontinued }`."
+
+        def on_cask_stanza_block(stanza_block)
+          stanza_block.stanzas.select(&:caveats?).each do |stanza|
+            find_discontinued_method_call(stanza.stanza_node) do |node|
+              if caveats_constains_only_discontinued?(node.parent)
+                add_offense(node.parent, message: MESSAGE) do |corrector|
+                  corrector.replace(node.parent.source_range,
+                                    "deprecate! date: \"#{Date.today}\", because: :discontinued")
+                end
+              else
+                add_offense(node, message: MESSAGE)
+              end
+            end
+          end
+        end
+
+        def_node_matcher :caveats_constains_only_discontinued?, <<~EOS
+          (block
+            (send nil? :caveats)
+            (args)
+            (send nil? :discontinued))
+        EOS
+
+        def_node_search :find_discontinued_method_call, <<~EOS
+          $(send nil? :discontinued)
+        EOS
+      end
+    end
+  end
+end

Library/Homebrew/rubocops/cask/discontinued.rbi

@@ -0,0 +1,25 @@
+# typed: strict
+
+module RuboCop
+  module Cop
+    module Cask
+      class Discontinued < Base
+        sig {
+          params(
+            base_node: RuboCop::AST::BlockNode,
+            block:     T.nilable(T.proc.params(node: RuboCop::AST::SendNode).void),
+          ).returns(T::Boolean)
+        }
+        def caveats_constains_only_discontinued?(base_node, &block); end
+
+        sig {
+          params(
+            base_node: RuboCop::AST::BlockNode,
+            block:     T.proc.params(node: RuboCop::AST::SendNode).void,
+          ).void
+        }
+        def find_discontinued_method_call(base_node, &block); end
+      end
+    end
+  end
+end

Library/Homebrew/rubocops/rubocop-cask.rb

@@ -13,6 +13,7 @@ require_relative "cask/mixin/cask_help"
 require_relative "cask/mixin/on_homepage_stanza"
 require_relative "cask/mixin/on_url_stanza"
 require_relative "cask/desc"
+require_relative "cask/discontinued"
 require_relative "cask/homepage_url_trailing_slash"
 require_relative "cask/no_overrides"
 require_relative "cask/on_system_conditionals"

Library/Homebrew/test/cask/audit_spec.rb

@@ -529,14 +529,26 @@ describe Cask::Audit, :cask do
         it { is_expected.not_to error_with(message) }
       end
 
-      context "when the Cask is discontinued" do
+      context "when the Cask is deprecated" do
-        let(:cask_token) { "livecheck/livecheck-discontinued" }
+        let(:cask_token) { "livecheck/livecheck-deprecated" }
 
         it { is_expected.not_to error_with(message) }
       end
 
-      context "when the Cask has a livecheck block referencing a discontinued Cask" do
+      context "when the Cask has a livecheck block referencing a deprecated Cask" do
-        let(:cask_token) { "livecheck/livecheck-discontinued-reference" }
+        let(:cask_token) { "livecheck/livecheck-deprecated-reference" }
+
+        it { is_expected.not_to error_with(message) }
+      end
+
+      context "when the Cask is disabled" do
+        let(:cask_token) { "livecheck/livecheck-disabled" }
+
+        it { is_expected.not_to error_with(message) }
+      end
+
+      context "when the Cask has a livecheck block referencing a disabled Cask" do
+        let(:cask_token) { "livecheck/livecheck-disabled-reference" }
 
         it { is_expected.not_to error_with(message) }
       end

Library/Homebrew/test/rubocops/cask/discontinued_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "rubocops/rubocop-cask"
+
+describe RuboCop::Cop::Cask::Discontinued, :config do
+  it "reports no offenses when there is no `caveats` stanza" do
+    expect_no_offenses <<~CASK
+      cask "foo" do
+        url "https://example.com/download/foo-v1.2.0.dmg",
+            verified: "example.com/download/"
+      end
+    CASK
+  end
+
+  it "reports no offenses when there is a `caveats` stanza without `discontinued`" do
+    expect_no_offenses <<~CASK
+      cask "foo" do
+        url "https://example.com/download/foo-v1.2.0.dmg",
+            verified: "example.com/download/"
+
+        caveats do
+          files_in_usr_local
+        end
+      end
+    CASK
+  end
+
+  it "reports an offense when there is a `caveats` stanza with `discontinued` and other caveats" do
+    expect_offense <<~CASK
+      cask "foo" do
+        url "https://example.com/download/foo-v1.2.0.dmg",
+            verified: "example.com/download/"
+
+        caveats do
+          discontinued
+          ^^^^^^^^^^^^ Use `deprecate!` instead of `caveats { discontinued }`.
+          files_in_usr_local
+        end
+      end
+    CASK
+  end
+
+  it "corrects `caveats { discontinued }` to `deprecate!`" do
+    expect_offense <<~CASK
+      cask "foo" do
+        url "https://example.com/download/foo-v1.2.0.dmg",
+            verified: "example.com/download/"
+
+        caveats do
+        ^^^^^^^^^^ Use `deprecate!` instead of `caveats { discontinued }`.
+          discontinued
+        end
+      end
+    CASK
+
+    expect_correction <<~CASK
+      cask "foo" do
+        url "https://example.com/download/foo-v1.2.0.dmg",
+            verified: "example.com/download/"
+
+        deprecate! date: "#{Date.today}", because: :discontinued
+      end
+    CASK
+  end
+end

Library/Homebrew/test/support/fixtures/cask/Casks/livecheck/livecheck-deprecated-reference.rb

@@ -1,17 +1,17 @@
-cask "livecheck-discontinued-reference" do
+cask "livecheck-deprecated-reference" do
   version "1.2.3"
   sha256 "8c62a2b791cf5f0da6066a0a4b6e85f62949cd60975da062df44adf887f4370b"
 
   # This cask is used in --online tests, so we use fake URLs to avoid impacting
   # real servers. The URL paths are specific enough that they'll be
   # understandable if they appear in local server logs.
-  url "http://localhost/homebrew/test/cask/audit/livecheck/discontinued-#{version}.dmg"
+  url "http://localhost/homebrew/test/cask/audit/livecheck/deprecated-#{version}.dmg"
-  name "Discontinued Reference"
+  name "Deprecated Reference"
-  desc "Cask for testing a livecheck reference to a discontinued cask"
+  desc "Cask for testing a livecheck reference to a deprecated cask"
-  homepage "http://localhost/homebrew/test/cask/audit/livecheck/discontinued"
+  homepage "http://localhost/homebrew/test/cask/audit/livecheck/deprecated"
 
   livecheck do
-    cask "livecheck/livecheck-discontinued"
+    cask "livecheck/livecheck-deprecated"
   end
 
   app "TestCask.app"

Library/Homebrew/test/support/fixtures/cask/Casks/livecheck/livecheck-deprecated.rb

@@ -0,0 +1,16 @@
+cask "livecheck-deprecated" do
+  version "1.2.3"
+  sha256 "8c62a2b791cf5f0da6066a0a4b6e85f62949cd60975da062df44adf887f4370b"
+
+  # This cask is used in --online tests, so we use fake URLs to avoid impacting
+  # real servers. The URL paths are specific enough that they'll be
+  # understandable if they appear in local server logs.
+  url "http://localhost/homebrew/test/cask/audit/livecheck/deprecated-#{version}.dmg"
+  name "Deprecated"
+  desc "Cask for testing deprecated in livecheck"
+  homepage "http://localhost/homebrew/test/cask/audit/livecheck/deprecated"
+
+  deprecate! date: "2023-01-01", because: :discontinued
+
+  app "TestCask.app"
+end

Library/Homebrew/test/support/fixtures/cask/Casks/livecheck/livecheck-disabled-reference.rb

@@ -0,0 +1,18 @@
+cask "livecheck-disabled-reference" do
+  version "1.2.3"
+  sha256 "8c62a2b791cf5f0da6066a0a4b6e85f62949cd60975da062df44adf887f4370b"
+
+  # This cask is used in --online tests, so we use fake URLs to avoid impacting
+  # real servers. The URL paths are specific enough that they'll be
+  # understandable if they appear in local server logs.
+  url "http://localhost/homebrew/test/cask/audit/livecheck/disabled-#{version}.dmg"
+  name "Disabled Reference"
+  desc "Cask for testing a livecheck reference to a disabled cask"
+  homepage "http://localhost/homebrew/test/cask/audit/livecheck/disabled"
+
+  livecheck do
+    cask "livecheck/livecheck-disabled"
+  end
+
+  app "TestCask.app"
+end

Library/Homebrew/test/support/fixtures/cask/Casks/livecheck/livecheck-disabled.rb

@@ -1,18 +1,16 @@
-cask "livecheck-discontinued" do
+cask "livecheck-disabled" do
   version "1.2.3"
   sha256 "8c62a2b791cf5f0da6066a0a4b6e85f62949cd60975da062df44adf887f4370b"
 
   # This cask is used in --online tests, so we use fake URLs to avoid impacting
   # real servers. The URL paths are specific enough that they'll be
   # understandable if they appear in local server logs.
-  url "http://localhost/homebrew/test/cask/audit/livecheck/discontinued-#{version}.dmg"
+  url "http://localhost/homebrew/test/cask/audit/livecheck/disabled-#{version}.dmg"
-  name "Discontinued"
+  name "Disabled"
-  desc "Cask for testing discontinued in livecheck"
+  desc "Cask for testing disabled in livecheck"
-  homepage "http://localhost/homebrew/test/cask/audit/livecheck/discontinued"
+  homepage "http://localhost/homebrew/test/cask/audit/livecheck/disabled"
+
+  disable! date: "2023-01-01", because: :discontinued
 
   app "TestCask.app"
-
-  caveats do
-    discontinued
-  end
 end