Merge pull request #11347 from koic/fix_false_positive_style_redundan…

…t_string_escape [Fix #11346] Fix a false positive for `Style/RedundantStringEscape`
rubocop · Dec 30, 2022 · 908eda0 · 908eda0
2 parents aaa4166 + 7cdede1
commit 908eda0
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/changelog/fix_false_positive_style_redundant_string_escape.md b/changelog/fix_false_positive_style_redundant_string_escape.md
@@ -0,0 +1 @@
+* [#11346](https://github.com/rubocop/rubocop/issues/11346): Fix a false positive for `Style/RedundantStringEscape` when using escaped space in heredoc. ([@koic][])
diff --git a/lib/rubocop/cop/style/redundant_string_escape.rb b/lib/rubocop/cop/style/redundant_string_escape.rb
@@ -76,6 +76,7 @@ def begin_loc_present?(node)
           node.loc.to_hash.key?(:begin) && !node.loc.begin.nil?
         end
 
+        # rubocop:disable Metrics/CyclomaticComplexity
         def allowed_escape?(node, range)
           escaped = range.source[(1..-1)]
 
@@ -88,13 +89,14 @@ def allowed_escape?(node, range)
           # with different versions of Ruby so that e.g. /\d/ != /d/
           return true if /[\n\\[[:alnum:]]]/.match?(escaped[0])
 
-          return true if escaped[0] == ' ' && percent_array_literal?(node)
+          return true if escaped[0] == ' ' && (percent_array_literal?(node) || node.heredoc?)
 
           return true if disabling_interpolation?(range)
           return true if delimiter?(node, escaped[0])
 
           false
         end
+        # rubocop:enable Metrics/CyclomaticComplexity
 
         def interpolation_not_enabled?(node)
           single_quoted?(node) ||

diff --git a/spec/rubocop/cop/style/redundant_string_escape_spec.rb b/spec/rubocop/cop/style/redundant_string_escape_spec.rb
@@ -417,6 +417,14 @@ def wrap(contents)
         MYHEREDOC
       RUBY
     end
+
+    it 'does register an offense an escaped space' do
+      expect_no_offenses(<<~'RUBY')
+        <<~MYHEREDOC
+          \ text
+        MYHEREDOC
+      RUBY
+    end
   end
 
   context 'with an interpolation-disabled HEREDOC' do