io.codemodder.codemods.RemoveUnusedLocalVariableCodemod 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
The newest version!
package io.codemodder.codemods;

import com.github.javaparser.ast.CompilationUnit;
import com.github.javaparser.ast.Node;
import com.github.javaparser.ast.NodeList;
import com.github.javaparser.ast.body.VariableDeclarator;
import com.github.javaparser.ast.expr.*;
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.Optional;
import java.util.stream.Collectors;
import javax.inject.Inject;

/**
 * Codemod to remove unused local variables which expression is a variable or just a Literal
 * expression like a single boolean, char, double, integer, long, null, string or a text block
 * string. We are not considering create object expression, method call expressions, condition
 * expressions, etc. because all of them have an expression node and that expression node could
 * result in a method call expression where a process could be performed and deleting it could
 * result on some unexpected behaviors.
 */
@Codemod(
    id = "sonar:java/remove-unused-local-variable-s1481",
    reviewGuidance = ReviewGuidance.MERGE_WITHOUT_REVIEW,
    importance = Importance.LOW,
    executionPriority = CodemodExecutionPriority.HIGH)
public final class RemoveUnusedLocalVariableCodemod
    extends SonarPluginJavaParserChanger {

  @Inject
  public RemoveUnusedLocalVariableCodemod(
      @ProvidedSonarScan(ruleId = "java:S1481") final RuleIssue issues) {
    super(issues, VariableDeclarator.class);
  }

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

    final Optional initializer = variableDeclarator.getInitializer();

    if (initializer.isPresent()) {
      final Expression initializerExpr = initializer.get();

      if (initializerExpr instanceof LiteralExpr || initializerExpr instanceof NameExpr) {
        final Optional variableDeclarationExprOptional = variableDeclarator.getParentNode();

        if (variableDeclarationExprOptional.isPresent()) {
          final VariableDeclarationExpr variableDeclarationExpr =
              (VariableDeclarationExpr) variableDeclarationExprOptional.get();

          if (1 == variableDeclarationExpr.getVariables().size()) {
            variableDeclarationExpr.removeForced();
          } else {
            final NodeList variables =
                variableDeclarationExpr.getVariables().stream()
                    .filter(variable -> !variable.equals(variableDeclarator))
                    .collect(Collectors.toCollection(NodeList::new));
            variableDeclarationExpr.setVariables(variables);
          }

          return ChangesResult.changesApplied;
        }
      }
    }

    return ChangesResult.noChanges;
  }

  @Override
  public DetectorRule detectorRule() {
    return new DetectorRule(
        "java:S1481",
        "Unused local variables should be removed",
        "https://rules.sonarsource.com/java/RSPEC-1481");
  }
}