io.codemodder.codemods.SimplifyRestControllerAnnotationsCodemod Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-codemods Show documentation
Codemods for fixing common errors across many Java projects
There is a newer version: 0.97.3
package io.codemodder.codemods;

import static io.codemodder.ast.ASTTransforms.addImportIfMissing;
import static io.codemodder.ast.ASTTransforms.removeImportIfUnused;

import com.github.javaparser.ast.CompilationUnit;
import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
import com.github.javaparser.ast.body.MethodDeclaration;
import com.github.javaparser.ast.expr.AnnotationExpr;
import com.github.javaparser.ast.expr.MarkerAnnotationExpr;
import io.codemodder.*;
import io.codemodder.codetf.DetectorRule;
import io.codemodder.javaparser.ChangesResult;
import io.codemodder.providers.sonar.ProvidedSonarScan;
import io.codemodder.providers.sonar.RuleIssue;
import io.codemodder.providers.sonar.SonarPluginJavaParserChanger;
import io.codemodder.sonar.model.Issue;
import java.util.List;
import java.util.Optional;
import javax.inject.Inject;

/**
 * A codemod to replace `@Controller` with `@RestController` and remove `@ResponseBody` annotations
 */
@Codemod(
    id = "sonar:java/simplify-rest-controller-annotations-s6833",
    importance = Importance.LOW,
    reviewGuidance = ReviewGuidance.MERGE_WITHOUT_REVIEW,
    executionPriority = CodemodExecutionPriority.HIGH)
public final class SimplifyRestControllerAnnotationsCodemod
    extends SonarPluginJavaParserChanger {

  @Inject
  public SimplifyRestControllerAnnotationsCodemod(
      @ProvidedSonarScan(ruleId = "java:S6833") final RuleIssue issues) {
    super(issues, ClassOrInterfaceDeclaration.class);
  }

  @Override
  public ChangesResult onFindingFound(
      final CodemodInvocationContext context,
      final CompilationUnit cu,
      final ClassOrInterfaceDeclaration classOrInterfaceDeclaration,
      final Issue issue) {

    final Optional controllerAnnotationOptional =
        classOrInterfaceDeclaration.getAnnotationByName("Controller");

    if (controllerAnnotationOptional.isEmpty()) {
      return ChangesResult.noChanges;
    }

    replaceControllerToRestControllerAnnotation(cu, controllerAnnotationOptional.get());

    final Optional responseBodyClassAnnotationOptional =
        classOrInterfaceDeclaration.getAnnotationByName("ResponseBody");

    responseBodyClassAnnotationOptional.ifPresent(AnnotationExpr::remove);

    removeResponseBodyAnnotationFromClassMethods(classOrInterfaceDeclaration);

    removeImportIfUnused(cu, "org.springframework.web.bind.annotation.ResponseBody");

    return ChangesResult.changesApplied;
  }

  private void replaceControllerToRestControllerAnnotation(
      final CompilationUnit cu, final AnnotationExpr controllerAnnotation) {
    final AnnotationExpr restControllerAnnotation = new MarkerAnnotationExpr("RestController");
    controllerAnnotation.replace(restControllerAnnotation);
    removeImportIfUnused(cu, "org.springframework.stereotype.Controller");
    addImportIfMissing(cu, "org.springframework.web.bind.annotation.RestController");
  }

  private void removeResponseBodyAnnotationFromClassMethods(
      final ClassOrInterfaceDeclaration classOrInterfaceDeclaration) {
    final List methods = classOrInterfaceDeclaration.getMethods();
    if (methods != null && !methods.isEmpty()) {
      methods.forEach(
          method -> {
            final Optional responseBodyMethodAnnotationOptional =
                method.getAnnotationByName("ResponseBody");
            responseBodyMethodAnnotationOptional.ifPresent(AnnotationExpr::remove);
          });
    }
  }

  @Override
  public DetectorRule detectorRule() {
    return new DetectorRule(
        "java:S6833",
        "`@Controller` should be replaced with `@RestController`",
        "https://rules.sonarsource.com/java/RSPEC-6833");
  }
}