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.

Sign up for GitHub

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

Jump to bottom

Add new `RSpec/BeNil` cop #1239

Merged

pirj merged 1 commit into master from add-be-nil-cop

Feb 24, 2022

Collaborator

bquorning commented Feb 23, 2022 •

edited

Loading

Check that be_nil is used instead of be(nil).

RSpec has a built-in be_nil matcher specifically for expecting nil. For consistent specs, we recommend using that instead of be(nil).

Partially fixes #244.

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 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 in default/config.yml to the next minor version.

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

Set VersionChanged in config/default.yml to the next major version.


          Add new RSpec/BeNil cop

d636fc7

Check that `be_nil` is used instead of `be(nil)`.

RSpec has a built-in `be_nil` matcher specifically for expecting `nil`.
For consistent specs, we recommend using that instead of `be(nil).

bquorning mentioned this pull request

Identity comparison vs. value comparison #244

Closed

bquorning marked this pull request as ready for review

February 23, 2022 21:49

bquorning requested review from Darhazer and pirj

February 23, 2022 21:49

Darhazer approved these changes

View reviewed changes

pirj approved these changes

View reviewed changes

Member

pirj left a comment

Looks good, thank you!

pirj merged commit 0a1a7b9 into master

pirj deleted the add-be-nil-cop branch

February 24, 2022 20:29

Contributor

marcandre commented Mar 15, 2022

Note that it's not 100% safe.

expect(OpenStruct.new(nil?: true)).to be_nil # => pass
expect(OpenStruct.new(nil?: true)).to be nil # => fail

More importantly, I see absolutely no reason to prefer be_nil to be nil. The later is stricter, simpler and requires less knowledge of rspec.

bquorning mentioned this pull request

Prefer be_nil over be nil #693

Closed

Member

pirj commented Mar 15, 2022

We couldn't figure out a real example.

Collaborator Author

bquorning commented Mar 15, 2022

I see absolutely no reason to prefer be_nil to be nil. The later is stricter, simpler and requires less knowledge of rspec.

Well, that is true 😅 Should we consider making the cop configurable to users can enforce either one style or the other?

bquorning added a commit that referenced this pull request


          Make RSpec/BeNil cop configurable

1d2a16f

Make `RSpec/BeNil` cop configurable with a `be_nil` and a `be` style.

Inspired by @marcandre's comment at
#1239 (comment)

    I see absolutely no reason to prefer `be_nil` to `be nil`. The
    latter is stricter, simpler and requires less knowledge of rspec.

bquorning added a commit that referenced this pull request


          Make RSpec/BeNil cop configurable

6ab94a1

Make `RSpec/BeNil` cop configurable with a `be_nil` and a `be` style.

Inspired by @marcandre's comment at
#1239 (comment)

    I see absolutely no reason to prefer `be_nil` to `be nil`. The
    latter is stricter, simpler and requires less knowledge of rspec.

bquorning added a commit that referenced this pull request


          Make RSpec/BeNil cop configurable

b2ed73a

Make `RSpec/BeNil` cop configurable with a `be_nil` and a `be` style.

Inspired by @marcandre's comment at
#1239 (comment)

    I see absolutely no reason to prefer `be_nil` to `be nil`. The
    latter is stricter, simpler and requires less knowledge of rspec.

bquorning mentioned this pull request

Make RSpec/BeNil cop configurable #1251

Merged

7 tasks

bquorning added a commit that referenced this pull request


          Make RSpec/BeNil cop configurable

c6f95bc

Make `RSpec/BeNil` cop configurable with a `be_nil` and a `be` style.

Inspired by @marcandre's comment at
#1239 (comment)

    I see absolutely no reason to prefer `be_nil` to `be nil`. The
    latter is stricter, simpler and requires less knowledge of rspec.

bquorning added a commit that referenced this pull request


          Make RSpec/BeNil cop configurable

01ae44a

Make `RSpec/BeNil` cop configurable with a `be_nil` and a `be` style.

Inspired by @marcandre's comment at
#1239 (comment)

    I see absolutely no reason to prefer `be_nil` to `be nil`. The
    latter is stricter, simpler and requires less knowledge of rspec.

bquorning added a commit that referenced this pull request


          Make RSpec/BeNil cop configurable

2044a57

Make `RSpec/BeNil` cop configurable with a `be_nil` and a `be` style.

Inspired by @marcandre's comment at
#1239 (comment)

    I see absolutely no reason to prefer `be_nil` to `be nil`. The
    latter is stricter, simpler and requires less knowledge of rspec.

bquorning added a commit that referenced this pull request


          Make RSpec/BeNil cop configurable

56d8950

Make `RSpec/BeNil` cop configurable with a `be_nil` and a `be` style.

Inspired by @marcandre's comment at
#1239 (comment)

    I see absolutely no reason to prefer `be_nil` to `be nil`. The
    latter is stricter, simpler and requires less knowledge of rspec.

bquorning added a commit that referenced this pull request


          Make RSpec/BeNil cop configurable

Make `RSpec/BeNil` cop configurable with a `be_nil` and a `be` style.

Inspired by @marcandre's comment at
#1239 (comment)

    I see absolutely no reason to prefer `be_nil` to `be nil`. The
    latter is stricter, simpler and requires less knowledge of rspec.

pirj pushed a commit to rubocop/rubocop-capybara that referenced this pull request


          Make RSpec/BeNil cop configurable

b4985aa

Make `RSpec/BeNil` cop configurable with a `be_nil` and a `be` style.

Inspired by @marcandre's comment at
rubocop/rubocop-rspec#1239 (comment)

    I see absolutely no reason to prefer `be_nil` to `be nil`. The
    latter is stricter, simpler and requires less knowledge of rspec.

ydah pushed a commit to rubocop/rubocop-factory_bot that referenced this pull request


          Make RSpec/BeNil cop configurable

afb39e6

Make `RSpec/BeNil` cop configurable with a `be_nil` and a `be` style.

Inspired by @marcandre's comment at
rubocop/rubocop-rspec#1239 (comment)

    I see absolutely no reason to prefer `be_nil` to `be nil`. The
    latter is stricter, simpler and requires less knowledge of rspec.

ydah pushed a commit to rubocop/rubocop-rspec_rails that referenced this pull request


          Make RSpec/BeNil cop configurable

4ab12b0

Make `RSpec/BeNil` cop configurable with a `be_nil` and a `be` style.

Inspired by @marcandre's comment at
rubocop/rubocop-rspec#1239 (comment)

    I see absolutely no reason to prefer `be_nil` to `be nil`. The
    latter is stricter, simpler and requires less knowledge of rspec.

ydah pushed a commit to rubocop/rubocop-rspec_rails that referenced this pull request


          Make RSpec/BeNil cop configurable

7b3c4af

Make `RSpec/BeNil` cop configurable with a `be_nil` and a `be` style.

Inspired by @marcandre's comment at
rubocop/rubocop-rspec#1239 (comment)

    I see absolutely no reason to prefer `be_nil` to `be nil`. The
    latter is stricter, simpler and requires less knowledge of rspec.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet