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 ```
67 lines
2.3 KiB
Ruby
67 lines
2.3 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "rubocops/extend/formula_cop"
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module FormulaAudit
|
|
# This cop makes sure that deprecated checksums are not used.
|
|
class Checksum < FormulaCop
|
|
sig { override.params(formula_nodes: FormulaNodes).void }
|
|
def audit_formula(formula_nodes)
|
|
body_node = formula_nodes.body_node
|
|
|
|
problem "MD5 checksums are deprecated, please use SHA-256" if method_called_ever?(body_node, :md5)
|
|
|
|
problem "SHA1 checksums are deprecated, please use SHA-256" if method_called_ever?(body_node, :sha1)
|
|
|
|
sha256_calls = find_every_method_call_by_name(body_node, :sha256)
|
|
sha256_calls.each do |sha256_call|
|
|
sha256_node = get_checksum_node(sha256_call)
|
|
audit_sha256(sha256_node)
|
|
end
|
|
end
|
|
|
|
def audit_sha256(checksum)
|
|
return if checksum.nil?
|
|
|
|
if regex_match_group(checksum, /^$/)
|
|
problem "sha256 is empty"
|
|
return
|
|
end
|
|
|
|
if string_content(checksum).size != 64 && regex_match_group(checksum, /^\w*$/)
|
|
problem "sha256 should be 64 characters"
|
|
end
|
|
|
|
return unless regex_match_group(checksum, /[^a-f0-9]+/i)
|
|
|
|
add_offense(@offensive_source_range, message: "sha256 contains invalid characters")
|
|
end
|
|
end
|
|
|
|
# This cop makes sure that checksum strings are lowercase.
|
|
class ChecksumCase < FormulaCop
|
|
extend AutoCorrector
|
|
|
|
sig { override.params(formula_nodes: FormulaNodes).void }
|
|
def audit_formula(formula_nodes)
|
|
sha256_calls = find_every_method_call_by_name(formula_nodes.body_node, :sha256)
|
|
sha256_calls.each do |sha256_call|
|
|
checksum = get_checksum_node(sha256_call)
|
|
next if checksum.nil?
|
|
next unless regex_match_group(checksum, /[A-F]+/)
|
|
|
|
add_offense(@offensive_source_range, message: "sha256 should be lowercase") do |corrector|
|
|
correction = @offensive_node.source.downcase
|
|
corrector.insert_before(@offensive_node.source_range, correction)
|
|
corrector.remove(@offensive_node.source_range)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|