Support autocorrection for Naming/InclusiveLanguage

This PR makes `Naming/InclusiveLanguage` support autocorrection
when there is only one suggestion.
When there are multiple suggestions, the best suggestion cannot be
identified and will not be autocorrected.

changelog/new_support_autocorrection_for_naming_inclusive_language.md

@@ -0,0 +1 @@
+* [#11703](https://github.com/rubocop/rubocop/pull/11703): Make `Naming/InclusiveLanguage` support autocorrection when there is only one suggestion. ([@koic][])

config/default.yml

@@ -2779,7 +2779,7 @@ Naming/InclusiveLanguage:
   Description: 'Recommend the use of inclusive language instead of problematic terms.'
   Enabled: false
   VersionAdded: '1.18'
-  VersionChanged: '1.21'
+  VersionChanged: '<<next>>'
   CheckIdentifiers: true
   CheckConstants: true
   CheckVariables: true

lib/rubocop/cop/naming/inclusive_language.rb

@@ -22,6 +22,9 @@ module Naming
       # `WholeWord: true` can be set on a flagged term to indicate the cop should only match when
       # a term matches the whole word (partial matches will not be offenses).
       #
+      # The cop supports autocorrection when there is only one suggestion. When there are multiple
+      # suggestions, the best suggestion cannot be identified and will not be autocorrected.
+      #
       # @example FlaggedTerms: { whitelist: { Suggestions: ['allowlist'] } }
       #   # Suggest replacing identifier whitelist with allowlist
       #
@@ -68,6 +71,7 @@ module Naming
       #   TeslaVehicle
       class InclusiveLanguage < Base
         include RangeHelp
+        extend AutoCorrector
 
         EMPTY_ARRAY = [].freeze
         MSG = "Consider replacing '%<term>s'%<suffix>s."
@@ -104,9 +108,16 @@ def investigate_tokens
 
         def add_offenses_for_token(token, word_locations)
           word_locations.each do |word_location|
-            start_position = token.pos.begin_pos + token.pos.source.index(word_location.word)
-            range = range_between(start_position, start_position + word_location.word.length)
-            add_offense(range, message: create_message(word_location.word))
+            word = word_location.word
+            range = offense_range(token, word)
+
+            add_offense(range, message: create_message(word)) do |corrector|
+              suggestions = find_flagged_term(word)['Suggestions']
+
+              next unless suggestions.is_a?(String)
+
+              corrector.replace(range, suggestions)
+            end
           end
         end
 
@@ -264,6 +275,12 @@ def format_suggestions(suggestions)
                            end
           " with #{suggestion_str}"
         end
+
+        def offense_range(token, word)
+          start_position = token.pos.begin_pos + token.pos.source.index(word)
+
+          range_between(start_position, start_position + word.length)
+        end
       end
     end
   end

spec/rubocop/cop/naming/inclusive_language_spec.rb

@@ -11,6 +11,8 @@
         whitelist = %w(user1 user2)
         ^^^^^^^^^ Consider replacing 'whitelist' with another term.
       RUBY
+
+      expect_no_corrections
     end
 
     it 'registers an offense when using a flagged term with mixed case' do
@@ -19,6 +21,8 @@ class WhiteList
               ^^^^^^^^^ Consider replacing 'WhiteList' with another term.
         end
       RUBY
+
+      expect_no_corrections
     end
 
     it 'registers an offense for a partial word match' do
@@ -27,6 +31,8 @@ class Nodewhitelist
                   ^^^^^^^^^ Consider replacing 'whitelist' with another term.
         end
       RUBY
+
+      expect_no_corrections
     end
 
     context 'disable default flagged term' do
@@ -39,6 +45,8 @@ class Nodewhitelist
           # working on replacing whitelist and blacklist
                                                ^^^^^^^^^ Consider replacing 'blacklist' with another term.
         RUBY
+
+        expect_no_corrections
       end
     end
 
@@ -56,6 +64,8 @@ class Nodewhitelist
                   ^^^^^ Consider replacing 'slave' with 'replica', 'secondary', or 'follower'.
           ^^^^^^ Consider replacing 'master' with 'main', 'primary', or 'leader'.
         RUBY
+
+        expect_no_corrections
       end
     end
 
@@ -69,6 +79,8 @@ class Nodewhitelist
           # white-list of IPs
             ^^^^^^^^^^ Consider replacing 'white-list' with another term.
         RUBY
+
+        expect_no_corrections
       end
     end
 
@@ -98,6 +110,8 @@ class Nodewhitelist
           'database@slave'
                     ^^^^^ Consider replacing 'slave' with another term.
         RUBY
+
+        expect_no_corrections
       end
     end
   end
@@ -128,6 +142,8 @@ class Nodewhitelist
           barx, foo = method_call
                 ^^^ Consider replacing 'foo' with another term.
         RUBY
+
+        expect_no_corrections
       end
     end
   end
@@ -145,6 +161,10 @@ class Nodewhitelist
           whitelist = %w(user1 user2)
           ^^^^^^^^^ Consider replacing 'whitelist' with 'allowlist'.
         RUBY
+
+        expect_correction(<<~RUBY)
+          allowlist = %w(user1 user2)
+        RUBY
       end
     end
 
@@ -160,6 +180,8 @@ class Nodewhitelist
           whitelist = %w(user1 user2)
           ^^^^^^^^^ Consider replacing 'whitelist' with 'allowlist' or 'permit'.
         RUBY
+
+        expect_no_corrections
       end
     end
 
@@ -178,6 +200,8 @@ class Nodewhitelist
           default_branch = 'master'
                             ^^^^^^ Consider replacing 'master' with 'main', 'primary', or 'leader'.
         RUBY
+
+        expect_no_corrections
       end
     end
   end
@@ -195,6 +219,8 @@ class Nodewhitelist
           whitelist = %w(user1 user2)
           ^^^^^^^^^ Consider replacing 'whitelist' with another term.
         RUBY
+
+        expect_no_corrections
       end
     end
 
@@ -222,20 +248,26 @@ class Nodewhitelist
           @whitelist = %w(user1 user2)
            ^^^^^^^^^ Consider replacing 'whitelist' with another term.
         RUBY
+
+        expect_no_corrections
       end
 
       it 'registers offenses for class variables' do
         expect_offense(<<~RUBY)
           @@whitelist = %w(user1 user2)
             ^^^^^^^^^ Consider replacing 'whitelist' with another term.
         RUBY
+
+        expect_no_corrections
       end
 
       it 'registers offenses for global variables' do
         expect_offense(<<~RUBY)
           $whitelist = %w(user1 user2)
            ^^^^^^^^^ Consider replacing 'whitelist' with another term.
         RUBY
+
+        expect_no_corrections
       end
     end
 
@@ -263,6 +295,8 @@ class Nodewhitelist
           WHITELIST = %w(user1 user2)
           ^^^^^^^^^ Consider replacing 'WHITELIST' with another term.
         RUBY
+
+        expect_no_corrections
       end
     end
 
@@ -300,6 +334,8 @@ class Nodewhitelist
           primary
           secondary"
       RUBY
+
+      expect_no_corrections
     end
 
     it 'registers an offense in a heredoc' do
@@ -313,6 +349,8 @@ class Nodewhitelist
           secondary
         TEXT
       RUBY
+
+      expect_no_corrections
     end
 
     it 'does not register offenses and not raise `ArgumentError` for invalid byte sequence in UTF-8' do
@@ -345,6 +383,8 @@ class Nodewhitelist
           config[:master] = {}
                   ^^^^^^ Consider replacing 'master' with another term.
         RUBY
+
+        expect_no_corrections
       end
     end
 
@@ -372,6 +412,8 @@ class Nodewhitelist
         bar = baz # it's a foo!
                            ^^^ Consider replacing 'foo' with another term.
       RUBY
+
+      expect_no_corrections
     end
 
     it 'registers an offense in a block comment' do
@@ -382,6 +424,8 @@ class Nodewhitelist
         bar
         =end
       RUBY
+
+      expect_no_corrections
     end
 
     context 'when CheckComments is false' do