Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rubocops/lines: require a comment for skip_clean #18002

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions Library/Homebrew/rubocops/lines.rb
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,28 @@ def audit_formula(_formula_nodes)
end
end

# Ensure every `skip_clean` is documented with a comment.
class SkipCleanCommented < FormulaCop
sig { override.params(formula_nodes: FormulaNodes).void }
def audit_formula(formula_nodes)
return if formula_tap != "homebrew-core"
return if (body_node = formula_nodes.body_node).nil?

# Some formulae call `skip_clean` multiple times, only require a
# comment on the first
method = find_every_method_call_by_name(body_node, :skip_clean).first
return if method.nil?

method_comment = processed_source.comments.find do |comment|
(method.loc.line - comment.loc.line).abs <= 1
end
return unless method_comment.nil?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit, unless nil confuses me :-)

Suggested change
return unless method_comment.nil?
return if method_comment.present?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or

Suggested change
return unless method_comment.nil?
return if !method_comment.nil?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer the prior or the existing version to the second.


offending_node(method)
problem "Formulae in homebrew/core should document why `skip_clean` is needed with a comment."
end
end

# This cop makes sure that idiomatic `assert_*` statements are used.
class AssertStatements < FormulaCop
sig { override.params(formula_nodes: FormulaNodes).void }
Expand Down
69 changes: 69 additions & 0 deletions Library/Homebrew/test/rubocops/text/skip_clean_commented_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# frozen_string_literal: true

require "rubocops/lines"

RSpec.describe RuboCop::Cop::FormulaAudit::SkipCleanCommented do
subject(:cop) { described_class.new }

context "when auditing formulae in homebrew-core" do
it "reports an offense when skip_clean does not have a comment" do
expect_offense(<<~RUBY, "/homebrew-core/")
class Foo < Formula
url 'https://brew.sh/foo-1.0.tgz'

skip_clean "bin"
^^^^^^^^^^^^^^^^ FormulaAudit/SkipCleanCommented: Formulae in homebrew/core should document why `skip_clean` is needed with a comment.
end
RUBY
end

it "reports a single offense for multiple skip_clean lines" do
expect_offense(<<~RUBY, "/homebrew-core/")
class Foo < Formula
url 'https://brew.sh/foo-1.0.tgz'

skip_clean "bin"
^^^^^^^^^^^^^^^^ FormulaAudit/SkipCleanCommented: Formulae in homebrew/core should document why `skip_clean` is needed with a comment.
skip_clean "libexec/bin"
end
RUBY
end

it "does not report an offense for a comment" do
expect_no_offenses(<<~RUBY, "/homebrew-core/")
class Foo < Formula
# some reason
skip_clean "bin"
end
RUBY
end

it "does not report an offense for an inline comment" do
expect_no_offenses(<<~RUBY, "/homebrew-core/")
class Foo < Formula
skip_clean "bin" # some reason
end
RUBY
end

it "does not report an offense for a comment above multiple skip_clean lines" do
expect_no_offenses(<<~RUBY, "/homebrew-core/")
class Foo < Formula
# some reason
skip_clean "bin"
skip_clean "libexec/bin"
end
RUBY
end
end

context "when auditing formulae not in homebrew-core" do
it "does not report an offense" do
expect_no_offenses(<<~RUBY)
class Foo < Formula
skip_clean "bin"
end
RUBY
end
end
end
Loading