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

[Fix #10622] Fix a false positive for Style/RaiseArgs #10623

Merged

Conversation

koic
Copy link
Member

@koic koic commented May 11, 2022

Fixes #10622.

This PR fixes a false positive for Style/RaiseArgs when error type class constructor with keyword arguments and message argument.

The signature of raise is below.

raise
raise(string, cause: $!)
raise(exception [, string [, array]], cause: $!)

https://ruby-doc.org/core-3.1.0/Kernel.html#method-i-raise

So #10622 would be a false positive because raise MyError.new(data: 'mydata'), 'message' and raise MyError.new('message', data: 'mydata') are incompatible.


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.

@koic koic force-pushed the fix_a_false_positive_for_style_raise_args branch from ca2421e to 2110edf Compare May 11, 2022 15:30
Fixes rubocop#10622.

This PR fixes a false positive for `Style/RaiseArgs` when
error type class constructor with keyword arguments and message argument.

The signature of `raise` is below.

```ruby
raise
raise(string, cause: $!)
raise(exception [, string [, array]], cause: $!)
```

https://ruby-doc.org/core-3.1.0/Kernel.html#method-i-raise

So rubocop#10622 would be a false positive because `raise MyError.new(data: 'mydata'), 'message'` and
`raise MyError.new('message', data: 'mydata')` are incompatible.
@koic koic force-pushed the fix_a_false_positive_for_style_raise_args branch from 2110edf to 83cd538 Compare May 11, 2022 15:31
@bbatsov bbatsov merged commit b0eb6d7 into rubocop:master May 12, 2022
@bbatsov
Copy link
Collaborator

bbatsov commented May 12, 2022

Thanks!

@koic koic deleted the fix_a_false_positive_for_style_raise_args branch May 12, 2022 12:18
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.

Style/RaiseArgs autocorrection removes part of code with compact style
2 participants