Merge pull request #12789 from boardfish/redundant-percent-q-multiline

Make Style/RedundantPercentQ handle multiline source safely
rubocop · Mar 15, 2024 · 9dd0792 · 9dd0792
2 parents 66c8276 + 72bea19
commit 9dd0792
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/changelog/fix_make_redundant_percent_q_safe_on_multiline_strings.md b/changelog/fix_make_redundant_percent_q_safe_on_multiline_strings.md
@@ -0,0 +1 @@
+* [#12789](https://github.com/rubocop/rubocop/pull/12789): Make `Style/RedundantPercentQ` safe on multiline strings. ([@boardfish][])
diff --git a/lib/rubocop/cop/style/redundant_percent_q.rb b/lib/rubocop/cop/style/redundant_percent_q.rb
@@ -53,7 +53,7 @@ def check(node)
           return if interpolated_quotes?(node) || allowed_percent_q?(node)
 
           add_offense(node) do |corrector|
-            delimiter = /^%Q[^"]+$|'/.match?(node.source) ? QUOTE : SINGLE_QUOTE
+            delimiter = /\A%Q[^"]+\z|'/.match?(node.source) ? QUOTE : SINGLE_QUOTE
 
             corrector.replace(node.loc.begin, delimiter)
             corrector.replace(node.loc.end, delimiter)

diff --git a/spec/rubocop/cop/style/redundant_percent_q_spec.rb b/spec/rubocop/cop/style/redundant_percent_q_spec.rb
@@ -142,6 +142,21 @@
           'boogers'
       RUBY
     end
+
+    it 'autocorrects safely for multiline strings containing double quotes' do
+      expect_offense(<<~RUBY)
+        %Q(
+        ^^^ Use `%Q` only for strings that contain both single [...]
+          Quoth the Raven "Nevermore."
+        )
+      RUBY
+
+      expect_correction(<<~RUBY)
+        '
+          Quoth the Raven "Nevermore."
+        '
+      RUBY
+    end
   end
 
   it 'accepts a heredoc string that contains %q' do