Add Rails/UnusedIgnoredColumns cop #494
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pocke
force-pushed
the
Add_Rails_UnusedIgnoredColumns_cop
branch
from
e9c8ae3
to
e4ab457
Compare
pocke
force-pushed
the
Add_Rails_UnusedIgnoredColumns_cop
branch
from
e4ab457
to
91da1b4
Compare
koic
reviewed
May 24, 2021
| class UnusedIgnoredColumns < Base | ||
| include ActiveRecordHelper | ||
|
|
||
| MSG = 'Remove `%<column_name>s` from `ignored_columns` because the column does not exist.' |
There was a problem hiding this comment.
Can you use RESTRICT_ON_SEND = %i[ignored_columns=].freeze?
| end | ||
| RUBY | ||
| end | ||
| end |
There was a problem hiding this comment.
Can you add the test case?
self.ignored_columns = [:real_name, :account]|
|
||
| MSG = 'Remove `%<column_name>s` from `ignored_columns` because the column does not exist.' | ||
|
|
||
| def_node_matcher :ignored_columns?, <<~PATTERN |
There was a problem hiding this comment.
? looks unnecessary because a captured value is returned.
Suggested change
| def_node_matcher :ignored_columns?, <<~PATTERN | |
| def_node_matcher :ignored_columns, <<~PATTERN |
|
Thanks for your review! I'll check them this weekend |
* Use RESTRICT_ON_SEND constant * Drop `?` for the matcher because it returns non-boolean value * Add test case
|
I updated this pull request with your comment. 4cd98d4 Thanks! |
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request adds a new Rails/UnusedIgnoredColumns cop.
The cop detects columns that
ignored_clumnscontains but RDBMS doesn't contain.Background
ignored_columnsis necessary to remove a column. For example:The
ignored_columnsshould be removed after the migration, but sometimes we forget to remove theignored_columns.You can avoid forgetting to remove it by this cop.
I think this cop doesn't need an entry in the Rails Style Guide because it is just a small bug.
This pull request doesn't contain the autocorrect feature to keep the PR small for the first step. We can implement the autocorrect feature for the next step.
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.