[Fix rubocop#365] Mark Rails/SquishedSQLHeredocs unsafe for autocor…

…rection Closes rubocop#365
tejasbubane · Nov 24, 2020 · 95306d1 · 95306d1
1 parent 9808efd
commit 95306d1
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,7 @@
 ### Changes
 
 * [#383](https://github.com/rubocop-hq/rubocop-rails/pull/383): Require RuboCop 0.90 or higher. ([@koic][])
+* [#365](https://github.com/rubocop-hq/rubocop-rails/issues/365): Mark `Rails/SquishedSQLHeredocs` unsafe for autocorrection. ([@tejasbubane][])
 
 ## 2.8.1 (2020-09-16)
 

diff --git a/config/default.yml b/config/default.yml
@@ -668,6 +668,10 @@ Rails/SquishedSQLHeredocs:
   StyleGuide: 'https://rails.rubystyle.guide/#squished-heredocs'
   Enabled: 'pending'
   VersionAdded: '2.8'
+  VersionChanged: '2.9'
+  # Some SQL syntax (e.g. PostgreSQL comments and functions) requires newlines
+  # to be preserved in order to work, thus auto-correction is not safe.
+  SafeAutoCorrect: false
 
 Rails/TimeZone:
   Description: 'Checks the correct usage of time zone aware methods.'

diff --git a/docs/modules/ROOT/pages/cops_rails.adoc b/docs/modules/ROOT/pages/cops_rails.adoc
@@ -4056,12 +4056,14 @@ user.touch
 
 | Pending
 | Yes
-| Yes
+| Yes (Unsafe)
 | 2.8
-| -
+| 2.9
 |===
 
 Checks SQL heredocs to use `.squish`.
+Some SQL syntax (e.g. PostgreSQL comments and functions) requires newlines
+to be preserved in order to work, thus auto-correction for this cop is not safe.
 
 === Examples
 

diff --git a/lib/rubocop/cop/rails/squished_sql_heredocs.rb b/lib/rubocop/cop/rails/squished_sql_heredocs.rb
@@ -5,6 +5,8 @@ module Cop
     module Rails
       #
       # Checks SQL heredocs to use `.squish`.
+      # Some SQL syntax (e.g. PostgreSQL comments and functions) requires newlines
+      # to be preserved in order to work, thus auto-correction for this cop is not safe.
       #
       # @example
       #   # bad