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

rubocop: Deal with RSpec cop TODOs #14884

Merged
merged 2 commits into from
Mar 6, 2023
Merged

Conversation

issyl0
Copy link
Member

@issyl0 issyl0 commented Mar 4, 2023

  • 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?

  • "Deal with" might be ambitious wording, since I enabled one and disabled two others, but hey!

  • Enable RSpec/MessageSpies with the "receive" style.
    • This matches the code we already have, rather than autocorrecting everything to have_received.
  • Intentionally disable RSpec/{DescribeClass,StubbedMock}
    • These had a lot of offenses that were marked as "try to enable".
    • A lot of the "describe class" ones were for tests for cmds or dev-cmds, brew typecheck or brew --env, and the cop would only pass if I changed these "describe"s to BrewTypecheck or Brew__Env which seemed unhelpful.
    • The usefulness of the stubbed mocks cop is disputed, and fixing the offenses (not autocorrectable) would involve us doing a fair number of changes since changing expect to allow would then force us to make each of the affected tests have expect assertions at the end, where they sometimes don't currently.

- This matches the code we already have, rather than autocorrecting
  everything to `have_received`.
- These had a lot of offenses that were marked as "try to enable".
- A lot of the "describe class" ones were for tests for cmds or dev-cmds,
  `brew typecheck` or `brew --env`, and the cop would only pass if I
  changed these "describe"s to `BrewTypecheck` or `Brew__Env` which
  seemed unhelpful.
- The usefulness of the stubbed mocks cop is
  [disputed](https://github.com/rubocop/rubocop-rspec/issues/ 1271), and
  fixing the offenses (not autocorrectable) would involve us doing a
  fair number of changes since changing `expect` to `allow` would then
  force us to make each of the affected tests have `expect` assertions
  at the end, where they sometimes don't currently.
@BrewTestBot
Copy link
Member

Review period will end on 2023-03-07 at 00:00:00 UTC.

@BrewTestBot BrewTestBot added the waiting for feedback Merging is blocked until sufficient time has passed for review label Mar 4, 2023
@issyl0 issyl0 enabled auto-merge March 6, 2023 08:55
@MikeMcQuaid MikeMcQuaid added the critical Critical change which should be shipped as soon as possible. label Mar 6, 2023
@BrewTestBot BrewTestBot removed the waiting for feedback Merging is blocked until sufficient time has passed for review label Mar 6, 2023
@BrewTestBot
Copy link
Member

Review period skipped due to critical label.

@issyl0 issyl0 merged commit aea3390 into Homebrew:master Mar 6, 2023
@issyl0 issyl0 deleted the rubocop-rspec-todos branch March 6, 2023 12:22
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

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

Makes sense, thanks again @issyl0!

@github-actions github-actions bot added the outdated PR was locked due to age label Apr 6, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 6, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
critical Critical change which should be shipped as soon as possible. outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants