admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

rubocops/patches: use rubocop v1 API

Browse Source
This commit is contained in:
Jonathan Chang 2021-01-12 16:54:53 +11:00
parent bb497ebfe0
commit df8e030174
2 changed files with 26 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Library/Homebrew/rubocops/patches.rb
View File

@ -8,6 +8,7 @@ module RuboCop
module Cop module Cop
module FormulaAudit module FormulaAudit
# This cop audits `patch`es in formulae. # This cop audits `patch`es in formulae.
# TODO: Many of these could be auto-corrected.
class Patches < FormulaCop class Patches < FormulaCop
extend T::Sig extend T::Sig
@ -26,7 +27,7 @@ module RuboCop
if inline_patches.empty? && patch_end? if inline_patches.empty? && patch_end?
offending_patch_end_node(node) offending_patch_end_node(node)
problem "patch is missing 'DATA'" add_offense(@offense_source_range, message: "patch is missing 'DATA'")
end end
patches_node = find_method_def(body, :patches) patches_node = find_method_def(body, :patches)

52
Library/Homebrew/test/rubocops/patches_spec.rb
View File

@ -7,7 +7,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
subject(:cop) { described_class.new } subject(:cop) { described_class.new }
context "When auditing legacy patches" do context "When auditing legacy patches" do
it "When there is no legacy patch" do it "reports no offenses when there is no legacy patch" do
expect_no_offenses(<<~RUBY) expect_no_offenses(<<~RUBY)
class Foo < Formula class Foo < Formula
url 'https://brew.sh/foo-1.0.tgz' url 'https://brew.sh/foo-1.0.tgz'
@ -15,7 +15,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
RUBY RUBY
end end
it "Formula with `def patches`" do it "reports an offense if `def patches` is present" do
expect_offense(<<~RUBY) expect_offense(<<~RUBY)
class Foo < Formula class Foo < Formula
homepage "ftp://brew.sh/foo" homepage "ftp://brew.sh/foo"
@ -28,7 +28,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
RUBY RUBY
end end
it "Patch URLs" do it "reports an offense for various patch URLs" do
patch_urls = [ patch_urls = [
"https://raw.github.com/mogaal/sendemail", "https://raw.github.com/mogaal/sendemail",
"https://mirrors.ustc.edu.cn/macports/trunk/", "https://mirrors.ustc.edu.cn/macports/trunk/",
@ -48,7 +48,6 @@ describe RuboCop::Cop::FormulaAudit::Patches do
end end
EOS EOS
inspect_source(source)
expected_offense = if patch_url.include?("/raw.github.com/") expected_offense = if patch_url.include?("/raw.github.com/")
[{ message: [{ message:
<<~EOS.chomp, <<~EOS.chomp,
@ -57,7 +56,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
EOS EOS
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 12, column: 4,
source: source }] source: source }]
elsif patch_url.include?("macports/trunk") elsif patch_url.include?("macports/trunk")
[{ message: [{ message:
@ -67,7 +66,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
EOS EOS
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 33, column: 4,
source: source }] source: source }]
elsif patch_url.start_with?("http://trac.macports.org") elsif patch_url.start_with?("http://trac.macports.org")
[{ message: [{ message:
@ -77,7 +76,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
EOS EOS
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 5, column: 4,
source: source }] source: source }]
elsif patch_url.start_with?("http://bugs.debian.org") elsif patch_url.start_with?("http://bugs.debian.org")
[{ message: [{ message:
@ -87,7 +86,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
EOS EOS
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 5, column: 4,
source: source }] source: source }]
# rubocop:disable Layout/LineLength # rubocop:disable Layout/LineLength
elsif patch_url.match?(%r{https?://patch-diff\.githubusercontent\.com/raw/(.+)/(.+)/pull/(.+)\.(?:diff|patch)}) elsif patch_url.match?(%r{https?://patch-diff\.githubusercontent\.com/raw/(.+)/(.+)/pull/(.+)\.(?:diff|patch)})
@ -95,7 +94,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
[{ message: "Use a commit hash URL rather than patch-diff: #{patch_url}", [{ message: "Use a commit hash URL rather than patch-diff: #{patch_url}",
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 5, column: 4,
source: source }] source: source }]
elsif patch_url.match?(%r{https?://github\.com/.+/.+/(?:commit|pull)/[a-fA-F0-9]*.(?:patch|diff)}) elsif patch_url.match?(%r{https?://github\.com/.+/.+/(?:commit|pull)/[a-fA-F0-9]*.(?:patch|diff)})
[{ message: [{ message:
@ -105,10 +104,10 @@ describe RuboCop::Cop::FormulaAudit::Patches do
EOS EOS
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 5, column: 4,
source: source }] source: source }]
end end
expected_offense.zip([cop.offenses.last]).each do |expected, actual| expected_offense.zip([inspect_source(source).last]).each do |expected, actual|
expect(actual.message).to eq(expected[:message]) expect(actual.message).to eq(expected[:message])
expect(actual.severity).to eq(expected[:severity]) expect(actual.severity).to eq(expected[:severity])
expect(actual.line).to eq(expected[:line]) expect(actual.line).to eq(expected[:line])
@ -117,7 +116,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
end end
end end
it "Formula with nested `def patches`" do it "reports an offense with nested `def patches`" do
source = <<~RUBY source = <<~RUBY
class Foo < Formula class Foo < Formula
homepage "ftp://brew.sh/foo" homepage "ftp://brew.sh/foo"
@ -144,12 +143,10 @@ describe RuboCop::Cop::FormulaAudit::Patches do
EOS EOS
severity: :convention, severity: :convention,
line: 8, line: 8,
column: 26, column: 25,
source: source }] source: source }]
inspect_source(source) expected_offenses.zip(inspect_source(source)).each do |expected, actual|
expected_offenses.zip(cop.offenses).each do |expected, actual|
expect(actual.message).to eq(expected[:message]) expect(actual.message).to eq(expected[:message])
expect(actual.severity).to eq(expected[:severity]) expect(actual.severity).to eq(expected[:severity])
expect(actual.line).to eq(expected[:line]) expect(actual.line).to eq(expected[:line])
@ -206,7 +203,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
end end
context "When auditing external patches" do context "When auditing external patches" do
it "Patch URLs" do it "reports an offense for various patch URLs" do
patch_urls = [ patch_urls = [
"https://raw.github.com/mogaal/sendemail", "https://raw.github.com/mogaal/sendemail",
"https://mirrors.ustc.edu.cn/macports/trunk/", "https://mirrors.ustc.edu.cn/macports/trunk/",
@ -230,7 +227,6 @@ describe RuboCop::Cop::FormulaAudit::Patches do
end end
RUBY RUBY
inspect_source(source)
expected_offense = if patch_url.include?("/raw.github.com/") expected_offense = if patch_url.include?("/raw.github.com/")
[{ message: [{ message:
<<~EOS.chomp, <<~EOS.chomp,
@ -239,7 +235,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
EOS EOS
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 16, column: 8,
source: source }] source: source }]
elsif patch_url.include?("macports/trunk") elsif patch_url.include?("macports/trunk")
[{ message: [{ message:
@ -249,7 +245,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
EOS EOS
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 37, column: 8,
source: source }] source: source }]
elsif patch_url.start_with?("http://trac.macports.org") elsif patch_url.start_with?("http://trac.macports.org")
[{ message: [{ message:
@ -259,7 +255,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
EOS EOS
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 9, column: 8,
source: source }] source: source }]
elsif patch_url.start_with?("http://bugs.debian.org") elsif patch_url.start_with?("http://bugs.debian.org")
[{ message: [{ message:
@ -269,19 +265,19 @@ describe RuboCop::Cop::FormulaAudit::Patches do
EOS EOS
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 9, column: 8,
source: source }] source: source }]
elsif patch_url.match?(%r{https://github.com/[^/]*/[^/]*/pull}) elsif patch_url.match?(%r{https://github.com/[^/]*/[^/]*/pull})
[{ message: "Use a commit hash URL rather than an unstable pull request URL: #{patch_url}", [{ message: "Use a commit hash URL rather than an unstable pull request URL: #{patch_url}",
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 9, column: 8,
source: source }] source: source }]
elsif patch_url.match?(%r{.*gitlab.*/merge_request.*}) elsif patch_url.match?(%r{.*gitlab.*/merge_request.*})
[{ message: "Use a commit hash URL rather than an unstable merge request URL: #{patch_url}", [{ message: "Use a commit hash URL rather than an unstable merge request URL: #{patch_url}",
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 9, column: 8,
source: source }] source: source }]
elsif patch_url.match?(%r{https://github.com/[^/]*/[^/]*/commit/}) elsif patch_url.match?(%r{https://github.com/[^/]*/[^/]*/commit/})
[{ message: [{ message:
@ -291,7 +287,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
EOS EOS
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 9, column: 8,
source: source }] source: source }]
elsif patch_url.match?(%r{.*gitlab.*/commit/}) elsif patch_url.match?(%r{.*gitlab.*/commit/})
[{ message: [{ message:
@ -301,7 +297,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
EOS EOS
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 9, column: 8,
source: source }] source: source }]
# rubocop:disable Layout/LineLength # rubocop:disable Layout/LineLength
elsif patch_url.match?(%r{https?://patch-diff\.githubusercontent\.com/raw/(.+)/(.+)/pull/(.+)\.(?:diff|patch)}) elsif patch_url.match?(%r{https?://patch-diff\.githubusercontent\.com/raw/(.+)/(.+)/pull/(.+)\.(?:diff|patch)})
@ -309,10 +305,10 @@ describe RuboCop::Cop::FormulaAudit::Patches do
[{ message: "Use a commit hash URL rather than patch-diff: #{patch_url}", [{ message: "Use a commit hash URL rather than patch-diff: #{patch_url}",
severity: :convention, severity: :convention,
line: 5, line: 5,
column: 9, column: 8,
source: source }] source: source }]
end end
expected_offense.zip([cop.offenses.last]).each do |expected, actual| expected_offense.zip([inspect_source(source).last]).each do |expected, actual|
expect(actual.message).to eq(expected[:message]) expect(actual.message).to eq(expected[:message])
expect(actual.severity).to eq(expected[:severity]) expect(actual.severity).to eq(expected[:severity])
expect(actual.line).to eq(expected[:line]) expect(actual.line).to eq(expected[:line])