From 279a4df6c3fa41f0b660d67f880ed2bc7c0be848 Mon Sep 17 00:00:00 2001 From: Isabell Long Date: Sat, 27 May 2017 23:17:44 +0100 Subject: [PATCH] Match the "formula name in description" on word boundaries - The regexp for the "check if formula name is used in formula's description" cop matches every instance of the formula name if it exists, whether it's in a word or not. - For example, the formula `mon` has the description "Monitor hosts/services/whatever and alert about problems". This makes `brew audit --strict` complain because it matches "Monitor", which isn't the formula name! The formula `pass` has the description "Password manager". Again, the strict audit matches "Password", which isn't an issue. - Instead, this change matches on a word boundary, so it will match `mon:`, or `mon `, but not "Monitor", or, for example, "harmony". - I've changed the tests to account for this change. --- Library/Homebrew/rubocops/formula_desc_cop.rb | 2 +- Library/Homebrew/test/rubocops/formula_desc_cop_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Library/Homebrew/rubocops/formula_desc_cop.rb b/Library/Homebrew/rubocops/formula_desc_cop.rb index 1fbf1ddbfc..81068ac343 100644 --- a/Library/Homebrew/rubocops/formula_desc_cop.rb +++ b/Library/Homebrew/rubocops/formula_desc_cop.rb @@ -40,7 +40,7 @@ module RuboCop end # Check if formula's name is used in formula's desc - problem "Description shouldn't include the formula name" if regex_match_group(desc, /^#{@formula_name}/i) + problem "Description shouldn't include the formula name" if regex_match_group(desc, /^#{@formula_name}\b/i) end end end diff --git a/Library/Homebrew/test/rubocops/formula_desc_cop_spec.rb b/Library/Homebrew/test/rubocops/formula_desc_cop_spec.rb index 432b15e3c8..bc92291af9 100644 --- a/Library/Homebrew/test/rubocops/formula_desc_cop_spec.rb +++ b/Library/Homebrew/test/rubocops/formula_desc_cop_spec.rb @@ -120,7 +120,7 @@ describe RuboCop::Cop::FormulaAuditStrict::Desc do source = <<-EOS.undent class Foo < Formula url 'http://example.com/foo-1.0.tgz' - desc 'Foo' + desc 'Foo: foobar' end EOS