SONARJAVA-6283 S3706 Implement quickfix (#5584)

Author: NoemieBenard

java-checks-test-sources/default/src/main/java/checks/StreamForeachCheck.java

@@ -37,4 +37,17 @@ void sequentialStreamForEach(Collection<String> col) {
     s.forEach(System.out::println); // Compliant (the rule ignores this case)
   }
 
+  // fix@qf1 {{Remove the call to ".stream()"}}
+  // edit@qf1 [[sc=15;ec=24]] {{}}
+  void quickFix(Collection<Integer> collection) {
+    collection.stream().forEach(System.out::println); // Noncompliant [[quickfixes=qf1]]
+    //         ^^^^^^^^^^^^^^^^
+  }
+
+  // fix@qf2 {{Remove the call to ".stream()"}}
+  // edit@qf2 [[sc=8;ec=17]] {{}}
+  void quickFix2(Set<String> set) {
+    set.stream().forEach(e -> System.out.println("Element: " + e)); // Noncompliant [[quickfixes=qf2]]
+  }
+
 }

java-checks/src/main/java/org/sonar/java/checks/StreamForeachCheck.java

@@ -18,11 +18,14 @@
 
 import java.util.List;
 import org.sonar.check.Rule;
+import org.sonar.java.reporting.JavaQuickFix;
+import org.sonar.java.reporting.JavaTextEdit;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.semantic.MethodMatchers;
 import org.sonar.plugins.java.api.tree.MemberSelectExpressionTree;
 import org.sonar.plugins.java.api.tree.MethodInvocationTree;
 import org.sonar.plugins.java.api.tree.Tree;
+import org.sonar.java.checks.helpers.QuickFixHelper;
 
 @Rule(key = "S3706")
 public class StreamForeachCheck extends IssuableSubscriptionVisitor {
@@ -56,7 +59,18 @@ private void checkUnnecessaryForEach(MethodInvocationTree mitForEach) {
       && msetForEach.expression() instanceof MethodInvocationTree mitStream
       && STREAM_METHOD.matches(mitStream)
       && mitStream.methodSelect() instanceof MemberSelectExpressionTree msetStream) {
-      reportIssue(msetStream.identifier(), msetForEach.identifier(), "Simplify the code by replacing .stream().forEach() with .forEach().");
+      QuickFixHelper.newIssue(context)
+        .forRule(this)
+        .onRange(msetStream.identifier(), msetForEach.identifier())
+        .withMessage("Simplify the code by replacing .stream().forEach() with .forEach().")
+        .withQuickFix(() -> computeQuickFix(msetStream, mitStream))
+        .report();
     }
   }
+
+  private static JavaQuickFix computeQuickFix(MemberSelectExpressionTree msetStream, MethodInvocationTree mitStream) {
+    return JavaQuickFix.newQuickFix("Remove the call to \".stream()\"")
+        .addTextEdit(JavaTextEdit.removeBetweenTree(msetStream.operatorToken(), mitStream))
+        .build();
+  }
 }

sonar-java-plugin/src/main/resources/org/sonar/l10n/java/rules/java/S3706.json

@@ -11,5 +11,5 @@
   "ruleSpecification": "RSPEC-3706",
   "sqKey": "S3706",
   "scope": "All",
-  "quickfix": "unknown"
+  "quickfix": "covered"
 }