Add new Style/RedundantHeredocDelimiterQuotes cop
#11528
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
Feb 1, 2023
| # no string interpolation style text | ||
| # EOS | ||
| # | ||
| # # good |
There was a problem hiding this comment.
Probably you should also add a good example for 'EOS', so it's a bit clearer when it should be used.
There was a problem hiding this comment.
Certainly! I added some examples for that.
Follow up rubocop#11522 (comment). This cop checks for redundant heredoc delimiter quotes. ```ruby # bad do_something(<<~'EOS') no string interpolation style text EOS # good do_something(<<~EOS) no string interpolation style text EOS ```
koic
force-pushed
the
add_new_style_redundant_heredoc_delimiter_quotes_cop
branch
from
0e97dc5
to
f3d4931
Compare
|
Pretty useful cop! Thanks! |
koic
added a commit
to rubocop/rubocop-rails
that referenced
this pull request
Feb 1, 2023
Follow up rubocop/rubocop#11528. This commit suppresses the following new `Style/RedundantHeredocDelimiterQuotes` cop's offenses: ```console % bundle exec rake (snip) Offenses: spec/rubocop/cop/rails/helper_instance_variable_spec.rb:31:24: C: [Correctable] Style/RedundantHeredocDelimiterQuotes: Remove the redundant heredoc delimiter quotes, use <<~RUBY instead. expect_no_offenses(<<~'RUBY') ^^^^^^^^^ spec/rubocop/cop/rails/helper_instance_variable_spec.rb:39:24: C: [Correctable] Style/RedundantHeredocDelimiterQuotes: Remove the redundant heredoc delimiter quotes, use <<~RUBY instead. expect_no_offenses(<<~'RUBY') ^^^^^^^^^ spec/rubocop/cop/rails/helper_instance_variable_spec.rb:50:24: C: [Correctable] Style/RedundantHeredocDelimiterQuotes: Remove the redundant heredoc delimiter quotes, use <<~RUBY instead. expect_no_offenses(<<~'RUBY') ^^^^^^^^^ spec/rubocop/cop/rails/helper_instance_variable_spec.rb:61:20: C: [Correctable] Style/RedundantHeredocDelimiterQuotes: Remove the redundant heredoc delimiter quotes, use <<~RUBY instead. expect_offense(<<~'RUBY') ^^^^^^^^^ spec/rubocop/cop/rails/match_route_spec.rb:110:24: C: [Correctable] Style/RedundantHeredocDelimiterQuotes: Remove the redundant heredoc delimiter quotes, use <<~RUBY instead. expect_no_offenses(<<~'RUBY') ^^^^^^^^^ spec/rubocop/cop/rails/reflection_class_name_spec.rb:57:24: C: [Correctable] Style/RedundantHeredocDelimiterQuotes: Remove the redundant heredoc delimiter quotes, use <<~RUBY instead. expect_no_offenses(<<~'RUBY') ^^^^^^^^^ spec/rubocop/cop/rails/reflection_class_name_spec.rb:63:24: C: [Correctable] Style/RedundantHeredocDelimiterQuotes: Remove the redundant heredoc delimiter quotes, use <<~RUBY instead. expect_no_offenses(<<~'RUBY') ^^^^^^^^^ spec/rubocop/cop/rails/root_pathname_methods_spec.rb:123:22: C: [Correctable] Style/RedundantHeredocDelimiterQuotes: Remove the redundant heredoc delimiter quotes, use <<~RUBY instead. expect_offense(<<~'RUBY') ^^^^^^^^^ 279 files inspected, 8 offenses detected, 8 offenses autocorrectable ```
koic
added a commit
to rubocop/rubocop-minitest
that referenced
this pull request
Feb 1, 2023
Follow up rubocop/rubocop#11528. This commit suppresses the following new `Style/RedundantHeredocDelimiterQuotes` cop's offenses: ```console % bundle exec rake (snip) Offenses: test/rubocop/cop/minitest/assert_with_expected_argument_test.rb:82:24: C: [Correctable] Style/RedundantHeredocDelimiterQuotes: Remove the redundant heredoc delimiter quotes, use <<~RUBY instead. assert_no_offenses(<<~'RUBY') ^^^^^^^^^ 121 files inspected, 1 offense detected, 1 offense autocorrectable RuboCop failed! ```
7 tasks
splattael
reviewed
Feb 6, 2023
| extend AutoCorrector | ||
|
|
||
| MSG = 'Remove the redundant heredoc delimiter quotes, use `%<replacement>s` instead.' | ||
| STRING_INTERPOLATION_OR_ESCAPED_CHARACTER_PATTERN = /#(\{|@|\$)|\\/.freeze |
kachick
added a commit
to kachick/ruby-ulid
that referenced
this pull request
Feb 8, 2023
|
@koic thanks! Since we picked up this release through Dependabot, I check the docs to find more info but I didn't see the rule there. I realize now that 1.45 isn't published on docs.rubocop.org where this was included. Only 1.44 is available. |
|
@javierjulio The 1.45 doc is published. Thank you! |
|
My bad. As the process is manual and I constantly switch between computers from time to time I forget to do it when I release from the "wrong" computer (the one where I haven't setup Antora locally yet). |
|
On the bright side - this finally motivated me to setup Node.js and Antora on my laptop as well. 😄 |
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.
Follow up #11522 (comment).
This cop checks for redundant heredoc delimiter quotes.
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.