9f80a7bce2
- We recently deleted a load of old Homebrew/formula-patches patches for non-existent core formulae (https://github.com/Homebrew/formula-patches/pull/283). This is a good action to take. Users should always be able to retrieve the patch once it's been deleted from the repo, if the formula they continue to use specifies a git revision to pull from, not just `master`. - The code to detect `master` formulae was already here, so this adds another GitHub host to the detection: `raw.githubusercontent.com` as that's what the current patches that use `master` (https://github.com/Homebrew/homebrew-core/pull/51329) link to. - Fixes https://github.com/Homebrew/homebrew-core/issues/51313.
91 lines
3.2 KiB
Ruby
91 lines
3.2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require "rubocops/extend/formula"
|
|
require "extend/string"
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module FormulaAudit
|
|
# This cop audits patches in Formulae.
|
|
class Patches < FormulaCop
|
|
def audit_formula(_node, _class_node, _parent_class_node, body)
|
|
external_patches = find_all_blocks(body, :patch)
|
|
external_patches.each do |patch_block|
|
|
url_node = find_every_method_call_by_name(patch_block, :url).first
|
|
url_string = parameters(url_node).first
|
|
patch_problems(url_string)
|
|
end
|
|
|
|
patches_node = find_method_def(body, :patches)
|
|
return if patches_node.nil?
|
|
|
|
legacy_patches = find_strings(patches_node)
|
|
problem "Use the patch DSL instead of defining a 'patches' method"
|
|
legacy_patches.each { |p| patch_problems(p) }
|
|
end
|
|
|
|
private
|
|
|
|
def patch_problems(patch)
|
|
patch_url = string_content(patch)
|
|
gh_patch_param_pattern = %r{https?://github\.com/.+/.+/(?:commit|pull)/[a-fA-F0-9]*.(?:patch|diff)}
|
|
if regex_match_group(patch, gh_patch_param_pattern)
|
|
unless patch_url.match?(/\?full_index=\w+$/)
|
|
problem <<~EOS
|
|
GitHub patches should use the full_index parameter:
|
|
#{patch_url}?full_index=1
|
|
EOS
|
|
end
|
|
end
|
|
|
|
gh_patch_patterns = Regexp.union([%r{/raw\.github\.com/},
|
|
%r{/raw\.githubusercontent\.com/},
|
|
%r{gist\.github\.com/raw},
|
|
%r{gist\.github\.com/.+/raw},
|
|
%r{gist\.githubusercontent\.com/.+/raw}])
|
|
if regex_match_group(patch, gh_patch_patterns)
|
|
unless patch_url.match?(/[a-fA-F0-9]{40}/)
|
|
problem <<~EOS.chomp
|
|
GitHub/Gist patches should specify a revision:
|
|
#{patch_url}
|
|
EOS
|
|
end
|
|
end
|
|
|
|
gh_patch_diff_pattern =
|
|
%r{https?://patch-diff\.githubusercontent\.com/raw/(.+)/(.+)/pull/(.+)\.(?:diff|patch)}
|
|
if match_obj = regex_match_group(patch, gh_patch_diff_pattern)
|
|
problem <<~EOS
|
|
use GitHub pull request URLs:
|
|
https://github.com/#{match_obj[1]}/#{match_obj[2]}/pull/#{match_obj[3]}.patch
|
|
Rather than patch-diff:
|
|
#{patch_url}
|
|
EOS
|
|
end
|
|
|
|
if regex_match_group(patch, %r{macports/trunk})
|
|
problem <<~EOS.chomp
|
|
MacPorts patches should specify a revision instead of trunk:
|
|
#{patch_url}
|
|
EOS
|
|
end
|
|
|
|
if regex_match_group(patch, %r{^http://trac\.macports\.org})
|
|
problem <<~EOS.chomp
|
|
Patches from MacPorts Trac should be https://, not http:
|
|
#{patch_url}
|
|
EOS
|
|
end
|
|
|
|
return unless regex_match_group(patch, %r{^http://bugs\.debian\.org})
|
|
|
|
problem <<~EOS.chomp
|
|
Patches from Debian should be https://, not http:
|
|
#{patch_url}
|
|
EOS
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|