Add new Style/EmptyHeredoc cop
#10820
Merged
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
bbatsov
reviewed
Jul 17, 2022
| include RangeHelp | ||
| extend AutoCorrector | ||
|
|
||
| MSG = "Use `''` instead of heredoc." |
There was a problem hiding this comment.
I guess that will be tied to whether the user selected single or double quoted string literals in their config. You may cheap by saying "an empty string literal".
There was a problem hiding this comment.
Similarly, the autocorrector says corrector.replace(node, "''"). Though maybe the autocorrector will see the '' and swap it for "" because it just inserted a violation of a different rule. I'm not sure how the autocorrector works. Just, the code looks like it'll have the same problem as the MSG did.
There was a problem hiding this comment.
That makes sense, I've updated it:
743f6f7
koic
force-pushed
the
add_new_style_empty_heredoc_cop
branch
2 times, most recently
from
fb0d683
to
718bc35
Compare
## Summary
Checks for using empty heredoc to reduce redundancy.
```ruby
# bad
<<~EOS
EOS
<<-EOS
EOS
<<EOS
EOS
# good
''
# bad
do_something(<<~EOS)
EOS
do_something(<<-EOS)
EOS
do_something(<<EOS)
EOS
# good
do_something('')
```
## Other Information
I noticed the following redundancy in the RuboCop test code:
```ruby
expect_correction(<<~RUBY)
RUBY
```
This cop solves it generically.
koic
force-pushed
the
add_new_style_empty_heredoc_cop
branch
from
718bc35
to
b3ba8a3
Compare
koic
added a commit
that referenced
this pull request
Jul 22, 2022
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.
Summary
Checks for using empty heredoc to reduce redundancy.
Other Information
I noticed the following redundancy in the RuboCop test code:
This cop solves it generically.
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.