Ignore redirect method for Style/FormatStringToken by default #902
Conversation
config/default.yml
Outdated
| @@ -1143,3 +1143,7 @@ Style/SymbolProc: | |||
| - define_method | |||
| - respond_to | |||
|
|
|||
| Style/FormatStringToken: | |||
There was a problem hiding this comment.
CI is failure:
https://app.circleci.com/pipelines/github/rubocop/rubocop-rails/2228/workflows/066ed396-8ff7-4bb2-af9d-1536fe51f602/jobs/14896
Please move it above Style/SymbolProc setting.
There was a problem hiding this comment.
Thanks! I made that change. I noticed shortly after creating this PR though that the IgnoredMethods key is deprecated and that AllowedMethods is used instead. I updated the config to match what I saw used elsewhere. Let me know if that's ok or if there are more changes needed.
There was a problem hiding this comment.
@koic @javierjulio Why was IgnoredMethods replaced with AllowedMethods? They have opposite meanings, and the documentation is also opposite.
The documentation for IgnoredMethods was:
This module encapsulates the ability to ignore certain methods when parsing
The documentation for AllowedMethods is the opposite:
This module encapsulates the ability to allow certain methods when parsing.
How are these interchangeable?
The implementation of AllowedMethods does the opposite of what the documentation says it does, as it does in fact ignore the method (not allow it). This means that the documentation is wrong, and even if it was fixed, the implied meaning is different form what it does, and that there is no way to actually allow a method, only to disallow (i.e. ignore).
There was a problem hiding this comment.
I went off of other rules listed in the same file that have the same keys and "deprecated" notice. Since they listed both keys with the same list and since there wasn't explicit review follow up, I figured that was the right solution. If it's not though, it should be changed.
There was a problem hiding this comment.
Current behavior is correct, but the documentation confused me.
|
Can you add a changelog entry and squash your commits into one? |
|
@javierjulio ping :-) |
|
@koic thank you for the ping! 🙏🏻 I'm sorry, I didn't get an email notification about your review so I missed it. Let me update this for you. |
javierjulio
changed the title
redirect method for Style/FormatStringToken by default
javierjulio
changed the title
redirect method for Style/FormatStringToken by default
This adds the `redirect` method as a default for the Style/FormatStringToken rule due to the change in rubocop/rubocop#9369 where it was mentioned that it would be added as a default.
|
@koic all set. I added the changelog entry as well. |
|
@javierjulio Great! Thank you! |
|
@koic no, thank you! ❤️ |
This adds the
redirectmethod as a default for the Style/FormatStringToken rule due to the change in rubocop/rubocop#9369 where it was mentioned that it would be added as a default but since it wasn't, I'm contributing the change. I ran into this false positive with a rails route using both rubocop and rubocop-rails. Seems like a good default to have, if still desired.Before submitting the PR make sure the following are checked:
Commit message starts with[Fix #issue-number](if the related issue exists).master(if not - rebase it).Added tests.bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.