Merge pull request #153 from koic/mark_string_include_as_unsafe_autoc…

…orrect

[Fix #145] Mark `Performance/StringInclude` as unsafe

CHANGELOG.md

@@ -10,6 +10,7 @@
 ### Changes
 
 * [#149](https://github.com/rubocop-hq/rubocop-performance/pull/149): Mark `Performance/AncestorsInclude` as unsafe. ([@eugeneius][])
+* [#145](https://github.com/rubocop-hq/rubocop-performance/issues/145): Mark `Performance/StringInclude` as `SafeAutocorrect: false` and disable autocorrect by default. ([@koic][])
 
 ## 1.7.0 (2020-07-07)
 

config/default.yml

@@ -248,6 +248,8 @@ Performance/StartWith:
 Performance/StringInclude:
   Description: 'Use `String#include?` instead of a regex match with literal-only pattern.'
   Enabled: 'pending'
+  AutoCorrect: false
+  SafeAutoCorrect: false
   VersionAdded: '1.7'
 
 Performance/StringReplacement:

docs/modules/ROOT/pages/cops_performance.adoc

@@ -1499,14 +1499,16 @@ for receiver is multiline string.
 
 | Pending
 | Yes
-| Yes
+| Yes (Unsafe)
 | 1.7
 | -
 |===
 
 This cop identifies unnecessary use of a regex where
 `String#include?` would suffice.
 
+This cop's offenses are not safe to auto-correct if a receiver is nil.
+
 === Examples
 
 [source,ruby]
@@ -1523,6 +1525,16 @@ This cop identifies unnecessary use of a regex where
 'abc'.include?('ab')
 ----
 
+=== Configurable attributes
+
+|===
+| Name | Default value | Configurable values
+
+| AutoCorrect
+| `false`
+| Boolean
+|===
+
 == Performance/StringReplacement
 
 |===

lib/rubocop/cop/performance/string_include.rb

@@ -6,6 +6,8 @@ module Performance
       # This cop identifies unnecessary use of a regex where
       # `String#include?` would suffice.
       #
+      # This cop's offenses are not safe to auto-correct if a receiver is nil.
+      #
       # @example
       #   # bad
       #   'abc'.match?(/ab/)