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/RedundantForeignKey cop #257

Merged
merged 1 commit into from
Jun 8, 2020

Conversation

eugeneius
Copy link
Contributor

The foreign key for an association can be overridden with the :foreign_key option. This cop detects when the specified value is the same as the default.

Aside from being unnecessary, setting the foreign key prevents the inverse association from being inferred automatically, which can lead to unnecessary queries.

The default foreign key logic implemented here matches what Rails does internally:

https://github.com/rails/rails/blob/95af87f0a4b6274a43853ed68b17e17c21f804f3/activerecord/lib/active_record/reflection.rb#L659-L667

I don't think this warrants an entry in the Rails Style Guide on its own, but a more general section about ensuring associations have inverses that mentions foreign_key as a gotcha might be useful.


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.
  • If this is a new cop, consider making a corresponding update to the Rails Style Guide.
  • 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.

The foreign key for an association can be overridden with the
`:foreign_key` option. This cop detects when the specified value is the
same as the default.

Aside from being unnecessary, setting the foreign key prevents the
inverse association from being inferred automatically, which can lead to
unnecessary queries.
@koic koic merged commit 7f89958 into rubocop:master Jun 8, 2020
@koic
Copy link
Member

koic commented Jun 8, 2020

Thanks!

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.

2 participants