45978435e7
- Previously I thought that comments were fine to discourage people from wasting their time trying to bump things that used `undef` that Sorbet didn't support. But RuboCop is better at this since it'll complain if the comments are unnecessary. - Suggested in https://github.com/Homebrew/brew/pull/18018#issuecomment-2283369501. - I've gone for a mixture of `rubocop:disable` for the files that can't be `typed: strict` (use of undef, required before everything else, etc) and `rubocop:todo` for everything else that should be tried to make strictly typed. There's no functional difference between the two as `rubocop:todo` is `rubocop:disable` with a different name. - And I entirely disabled the cop for the docs/ directory since `typed: strict` isn't going to gain us anything for some Markdown linting config files. - This means that now it's easier to track what needs to be done rather than relying on checklists of files in our big Sorbet issue: ```shell $ git grep 'typed: true # rubocop:todo Sorbet/StrictSigil' | wc -l 268 ``` - And this is confirmed working for new files: ```shell $ git status On branch use-rubocop-for-sorbet-strict-sigils Untracked files: (use "git add <file>..." to include in what will be committed) Library/Homebrew/bad.rb Library/Homebrew/good.rb nothing added to commit but untracked files present (use "git add" to track) $ brew style Offenses: bad.rb:1:1: C: Sorbet/StrictSigil: Sorbet sigil should be at least strict got true. ^^^^^^^^^^^^^ 1340 files inspected, 1 offense detected ```
70 lines
2.3 KiB
Ruby
70 lines
2.3 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "rubocops/shared/url_helper"
|
|
|
|
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
|
|
include UrlHelper
|
|
|
|
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
|
|
|
|
audit_url(:cask, [stanza.stanza_node], [], livecheck_url: false)
|
|
|
|
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
|