Merge pull request #14886 from issyl0/rubocop-cask-url-verified-disallow-protocol

Library/Homebrew/rubocops/cask/mixin/on_url_stanza.rbi

@@ -1,5 +1,5 @@
 # typed: strict
 
 module RuboCop::Cop::Cask::OnUrlStanza
-  requires_ancestor { RuboCop::Cop::Cask::UrlLegacyCommaSeparators }
+  requires_ancestor { RuboCop::Cop::Cask::Url }
 end

Library/Homebrew/rubocops/cask/url.rb

@@ -0,0 +1,46 @@
+# typed: true
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Cask
+      # This cop checks that a cask's `url` stanza is formatted correctly.
+      #
+      # @example
+      #   # bad
+      #   url "https://example.com/foo.dmg",
+      #     verified: "https://example.com"
+      #
+      #
+      #   # good
+      #   url "https://example.com/foo.dmg",
+      #     verified: "example.com"
+      #
+      class Url < Base
+        extend AutoCorrector
+        extend Forwardable
+        include OnUrlStanza
+
+        def on_url_stanza(stanza)
+          return if stanza.stanza_node.block_type?
+
+          hash_node = stanza.stanza_node.last_argument
+          return unless hash_node.hash_type?
+
+          hash_node.each_pair do |key_node, value_node|
+            next unless key_node.source == "verified"
+            next unless value_node.str_type?
+            next unless value_node.source.start_with?(%r{^"https?://})
+
+            add_offense(
+              value_node.source_range,
+              message: "Verified URL parameter value should not start with https:// or http://.",
+            ) do |corrector|
+              corrector.replace(value_node.source_range, value_node.source.gsub(%r{^"https?://}, "\""))
+            end
+          end
+        end
+      end
+    end
+  end
+end

Library/Homebrew/rubocops/cask/url_legacy_comma_separators.rb

@@ -8,7 +8,7 @@ module RuboCop
   module Cop
     module Cask
       # This cop checks for version.before_comma and version.after_comma
-      class UrlLegacyCommaSeparators < Base
+      class UrlLegacyCommaSeparators < Url
         include OnUrlStanza
         extend AutoCorrector
 

Library/Homebrew/rubocops/rubocop-cask.rb

@@ -18,5 +18,6 @@ require_relative "cask/no_dsl_version"
 require_relative "cask/on_system_conditionals"
 require_relative "cask/stanza_order"
 require_relative "cask/stanza_grouping"
+require_relative "cask/url"
 require_relative "cask/url_legacy_comma_separators"
 require_relative "cask/variables"

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

@@ -0,0 +1,57 @@
+# typed: false
+# frozen_string_literal: true
+
+require "rubocops/rubocop-cask"
+require "test/rubocops/cask/shared_examples/cask_cop"
+
+describe RuboCop::Cop::Cask::Url do
+  include CaskCop
+
+  subject(:cop) { described_class.new }
+
+  context "when url 'verified' value does not start with a protocol" do
+    let(:source) do
+      <<~CASK
+        cask "foo" do
+          url "https://example.com/download/foo-v1.2.0.dmg",
+            verified: "example.com"
+        end
+      CASK
+    end
+
+    include_examples "does not report any offenses"
+  end
+
+  context "when url 'verified' value starts with a protocol" do
+    let(:source) do
+      <<~CASK
+        cask "foo" do
+          url "https://example.com/download/foo-v1.2.0.dmg",
+            verified: "https://example.com"
+        end
+      CASK
+    end
+
+    let(:expected_offenses) do
+      [{
+        message:  "Verified URL parameter value should not start with https:// or http://.",
+        severity: :convention,
+        line:     3,
+        column:   14,
+        source:   "\"https://example.com\"",
+      }]
+    end
+
+    let(:correct_source) do
+      <<~CASK
+        cask "foo" do
+          url "https://example.com/download/foo-v1.2.0.dmg",
+            verified: "example.com"
+        end
+      CASK
+    end
+
+    include_examples "reports offenses"
+    include_examples "autocorrects source"
+  end
+end