[Fix #9500] Update Lint/Debugger so that only specific receivers for debug methods lead to offenses
#9504
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
…vers for debug methods lead to offenses. Prior to rubocop#8929, `Lint/Debugger` looked for a specific receiver/method pair, but that PR changed it so that any of the `DebuggerReceivers` would apply, *or also* no receiver. This caused regressions (rubocop#7636 and rubocop#9500, for instance) because method names specified as debugger by this cop would now register offenses when called with no receiver. In order to fix it, I changed the configuration for `Lint/Debugger` a bit, but in a way that should not cause any major incompatibility. The allow list is now specified including its receiver so that the receiver can be checked. Existing configurations that just pass in a method name will be treated as expecting no receiver (there's a slight incompatibility there because previously `foo` would be matched by `Kernel.foo` but I think this is ok (and is resolvable by adding `Kernel.foo` to the configuration). I've also grouped the debugger methods by source (it's often confusing to me where each method comes from), which also allows an end-user to disable a pre-defined group of methods by specifying `Byebug: ~` for example. Finally I've deprecated the `DebuggerReceivers` configuration as it is no longer useful.
dvandersluis
commented
Feb 10, 2021
Comment on lines
-164
to
-168
| it 'reports an offense for save_and_open_page with Kernel' do | ||
| expect_offense(<<~RUBY) | ||
| Kernel.save_and_open_page | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^ Remove debugger entry point `Kernel.save_and_open_page`. | ||
| RUBY |
There was a problem hiding this comment.
This test was discussed in #8929 as being there because it was not possible to exclude it in the way the cop was changed, but capybara does not actually add the method to Kernel so it's a false positive that I've now removed.
dvandersluis
commented
Feb 10, 2021
| - Kernel | ||
| - Pry | ||
| VersionChanged: <<next>> | ||
| DebuggerReceivers: [] # deprecated |
There was a problem hiding this comment.
I didn't want users to get error messages about an invalid configuration (in case they've set this) so I've added it to the obsoletion config (with warning severity) but kept the configuration.
|
Fantastic work! Quite the improvement over the previous configuration setup of the cop. |
8 tasks
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.
Prior to #8929,
Lint/Debuggerlooked for a specific receiver/method pair, but that PR changed it so that any of theDebuggerReceiverswould apply, or also no receiver. This caused regressions (#7636 and #9500, for instance) because method names specified as debugger by this cop would now register offenses when called with no receiver.In order to fix it, I changed the configuration for
Lint/Debuggera bit, but in a way that should not cause any major incompatibility. The allow list is now specified including its receiver so that the receiver can be checked. Existing configurations that just pass in a method name will be treated as expecting no receiver (there's a slight incompatibility there because previouslyfoowould be matched byKernel.foobut I think this is ok (and is resolvable by addingKernel.footo the configuration).I've also grouped the debugger methods by source (it's often confusing to me where each method comes from), which also allows an end-user to disable a pre-defined group of methods by specifying
Byebug: ~for example.Finally I've deprecated the
DebuggerReceiversconfiguration as it is no longer useful.Fixes #9500.
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).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.