rubocops/text: improve test descriptions

[SeekingMeaning]

• Have you followed the guidelines in our Contributing document?
• Have you checked to ensure there aren't other open Pull Requests for the same change?
• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your changes? Here's an example.
• Have you successfully run brew style with your changes locally?
• Have you successfully run brew typecheck with your changes locally?
• Have you successfully run brew tests with your changes locally?
• Have you successfully run brew man locally and committed any changes?

---

Continuation of #10124

This PR improves the test descriptions of text_spec.rb so that the error messages are more coherent.

Before:
RuboCop::Cop::FormulaAudit::Text When auditing formula text with `require "formula"` is present

After:
RuboCop::Cop::FormulaAudit::Text when auditing formula text reports an offense if `require "formula"` is present

(I'm not sure if my extensive use of single quotes ['] and percent literals [%Q(...)] is recommended; please tell me if it isn't)

[BrewTestBot]

Review period will end on 2021-01-18 at 02:18:16 UTC.

[Rylan12]

Looks good for the most part. Thanks, @SeekingMeaning!

I'm not at all opposed to using single-quotes.

I think the %Q() should be avoided if possible because it's a little less clean (and can be confusing to people who aren't as familiar with ruby). I think all the instances in this PR can be replaced with single-quotes without any issues. I could very well be missing something, though.

[Rylan12]

Does this not work? Single quotes won't do string interpolation

Suggested change

	it %Q(reports an offense if "\#{share}/<formula name>" is present) do
	it 'reports an offense if "#{share}/<formula name>" is present' do

[SeekingMeaning]

That doesn't work as it's seen as broken interpolation, i.e. we have to explicitly escape the #

[Rylan12]

Are you sure? When I test it out in brew irb it seems to work fine...

[Rylan12]

I made a quick test ruby script:

puts 'reports an offense if "#{share}/<formula name>" is present'

And then ran brew ruby test.rb:

$ brew ruby test.rb
reports an offense if "#{share}/<formula name>" is present

[SeekingMeaning]

Sorry I meant that it works, but brew style sees it as "broken"

[SeekingMeaning]

Library/Homebrew/test/rubocops/text_spec.rb:304:8: W: [Correctable] Interpolation in single quoted string detected. Use double quoted strings if you need interpolation.
    it 'reports an offense if "#{share}/<formula name>" is present' do
       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1 file inspected, 1 offense detected, 1 offense auto-correctable

[Rylan12]

Ah, I see. That's interesting... If it were up to me I'd say let's disable that cop and allow it. But I don't feel strongly about that, so I think %Q is fine. Although, if we use %q instead no need to escape the #:

Suggested change

	it %Q(reports an offense if "\#{share}/<formula name>" is present) do
	it %q(reports an offense if "#{share}/<formula name>" is present) do

[SeekingMeaning]

Same error:

Library/Homebrew/test/rubocops/text_spec.rb:304:8: W: [Correctable] Interpolation in single quoted string detected. Use double quoted strings if you need interpolation.
    it %q(reports an offense if "#{share}/<formula name>" is present) do
       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

[Rylan12]

Ah well, that's unfortunate. I agree, then, this is the best option.

[BrewTestBot]

Review period ended.