feat(spoon): ✨ Provide a unified api for refactoring a repository wit…

…h code transformations api (#1011)

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/AbstractRefactoring.java → code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/AbstractRefactoring.java

@@ -1,4 +1,4 @@
-package xyz.keksdose.spoon.code_solver.analyzer.qodana.rules;
+package xyz.keksdose.spoon.code_solver.analyzer;
 
 import io.github.martinwitt.laughing_train.domain.entity.AnalyzerResult;
 import java.nio.file.Path;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/QodanaRefactor.java

@@ -11,7 +11,7 @@
 import java.util.function.Consumer;
 import java.util.function.Function;
 import spoon.reflect.declaration.CtType;
-import xyz.keksdose.spoon.code_solver.analyzer.qodana.rules.AbstractRefactoring;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.analyzer.qodana.rules.MethodMayBeStatic;
 import xyz.keksdose.spoon.code_solver.analyzer.qodana.rules.NonProtectedConstructorInAbstractClass;
 import xyz.keksdose.spoon.code_solver.analyzer.qodana.rules.NonStrictComparisonCanBeEquality;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/QodanaRules.java

@@ -4,8 +4,8 @@
 import io.github.martinwitt.laughing_train.domain.value.RuleId;
 import java.util.List;
 import java.util.function.Function;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.analyzer.AnalyzerRule;
-import xyz.keksdose.spoon.code_solver.analyzer.qodana.rules.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.analyzer.qodana.rules.CodeBlock2Expr;
 import xyz.keksdose.spoon.code_solver.analyzer.qodana.rules.InnerClassMayBeStatic;
 import xyz.keksdose.spoon.code_solver.analyzer.qodana.rules.MethodMayBeStatic;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/CodeBlock2Expr.java

@@ -8,6 +8,7 @@
 import spoon.reflect.code.CtLambda;
 import spoon.reflect.code.CtReturn;
 import spoon.reflect.declaration.CtType;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.analyzer.PositionScanner;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/InnerClassMayBeStatic.java

@@ -7,6 +7,7 @@
 import spoon.reflect.declaration.CtElement;
 import spoon.reflect.declaration.CtType;
 import spoon.reflect.declaration.ModifierKind;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.analyzer.PositionScanner;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/MethodMayBeStatic.java

@@ -15,6 +15,7 @@
 import spoon.reflect.reference.CtTypeReference;
 import spoon.reflect.visitor.filter.TypeFilter;
 import spoon.support.reflect.CtExtendedModifier;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 import xyz.keksdose.spoon.code_solver.history.MarkdownString;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/NonProtectedConstructorInAbstractClass.java

@@ -13,6 +13,7 @@
 import spoon.reflect.declaration.ModifierKind;
 import spoon.reflect.visitor.filter.TypeFilter;
 import spoon.support.reflect.CtExtendedModifier;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 import xyz.keksdose.spoon.code_solver.history.MarkdownString;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/NonStrictComparisonCanBeEquality.java

@@ -7,6 +7,7 @@
 import spoon.reflect.code.CtBinaryOperator;
 import spoon.reflect.declaration.CtType;
 import spoon.reflect.visitor.filter.TypeFilter;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 import xyz.keksdose.spoon.code_solver.history.MarkdownString;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/ParameterNameDiffersFromOverriddenParameter.java

@@ -10,6 +10,7 @@
 import spoon.reflect.declaration.CtType;
 import spoon.reflect.reference.CtParameterReference;
 import spoon.reflect.visitor.filter.TypeFilter;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 import xyz.keksdose.spoon.code_solver.history.MarkdownString;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/PointlessBooleanExpression.java

@@ -8,6 +8,7 @@
 import spoon.reflect.code.CtExpression;
 import spoon.reflect.declaration.CtType;
 import spoon.reflect.visitor.filter.TypeFilter;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 import xyz.keksdose.spoon.code_solver.history.MarkdownString;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/ProtectedMemberInFinalClass.java

@@ -11,6 +11,7 @@
 import spoon.reflect.declaration.CtType;
 import spoon.reflect.declaration.CtTypeMember;
 import spoon.reflect.declaration.ModifierKind;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 import xyz.keksdose.spoon.code_solver.history.MarkdownString;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/RedundantArrayCreation.java

@@ -5,6 +5,7 @@
 import java.util.List;
 import spoon.reflect.code.CtNewArray;
 import spoon.reflect.declaration.CtType;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 import xyz.keksdose.spoon.code_solver.history.MarkdownString;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/SizeReplaceableByIsEmpty.java

@@ -13,6 +13,7 @@
 import spoon.reflect.factory.Factory;
 import spoon.reflect.reference.CtExecutableReference;
 import spoon.reflect.visitor.filter.TypeFilter;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 import xyz.keksdose.spoon.code_solver.history.MarkdownString;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/ToArrayCallWithZeroLengthArrayArgument.java

@@ -7,6 +7,7 @@
 import spoon.reflect.code.CtNewArray;
 import spoon.reflect.declaration.CtElement;
 import spoon.reflect.declaration.CtType;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.analyzer.PositionScanner;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/UnnecessaryInterfaceModifier.java

@@ -10,6 +10,7 @@
 import spoon.reflect.declaration.CtTypeMember;
 import spoon.reflect.declaration.ModifierKind;
 import spoon.support.reflect.CtExtendedModifier;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 import xyz.keksdose.spoon.code_solver.history.MarkdownString;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/UnnecessaryLocalVariable.java

@@ -12,6 +12,7 @@
 import spoon.reflect.code.CtVariableRead;
 import spoon.reflect.declaration.CtType;
 import spoon.reflect.visitor.filter.TypeFilter;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 import xyz.keksdose.spoon.code_solver.history.MarkdownString;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/UnnecessaryModifier.java

@@ -7,6 +7,7 @@
 import spoon.reflect.declaration.CtElement;
 import spoon.reflect.declaration.CtModifiable;
 import spoon.reflect.declaration.CtType;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.analyzer.PositionScanner;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/UnnecessaryReturn.java

@@ -6,6 +6,7 @@
 import spoon.reflect.code.CtReturn;
 import spoon.reflect.declaration.CtType;
 import spoon.reflect.visitor.filter.TypeFilter;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 import xyz.keksdose.spoon.code_solver.history.MarkdownString;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/UnnecessaryStringEscape.java

@@ -6,6 +6,7 @@
 import spoon.reflect.code.CtLiteral;
 import spoon.reflect.declaration.CtElement;
 import spoon.reflect.declaration.CtType;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.analyzer.PositionScanner;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/UnnecessaryToStringCall.java

@@ -9,6 +9,7 @@
 import spoon.reflect.code.CtInvocation;
 import spoon.reflect.declaration.CtElement;
 import spoon.reflect.declaration.CtType;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.analyzer.PositionScanner;
 import xyz.keksdose.spoon.code_solver.diffs.DiffCleanModes;
 import xyz.keksdose.spoon.code_solver.history.Change;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/UnusedImport.java

@@ -6,6 +6,7 @@
 import spoon.reflect.declaration.CtImport;
 import spoon.reflect.declaration.CtType;
 import spoon.support.util.ModelList;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 import xyz.keksdose.spoon.code_solver.history.MarkdownString;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/UnusedLabel.java

@@ -7,6 +7,7 @@
 import spoon.reflect.code.CtStatement;
 import spoon.reflect.declaration.CtElement;
 import spoon.reflect.declaration.CtType;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.analyzer.PositionScanner;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/qodana/rules/UtilityClassWithoutPrivateConstructor.java

@@ -15,6 +15,7 @@
 import spoon.reflect.declaration.ModifierKind;
 import spoon.reflect.factory.Factory;
 import spoon.reflect.visitor.filter.TypeFilter;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.Change;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 import xyz.keksdose.spoon.code_solver.history.MarkdownString;

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/spoon/SpoonRefactor.java

@@ -0,0 +1,39 @@
+package xyz.keksdose.spoon.code_solver.analyzer.spoon;
+
+import io.github.martinwitt.laughing_train.domain.entity.AnalyzerResult;
+import io.github.martinwitt.laughing_train.domain.value.RuleId;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.function.Function;
+import spoon.reflect.declaration.CtType;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
+import xyz.keksdose.spoon.code_solver.history.ChangeListener;
+import xyz.keksdose.spoon.code_solver.transformations.TransformationProcessor;
+
+/**
+ * Entry point for spoon based refactoring. This class is used to apply all refactors which are reported by spoon.
+ */
+public class SpoonRefactor extends TransformationProcessor<CtType<?>> {
+
+    private Map<RuleId, Function<AnalyzerResult, AbstractRefactoring>> ruleParser;
+    private List<AbstractRefactoring> refactors;
+
+    public SpoonRefactor(ChangeListener changeListener, List<? extends AnalyzerResult> badSmells) {
+        super(changeListener);
+        ruleParser = new HashMap<>();
+        Arrays.stream(SpoonRules.values()).forEach(rule -> ruleParser.put(rule.getRuleId(), rule.getRefactoring()));
+        for (AnalyzerResult result : badSmells) {
+            Optional.ofNullable(ruleParser.get(result.ruleID())).ifPresent(v -> refactors.add(v.apply(result)));
+        }
+    }
+
+    @Override
+    public void process(CtType<?> element) {
+        for (AbstractRefactoring refactoring : refactors) {
+            refactoring.refactor(listener, element);
+        }
+    }
+}

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/analyzer/spoon/SpoonRules.java

@@ -0,0 +1,38 @@
+package xyz.keksdose.spoon.code_solver.analyzer.spoon;
+
+import io.github.martinwitt.laughing_train.domain.entity.AnalyzerResult;
+import io.github.martinwitt.laughing_train.domain.value.RuleId;
+import java.util.List;
+import java.util.function.Function;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
+import xyz.keksdose.spoon.code_solver.analyzer.AnalyzerRule;
+import xyz.keksdose.spoon.code_solver.analyzer.qodana.rules.MethodMayBeStatic;
+import xyz.keksdose.spoon.code_solver.transformations.BadSmell;
+
+/**
+ * Enum for all spoon based rules.
+ */
+public enum SpoonRules implements AnalyzerRule {
+    METHOD_MAY_BE_STATIC("MethodMayBeStatic", MethodMayBeStatic::new);
+
+    private final RuleId ruleId;
+    private final Function<AnalyzerResult, AbstractRefactoring> refactoring;
+
+    SpoonRules(String ruleId, Function<AnalyzerResult, AbstractRefactoring> refactoring) {
+        this.ruleId = new RuleId(ruleId);
+        this.refactoring = refactoring;
+    }
+
+    @Override
+    public RuleId getRuleId() {
+        return ruleId;
+    }
+
+    Function<AnalyzerResult, AbstractRefactoring> getRefactoring() {
+        return refactoring;
+    }
+
+    List<BadSmell> getDescription() {
+        return getRefactoring().apply(null).getHandledBadSmells();
+    }
+}

code-transformation/src/main/java/xyz/keksdose/spoon/code_solver/api/CodeRefactoring.java

@@ -0,0 +1,50 @@
+package xyz.keksdose.spoon.code_solver.api;
+
+import com.google.common.flogger.FluentLogger;
+import io.github.martinwitt.laughing_train.domain.entity.AnalyzerResult;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.EnumSet;
+import java.util.List;
+import java.util.function.BiFunction;
+import java.util.function.Function;
+import xyz.keksdose.spoon.code_solver.TransformationEngine;
+import xyz.keksdose.spoon.code_solver.analyzer.qodana.QodanaRefactor;
+import xyz.keksdose.spoon.code_solver.analyzer.qodana.QodanaRules;
+import xyz.keksdose.spoon.code_solver.analyzer.spoon.SpoonRefactor;
+import xyz.keksdose.spoon.code_solver.diffs.DiffCleaner;
+import xyz.keksdose.spoon.code_solver.history.ChangeListener;
+import xyz.keksdose.spoon.code_solver.history.Changelog;
+import xyz.keksdose.spoon.code_solver.transformations.TransformationProcessor;
+
+/**
+ * This class is the entry point for the code transformation. It takes a repository and a list of badsmells. It then applies the transformations to the repository and returns a changelog.
+ */
+public class CodeRefactoring {
+
+    private static final FluentLogger logger = FluentLogger.forEnclosingClass();
+
+    private final List<BiFunction<ChangeListener, List<? extends AnalyzerResult>, TransformationProcessor<?>>>
+            refactor = new ArrayList<>();
+
+    public CodeRefactoring() {
+        refactor.add((u, v) -> new QodanaRefactor(EnumSet.allOf(QodanaRules.class), u, v));
+        refactor.add((u, v) -> new SpoonRefactor(u, v));
+    }
+
+    public Changelog refactorBadSmells(Path repository, List<? extends AnalyzerResult> results) {
+        ChangeListener listener = new ChangeListener();
+        logger.atInfo().log("Refactoring %s", repository);
+        DiffCleaner diffCleaner = new DiffCleaner();
+        List<Function<ChangeListener, TransformationProcessor<?>>> function = new ArrayList<>();
+        for (BiFunction<ChangeListener, List<? extends AnalyzerResult>, TransformationProcessor<?>> refactorSupplier :
+                refactor) {
+            function.add(v -> refactorSupplier.apply(v, results));
+        }
+        TransformationEngine transformationEngine = new TransformationEngine(function);
+        transformationEngine.setChangeListener(listener);
+        Changelog log = transformationEngine.applyToGivenPath(repository.toString());
+        log.getChanges().forEach(change -> diffCleaner.clean(repository, change));
+        return log;
+    }
+}

code-transformation/src/test/java/xyz/keksdose/spoon/code_solver/DocGen.java

@@ -13,7 +13,7 @@
 import spoon.reflect.declaration.CtMethod;
 import spoon.reflect.declaration.CtType;
 import spoon.reflect.visitor.filter.TypeFilter;
-import xyz.keksdose.spoon.code_solver.analyzer.qodana.rules.AbstractRefactoring;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 import xyz.keksdose.spoon.code_solver.transformations.BadSmell;
 import xyz.keksdose.spoon.code_solver.transformations.TransformationProcessor;

code-transformation/src/test/java/xyz/keksdose/spoon/code_solver/transformations/TransformationTestUtils.java

@@ -11,7 +11,7 @@
 import spoon.reflect.declaration.CtType;
 import xyz.keksdose.spoon.code_solver.TestHelper;
 import xyz.keksdose.spoon.code_solver.TransformationEngine;
-import xyz.keksdose.spoon.code_solver.analyzer.qodana.rules.AbstractRefactoring;
+import xyz.keksdose.spoon.code_solver.analyzer.AbstractRefactoring;
 import xyz.keksdose.spoon.code_solver.history.ChangeListener;
 
 /**