[Fix rubocop#240] Disable Performance/Casecmp cop

This cop suggests an incorrect fix when code involves non-ASCII characters. Disabling it by default makes this risky behavior opt-in rather than opt-out.
parkerfinch · May 5, 2021 · 2c2c218 · 2c2c218
1 parent 1db41d7
commit 2c2c218
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## master (unreleased)
 
+### Changes
+
+* [#240](https://github.com/rubocop/rubocop-performance/issues/240): Retire `Performance/Casecmp` cop
+
 ## 1.11.2 (2021-05-05)
 
 ### Bug fixes

diff --git a/config/default.yml b/config/default.yml
@@ -52,7 +52,7 @@ Performance/Casecmp:
   Description: >-
              Use `casecmp` rather than `downcase ==`, `upcase ==`, `== downcase`, or `== upcase`..
   Reference: 'https://github.com/JuanitoFatas/fast-ruby#stringcasecmp-vs-stringdowncase---code'
-  Enabled: true
+  Enabled: false
   Safe: false
   VersionAdded: '0.36'
 

diff --git a/docs/modules/ROOT/pages/cops_performance.adoc b/docs/modules/ROOT/pages/cops_performance.adoc
@@ -283,7 +283,7 @@ end
 |===
 | Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
 
-| Enabled
+| Disabled
 | No
 | Yes (Unsafe)
 | 0.36
@@ -292,8 +292,12 @@ end
 
 This cop identifies places where a case-insensitive string comparison
 can better be implemented using `casecmp`.
-This cop is unsafe because `String#casecmp` and `String#casecmp?` behave
-differently when using Non-ASCII characters.
+
+This cop is disabled by default because `String#casecmp` only works with
+ASCII characters. See https://github.com/rubocop/rubocop/issues/9753.
+
+If you are working only with ASCII characters, then this cop can be
+safely enabled.
 
 === Examples
 

diff --git a/lib/rubocop/cop/performance/casecmp.rb b/lib/rubocop/cop/performance/casecmp.rb
@@ -5,8 +5,12 @@ module Cop
     module Performance
       # This cop identifies places where a case-insensitive string comparison
       # can better be implemented using `casecmp`.
-      # This cop is unsafe because `String#casecmp` and `String#casecmp?` behave
-      # differently when using Non-ASCII characters.
+      #
+      # This cop is disabled by default because `String#casecmp` only works with
+      # ASCII characters. See https://github.com/rubocop/rubocop/issues/9753.
+      #
+      # If you are working only with ASCII characters, then this cop can be
+      # safely enabled.
       #
       # @example
       #   # bad