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

Add new Rails/WhereEquals cop #362

Merged
merged 1 commit into from
Sep 26, 2020
Merged

Conversation

eugeneius
Copy link
Contributor

This complements the existing Rails/WhereNot cop, so that simple equality and inequality conditions are corrected in the same way.

For example, code like this:

scope :incomplete, -> { where('completed_at IS NULL') }
scope :complete, -> { where('completed_at IS NOT NULL') }

Will now be autocorrected to:

scope :incomplete, -> { where(completed_at: nil) }
scope :complete, -> { where.not(completed_at: nil) }

Instead of:

scope :incomplete, -> { where('completed_at IS NULL') }
scope :complete, -> { where.not(completed_at: nil) }

Before submitting the PR make sure the following are checked:

  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Added an entry to the Changelog if the new code introduces user-observable changes. See changelog entry format.
  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Run bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.
  • If this is a new cop, consider making a corresponding update to the Rails Style Guide.

This complements the existing `Rails/WhereNot` cop, so that simple
equality and inequality conditions are corrected in the same way.

For example, code like this:

    scope :incomplete, -> { where('completed_at IS NULL') }
    scope :complete, -> { where('completed_at IS NOT NULL') }

Will now be autocorrected to:

    scope :incomplete, -> { where(completed_at: nil) }
    scope :complete, -> { where.not(completed_at: nil) }

Instead of:

    scope :incomplete, -> { where('completed_at IS NULL') }
    scope :complete, -> { where.not(completed_at: nil) }
@koic koic merged commit 41cacfb into rubocop:master Sep 26, 2020
@koic
Copy link
Member

koic commented Sep 26, 2020

Thanks!

@mobilutz
Copy link
Contributor

mobilutz commented Dec 9, 2020

Thanks for this cop.

I do have one suggestion. How about also adding possibility to convert a table_name reference into hash condition?

Post.where('posts.title = ?', 'Test')

Right now is is being flagged and mentioned to us:

Post.where('posts.title' => 'Test')

But it would be better to have:

Post.where(posts: { title: 'Test' })

PS: The example is not really good, as you don't really need the posts table reference in the where condition.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants