Support auto-correction comments at rubocop v1.26.0

Refs: rubocop/rubocop#10414
ryz310 · Mar 10, 2022 · 8753cf8 · 8753cf8
1 parent a919b7d
commit 8753cf8
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 22 deletions.
diff --git a/lib/rubocop_challenger/rubocop/rule.rb b/lib/rubocop_challenger/rubocop/rule.rb
@@ -27,7 +27,8 @@ def <=>(other)
       end
 
       def auto_correctable?
-        contents.include?('# Cop supports --auto-correct')
+        contents.include?('# Cop supports --auto-correct') || # for rubocop < v1.26.0
+          contents.match?(/# This cop supports (un)?safe auto-correction/) # for rubocop >= v1.26.0
       end
 
       def rubydoc_url

diff --git a/spec/fixtures/.expected_rubocop_todo.yml b/spec/fixtures/.expected_rubocop_todo.yml
@@ -17,13 +17,13 @@ Style/Documentation:
     - 'lib/rubocop_challenger/rubocop/todo_reader.rb'
 
 # Offense count: 2
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
 Style/ExpandPathArguments:
   Exclude:
     - 'rubocop_challenger.gemspec'
 
 # Offense count: 13
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: when_needed, always, never
 Style/FrozenStringLiteralComment:

diff --git a/spec/fixtures/.rubocop_todo.yml b/spec/fixtures/.rubocop_todo.yml
@@ -7,7 +7,7 @@
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: empty_lines, no_empty_lines
 Layout/EmptyLinesAroundBlockBody:
@@ -25,13 +25,13 @@ Style/Documentation:
     - 'lib/rubocop_challenger/rubocop/todo_reader.rb'
 
 # Offense count: 2
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
 Style/ExpandPathArguments:
   Exclude:
     - 'rubocop_challenger.gemspec'
 
 # Offense count: 13
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: when_needed, always, never
 Style/FrozenStringLiteralComment:

diff --git a/spec/lib/rubocop_challenger/github/pr_template_spec.rb b/spec/lib/rubocop_challenger/github/pr_template_spec.rb
@@ -8,7 +8,7 @@
 
     let(:rule) { RubocopChallenger::Rubocop::Rule.new(<<~CONTENTS) }
       # Offense count: 2
-      # Cop supports --auto-correct.
+      # This cop supports safe auto-correction (--auto-correct).
       Style/Alias:
         Enabled: false
     CONTENTS

diff --git a/spec/lib/rubocop_challenger/rubocop/rule_spec.rb b/spec/lib/rubocop_challenger/rubocop/rule_spec.rb
@@ -19,7 +19,7 @@
   describe '#offense_count' do
     let(:rule) { described_class.new(<<~CONTENTS) }
       # Offense count: 27
-      # Cop supports --auto-correct.
+      # This cop supports safe auto-correction (--auto-correct).
       # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
       # SupportedStyles: single_quotes, double_quotes
       Style/StringLiterals:
@@ -59,7 +59,7 @@
 
     let(:rule) { described_class.new(<<~CONTENTS) }
       # Offense count: 2
-      # Cop supports --auto-correct.
+      # This cop supports safe auto-correction (--auto-correct).
       # Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
       # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
       Style/HashSyntax:
@@ -70,7 +70,7 @@
     context 'when the rule title is same to other one' do
       let(:other) { described_class.new(<<~CONTENTS) }
         # Offense count: 1
-        # Cop supports --auto-correct.
+        # This cop supports safe auto-correction (--auto-correct).
         Style/HashSyntax:
           Exclude:
             - 'rubocop_challenger.gemspec'
@@ -82,7 +82,7 @@
     context 'when the rule title is different to other one' do
       let(:other) { described_class.new(<<~CONTENTS) }
         # Offense count: 1
-        # Cop supports --auto-correct.
+        # This cop supports safe auto-correction (--auto-correct).
         Layout/LeadingBlankLines:
           Exclude:
             - 'rubocop_challenger.gemspec'
@@ -97,7 +97,7 @@
 
     let(:rule) { described_class.new(<<~CONTENTS) }
       # Offense count: 2
-      # Cop supports --auto-correct.
+      # This cop supports safe auto-correction (--auto-correct).
       # Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
       # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
       Style/HashSyntax:
@@ -108,7 +108,7 @@
     context 'when the rule offense count greater than other one' do
       let(:other) { described_class.new(<<~CONTENTS) }
         # Offense count: 1
-        # Cop supports --auto-correct.
+        # This cop supports safe auto-correction (--auto-correct).
         Layout/LeadingBlankLines:
           Exclude:
             - 'rubocop_challenger.gemspec'
@@ -120,7 +120,7 @@
     context 'when the rule offense count is equal to other one' do
       let(:other) { described_class.new(<<~CONTENTS) }
         # Offense count: 2
-        # Cop supports --auto-correct.
+        # This cop supports safe auto-correction (--auto-correct).
         Style/ExpandPathArguments:
           Exclude:
             - 'rubocop_challenger.gemspec'
@@ -146,7 +146,7 @@
   describe '#auto_correctable?' do
     subject { rule.auto_correctable? }
 
-    context 'when the rule supports auto correct' do
+    context 'with auto-correction comment: Cop supports --auto-correct' do
       let(:rule) { described_class.new(<<~CONTENTS) }
         # Offense count: 1
         # Cop supports --auto-correct.
@@ -158,7 +158,31 @@
       it { is_expected.to be_truthy }
     end
 
-    context 'when the rule does not support auto correct' do
+    context 'with auto-correction comment: This cop supports safe auto-correction' do
+      let(:rule) { described_class.new(<<~CONTENTS) }
+        # Offense count: 1
+        # This cop supports safe auto-correction (--auto-correct).
+        Performance/StringReplacement:
+          Exclude:
+            - 'lib/rubocop_challenger.rb'
+      CONTENTS
+
+      it { is_expected.to be_truthy }
+    end
+
+    context 'with auto-correction comment: This cop supports unsafe auto-correction' do
+      let(:rule) { described_class.new(<<~CONTENTS) }
+        # Offense count: 1
+        # This cop supports unsafe auto-correction (--auto-correct-all).
+        Performance/StringReplacement:
+          Exclude:
+            - 'lib/rubocop_challenger.rb'
+      CONTENTS
+
+      it { is_expected.to be_truthy }
+    end
+
+    context 'without auto-correction comment' do
       let(:rule) { described_class.new(<<~CONTENTS) }
         # Offense count: 1
         Metrics/AbcSize:
@@ -173,7 +197,7 @@
     context 'when the rule is included in the rubocop gem' do
       let(:rule) { described_class.new(<<~CONTENTS) }
         # Offense count: 1
-        # Cop supports --auto-correct.
+        # This cop supports safe auto-correction (--auto-correct).
         Style/RedundantSelf:
           Exclude:
             - 'lib/rubocop_challenger/rubocop/rule.rb'
@@ -188,7 +212,7 @@
     context 'when the rule is included in the rubocop-rspec gem' do
       let(:rule) { described_class.new(<<~CONTENTS) }
         # Offense count: 1
-        # Cop supports --auto-correct.
+        # This cop supports safe auto-correction (--auto-correct).
         # Configuration parameters: CustomTransform, IgnoredWords.
         RSpec/ExampleWording:
           Exclude:

diff --git a/spec/lib/rubocop_challenger/rubocop/todo_reader_spec.rb b/spec/lib/rubocop_challenger/rubocop/todo_reader_spec.rb
@@ -8,7 +8,7 @@
   let(:autocorrectable_rule_which_offence_count_is_1) do
     RubocopChallenger::Rubocop::Rule.new(<<~CONTENTS)
       # Offense count: 1
-      # Cop supports --auto-correct.
+      # This cop supports safe auto-correction (--auto-correct).
       # Configuration parameters: EnforcedStyle.
       # SupportedStyles: empty_lines, no_empty_lines
       Layout/EmptyLinesAroundBlockBody:
@@ -20,7 +20,7 @@
   let(:autocorrectable_rule_which_offence_count_is_2) do
     RubocopChallenger::Rubocop::Rule.new(<<~CONTENTS)
       # Offense count: 2
-      # Cop supports --auto-correct.
+      # This cop supports safe auto-correction (--auto-correct).
       Style/ExpandPathArguments:
         Exclude:
           - 'rubocop_challenger.gemspec'
@@ -30,7 +30,7 @@
   let(:autocorrectable_rule_which_offence_count_is_13) do
     RubocopChallenger::Rubocop::Rule.new(<<~CONTENTS)
       # Offense count: 13
-      # Cop supports --auto-correct.
+      # This cop supports safe auto-correction (--auto-correct).
       # Configuration parameters: EnforcedStyle.
       # SupportedStyles: when_needed, always, never
       Style/FrozenStringLiteralComment:

diff --git a/spec/lib/rubocop_challenger/rubocop/todo_writer_spec.rb b/spec/lib/rubocop_challenger/rubocop/todo_writer_spec.rb
@@ -11,7 +11,7 @@
     let(:expected) { File.read('spec/fixtures/.expected_rubocop_todo.yml') }
     let(:rule) { RubocopChallenger::Rubocop::Rule.new(<<~CONTENTS) }
       # Offense count: 1
-      # Cop supports --auto-correct.
+      # This cop supports safe auto-correction (--auto-correct).
       # Configuration parameters: EnforcedStyle.
       # SupportedStyles: empty_lines, no_empty_lines
       Layout/EmptyLinesAroundBlockBody: