Add new Rails/RedundantForeignKey cop #257
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
[Fix #issue-number]
(if the related issue exists).master
(if not - rebase it).and description in grammatically correct, complete sentences.
bundle exec rake default
. It executes all tests and RuboCop for itself, and generates the documentation.