Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new Lint/ConstantOverwrittenInRescue cop #10722

Merged
merged 1 commit into from Jun 20, 2022

Conversation

ydah
Copy link
Member

@ydah ydah commented Jun 17, 2022

This PR is add a new cop.
Checks for overwriting an exception with an exception result by use rescue =>.

@example

# bad
begin
  something
rescue => StandardError
end

# good
begin
  something
rescue StandardError
end

Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • [-] Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.

@pirj
Copy link
Member

pirj commented Jun 18, 2022

Wow!
Just to show the scale of destruction:

> E=Class.new(StandardError)
> begin; raise E; rescue => E; end

(pry):2: warning: already initialized constant E
(pry):1: warning: previous definition of E was here

> E
#<E: E>

😱

Frankly, it looks like a Ruby bug or a deficiency.

In any case, thanks for the cop! 👏

@bbatsov
Copy link
Collaborator

bbatsov commented Jun 19, 2022

I like the cop, we just need to expand a bit the docs and the examples.

@pirj
Copy link
Member

pirj commented Jun 19, 2022

I'd go with ConstantOverwrittenInRescue for the cop name.

This PR is add a new cop.
Checks for overwriting an exception with an exception result by use `rescue =>`.

You intended to write as `rescue StandardError`.
However, you have written `rescue => StandardError`.
In that case, the result of `rescue` will overwrite `StandardError`.

## @example

```ruby
# bad
begin
  something
rescue => StandardError
end

# good
begin
  something
rescue StandardError
end
```
@ydah
Copy link
Member Author

ydah commented Jun 20, 2022

@pirj Thank you so much.
ConstantOverwrittenInRescue I think it is a good Cop name. I changed the cop name :)

@ydah ydah changed the title Add new Lint/OverwriteByRescue cop Add new Lint/ConstantOverwrittenInRescue cop Jun 20, 2022
@bbatsov bbatsov merged commit 3b12e71 into rubocop:master Jun 20, 2022
@bbatsov
Copy link
Collaborator

bbatsov commented Jun 20, 2022

Looks good. Thanks!

@ydah ydah deleted the add_overwrite_by_rescue branch June 27, 2022 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants