Add a new cop RSpec/Output

[kevinrobell-st]

• Closes New cop to disallow printing from tests #2128

This is based on the Rails/Output cop with three minor changes.

1. Autocorrection is removed as the expectation is that the print statement will be removed by the user.
2. The message is changed.
3. The cop runs only on spec files.

---

Before submitting the PR make sure the following are checked:

• Feature branch is up-to-date with master (if not - rebase it).
• Squashed related commits together.
• Added tests.
• Updated documentation.
• Added an entry to the CHANGELOG.md if the new code introduces user-observable changes.
• The build (bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).

If you have created a new cop:

• Added the new cop to config/default.yml.
• The cop is configured as Enabled: pending in config/default.yml.
• The cop is configured as Enabled: true in .rubocop.yml.
• The cop documents examples of good and bad code.
• The tests assert both that bad code is reported and that good code is not reported.
• Set VersionAdded: "<<next>>" in default/config.yml.

If you have modified an existing cop's configuration options:

• Set VersionChanged: "<<next>>" in config/default.yml.

[kevinrobell-st]

RSpec/Output was chosen as the cop name to align with Rails/Output but potentially it'd be better to have more descriptive name here.

[kevinrobell-st]

I did some grepping around the real-world-rspec repo as well and I think this cop should be fine to add. There are some legitimate uses of printing in some integration tests, some examples of print statements that look like they were leftover from debugging and print statements in setup, helper and support logic. By making the cop enabled: pending for now we don't have to confront those changes immediately but there might come a time in the future were we decide to exclude more subdirectories or files from this cop or even mark it as enabled: false if there are too many false positives. I still think that it has value as a cop though because generally printing in specs is not expected.

• New cop to disallow printing from tests #2128 (comment)

[kevinrobell-st]

This is succeeding for me locally with no file changes. I wonder why.

• https://github.com/rubocop/rubocop-rspec/actions/runs/19120657194/job/54741707842?pr=2129

[ydah]

Could you please squashed related commits into one?

[r7kamura]

I agree with adding this cop with Enabled: pending, as there should be sufficiently beneficial use cases.

Also, I believe the cop name RSpec/Output is appropriate. It should be easily understood by users, especially since there is already a well-known cop named Rails/Output.

As I commented inline in the code, I believe that contextual autocorrect is preferable, but this is a point where opinions may differ. What does everyone else think?

[kevinrobell-st]

In general, I like the idea of adding autocorrect and I didn't realize how simple it would be to add. It might be better to make it an unsafe autocorrect though since there are some legitimate but rare use cases for printing in integration specs.

[kevinrobell-st]

I've updated the code to address comments and add unsafe autocorrect. The autocorrect specs look a bit weird because they're just blank lines but it does show that things are working correctly. Let me know if there's anything else I should address.

[kevinrobell-st]

Okay, I added a @safety comment and marked the new cop as AutoCorrect: contextual. For some reason, I thought that happened automatically for unsafe cops so that's why I didn't add it before.

[r7kamura]

👍

[bquorning]

Thank you for the contribution!