[Fix #7842] Add AcceptImplicitNamespaces to Lint/RaiseException
#7846
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
koic
force-pushed
the
add_allow_implicit_namespaces_to_lint_raise_exception
branch
from
b7ba87b
to
26c1149
Compare
bbatsov
reviewed
Apr 4, 2020
config/default.yml
Outdated
| @@ -1567,6 +1567,8 @@ Lint/RaiseException: | |||
| StyleGuide: '#raise-exception' | |||
| Enabled: pending | |||
| VersionAdded: '0.81' | |||
| AllowImplicitNamespaces: | |||
There was a problem hiding this comment.
I think this should be named "AllowedImplicitNamespaces".
bbatsov
reviewed
Apr 4, 2020
| @@ -5,33 +5,64 @@ module Cop | |||
| module Lint | |||
| # This cop checks for `raise` or `fail` statements which are | |||
| # raising `Exception` class. | |||
| # You can specify a module name that will be an implicit namespace | |||
There was a problem hiding this comment.
Probably the explanation should be extended to mention the cop normally ignores namespaced "Exception", but might cause false positives if some module has its own Exception class. This would make it easier for people to understand the need for the extra config. That being said - I think it's a very bad idea to name base classes "Exception" and I'd rather name them "(BaseError)" or something along those lines. Hiding built-in constants is a recipe for trouble IMO.
There was a problem hiding this comment.
Thank you for reviewing. I extended the explanation.
koic
force-pushed
the
add_allow_implicit_namespaces_to_lint_raise_exception
branch
from
26c1149
to
5bf74df
Compare
…tion` Fixes rubocop#7842. This PR adds `AcceptImplicitNamespaces` option to `Lint/RaiseException`. Users can specify and accept an implicit namespace as follows: ```yaml Lint/RaiseException: AllowImplicitNamespaces: - 'Gem' ``` ```ruby # good module Gem def self.foo raise Exception end end Gem.foo #=> Gem::Exception ``` `Gem` is specified by default. https://ruby-doc.org/stdlib-2.7.0/libdoc/rubygems/rdoc/Gem/Exception.html This way does not prevent all false positives, but it expect some cases can be solved.
koic
force-pushed
the
add_allow_implicit_namespaces_to_lint_raise_exception
branch
from
5bf74df
to
59e0823
Compare
|
Looks good! |
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.
Fixes #7842.
This PR adds
AcceptImplicitNamespacesoption toLint/RaiseException.Users can specify and accept an implicit namespace as follows:
Gemis specified by default.https://ruby-doc.org/stdlib-2.7.0/libdoc/rubygems/rdoc/Gem/Exception.html
This way does not prevent all false positives, but it expect some cases can be solved.
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 RuboCop for itself, and generates the documentation.