[Fix #9160] Fix an incorrect auto-correct for `Style/SoleNestedCondit…

…ional` Fixes #9160. This PR fixes an incorrect auto-correct for `Style/IfUnlessModifier` and `Style/SoleNestedConditional` when auto-correction conflicts for guard condition.
rubocop · Dec 9, 2020 · fe46341 · fe46341
1 parent 1386f77
commit fe46341
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 10 deletions.
diff --git a/changelog/fix_an_incorrect_autocorrect_for_sole_nested_conditional.md b/changelog/fix_an_incorrect_autocorrect_for_sole_nested_conditional.md
@@ -0,0 +1 @@
+* [#9160](https://github.com/rubocop-hq/rubocop/issues/9160): Fix an incorrect auto-correct for `Style/IfUnlessModifier` and `Style/SoleNestedConditional` when auto-correction conflicts for guard condition. ([@koic][])
diff --git a/lib/rubocop/cop/style/if_unless_modifier.rb b/lib/rubocop/cop/style/if_unless_modifier.rb
@@ -46,6 +46,10 @@ class IfUnlessModifier < Base
         MSG_USE_NORMAL =
           'Modifier form of `%<keyword>s` makes the line too long.'
 
+        def self.autocorrect_incompatible_with
+          [Style::SoleNestedConditional]
+        end
+
         def on_if(node)
           msg = if single_line_as_modifier?(node) && !named_capture_in_condition?(node)
                   MSG_USE_MODIFIER

diff --git a/lib/rubocop/cop/style/sole_nested_conditional.rb b/lib/rubocop/cop/style/sole_nested_conditional.rb
@@ -75,9 +75,8 @@ def autocorrect(corrector, node, if_branch)
             correct_for_guard_condition_style(corrector, node, if_branch, and_operator)
           else
             correct_for_basic_condition_style(corrector, node, if_branch, and_operator)
+            correct_for_comment(corrector, node, if_branch)
           end
-
-          correct_for_comment(corrector, node, if_branch)
         end
 
         def correct_for_guard_condition_style(corrector, node, if_branch, and_operator)
@@ -99,6 +98,8 @@ def correct_for_basic_condition_style(corrector, node, if_branch, and_operator)
         end
 
         def correct_for_comment(corrector, node, if_branch)
+          return if config.for_cop('Style/IfUnlessModifier')['Enabled']
+
           comments = processed_source.comments_before_line(if_branch.source_range.line)
           comment_text = comments.map(&:text).join("\n") << "\n"
 

diff --git a/spec/rubocop/cli/cli_autocorrect_spec.rb b/spec/rubocop/cli/cli_autocorrect_spec.rb
@@ -197,6 +197,30 @@ def batch
     RUBY
   end
 
+  it 'corrects `Style/IfUnlessModifier` with `Style/SoleNestedConditional`' do
+    source = <<~RUBY
+      def foo
+        # NOTE: comment
+        if a? && b?
+          puts "looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong message" unless c?
+        end
+      end
+    RUBY
+    create_file('example.rb', source)
+    expect(cli.run([
+                     '--auto-correct-all',
+                     '--only', 'Style/IfUnlessModifier,Style/SoleNestedConditional'
+                   ])).to eq(0)
+    expect(IO.read('example.rb')).to eq(<<~RUBY)
+      def foo
+        # NOTE: comment
+        if a? && b? && !c?
+            puts "looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong message"
+          end
+      end
+    RUBY
+  end
+
   describe 'trailing comma cops' do
     let(:source) do
       <<~RUBY

diff --git a/spec/rubocop/cop/style/sole_nested_conditional_spec.rb b/spec/rubocop/cop/style/sole_nested_conditional_spec.rb
@@ -198,22 +198,45 @@
     RUBY
   end
 
-  it 'registers an offense and corrects when using nested conditional and branch contains a comment' do
+  context 'when disabling `Style/IfUnlessModifier`' do
+    let(:config) do
+      RuboCop::Config.new('Style/IfUnlessModifier' => { 'Enabled' => false })
+    end
+
+    it 'registers an offense and corrects when using nested conditional and branch contains a comment' do
+      expect_offense(<<~RUBY)
+        if foo
+          # Comment.
+          if bar
+          ^^ Consider merging nested conditions into outer `if` conditions.
+            do_something
+          end
+        end
+      RUBY
+
+      expect_correction(<<~RUBY)
+        # Comment.
+        if foo && bar
+            do_something
+          end
+      RUBY
+    end
+  end
+
+  it 'registers an offense and corrects when using guard conditional with outer comment' do
     expect_offense(<<~RUBY)
+      # Comment.
       if foo
-        # Comment.
-        if bar
-        ^^ Consider merging nested conditions into outer `if` conditions.
-          do_something
-        end
+        do_something if bar
+                     ^^ Consider merging nested conditions into outer `if` conditions.
       end
     RUBY
 
     expect_correction(<<~RUBY)
       # Comment.
       if foo && bar
-          do_something
-        end
+        do_something
+      end
     RUBY
   end