[Fix #49] Introduce RescueFromExceptionsVariableName cop
#139
Conversation
This file contains hidden or 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
Follows rubocop/rubocop#7122 Closes rubocop#49 Inspired from @pocke [refactoring][1] in the `Naming/RescuedExceptionsVariableName` cop, this PR handle the `rescue_from` Rails version. Obstructing points: - As discussed [in this comment][2], the `PreferredName` config should not be duplicated but read from the `Naming/RescuedExceptionsVariableName` cop. How can I read the config from another cop ? Is there already some example of cop working this way ? - I haven't been able to make the parser to not take the `||` of the block arguments which make the offending message being `|my_var|` instead of `my_var`. What is the way to avoid this ? [1]: rubocop/rubocop#7122 [2]: rubocop#49 (comment)
anthony-robin
force-pushed
the
rescued_exception_variable_name
branch
from
96821f8 to
9ee85ae
Compare
pirj
reviewed
Nov 14, 2021
Comment on lines
+9
to
+12
| # The `PreferredName` config option takes a `String`. It represents | ||
| # the required name of the variable. Its default is `e` that is read | ||
| # from `Naming/RescuedExceptionsVariableName` cop in the main Rubocop | ||
| # repository. |
There was a problem hiding this comment.
WDYT of:
The
PreferredNameconfig option sets the preferred name for the exception variable, defaults toe.
Comment on lines
+59
to
+65
| def autocorrect(node) | ||
| lambda do |corrector| | ||
| offending_name = variable_name(node) | ||
| preferred_name = preferred_name(offending_name) | ||
| corrector.replace(offense_range(node), "|#{preferred_name}|") | ||
| end | ||
| end |
There was a problem hiding this comment.
There's a new interface for auto-correction, see https://docs.rubocop.org/rubocop/1.22/development.html#auto-correct
|
|
||
| private | ||
|
|
||
| def offense_range(resbody) |
There was a problem hiding this comment.
It feels like this would better be expressed with node pattern. Do you need any guidance with that?
Docs: https://docs.rubocop.org/rubocop-ast/node_pattern.html
|
@anthony-robin Ping |
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Follows rubocop/rubocop#7122
Closes #49
Inspired from @pocke refactoring in the
Naming/RescuedExceptionsVariableNamecop, this PRhandle the
rescue_fromRails version.Obstructing points:
As discussed in this comment, the
PreferredNameconfig should not be duplicated but read from theNaming/RescuedExceptionsVariableNamecop.How can I read the config from another cop ? Is there already some example of cop working this way ?
I haven't been able to make the parser to not take the
||of the block arguments which make the offending message being|my_var|instead ofmy_var.What is the way to avoid this ?
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.