2024-05-01 11:35:21 +02:00

64 lines
2.1 KiB
Ruby

# 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
#
# ```ruby
# # bad
# url "https://example.com/download/foo.dmg",
# verified: "https://example.com/download"
#
# # good
# url "https://example.com/download/foo.dmg",
# verified: "example.com/download/"
# ```
class Url < Base
extend AutoCorrector
extend Forwardable
include OnUrlStanza
def on_url_stanza(stanza)
return if stanza.stanza_node.block_type?
url_stanza = stanza.stanza_node.first_argument
hash_node = stanza.stanza_node.last_argument
return unless hash_node.hash_type?
hash_node.each_pair do |key_node, value_node|
next if key_node.source != "verified"
next unless value_node.str_type?
if value_node.source.start_with?(%r{^"https?://})
add_offense(
value_node.source_range,
message: "Verified URL parameter value should not contain a URL scheme.",
) do |corrector|
corrector.replace(value_node.source_range, value_node.source.gsub(%r{^"https?://}, "\""))
end
end
# Skip if the URL and the verified value are the same.
next if value_node.source == url_stanza.source.gsub(%r{^"https?://}, "\"")
# Skip if the URL has two path components, e.g. `https://github.com/google/fonts.git`.
next if url_stanza.source.gsub(%r{^"https?://}, "\"").count("/") == 2
# Skip if the verified value ends with a slash.
next if value_node.str_content.end_with?("/")
add_offense(
value_node.source_range,
message: "Verified URL parameter value should end with a /.",
) do |corrector|
corrector.replace(value_node.source_range, value_node.source.gsub(/"$/, "/\""))
end
end
end
end
end
end
end