refactor: move away from rewrite YAML scripts

Author: triceo

tools/migration/pom.xml

@@ -50,7 +50,6 @@
     <dependency>
       <groupId>org.openrewrite</groupId>
       <artifactId>rewrite-properties</artifactId>
-      <scope>runtime</scope>
     </dependency>
 
     <!-- Testing -->
@@ -87,16 +86,6 @@
         <filtering>true</filtering>
       </resource>
     </resources>
-    <plugins>
-      <plugin>
-        <artifactId>maven-dependency-plugin</artifactId>
-        <configuration>
-          <ignoredUnusedDeclaredDependencies> <!-- These dependencies are used in the YAMLs. -->
-            <dependency>org.openrewrite:rewrite-maven:jar</dependency>
-          </ignoredUnusedDeclaredDependencies>
-        </configuration>
-      </plugin>
-    </plugins>
   </build>
 
 </project>

tools/migration/src/main/filtered-resources/META-INF/rewrite/ChangeVersion.yml

@@ -0,0 +1 @@
+version=${project.version}

tools/migration/src/main/filtered-resources/ai/timefold/solver/migration/rewrite-timefold-solver-version.properties

@@ -0,0 +1,49 @@
+package ai.timefold.solver.migration;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.Properties;
+
+import org.openrewrite.Recipe;
+import org.openrewrite.maven.ChangePropertyValue;
+
+public final class ChangeVersionRecipe extends AbstractRecipe {
+
+    final String version;
+
+    public ChangeVersionRecipe() {
+        try (var is = ChangeVersionRecipe.class.getResourceAsStream("rewrite-timefold-solver-version.properties")) {
+            var props = new Properties();
+            props.load(is);
+            version = props.getProperty("version");
+        } catch (IOException e) {
+            throw new IllegalStateException("Failed to load rewrite-timefold-solver-version.properties.", e);
+        }
+    }
+
+    @Override
+    public String getName() {
+        return "ai.timefold.solver.migration.ChangeVersion";
+    }
+
+    @Override
+    public String getDisplayName() {
+        return "Change the Timefold version";
+    }
+
+    @Override
+    public String getDescription() {
+        return "Replaces the version of Timefold";
+    }
+
+    @Override
+    public List<Recipe> getRecipeList() {
+        return List.of(
+                new ChangePropertyValue("version.ai.timefold.solver", version, false, true),
+                new ChangePropertyValue("version.timefold", version, false, true),
+                new ChangePropertyValue("ai.timefold.solver.version", version, false, true),
+                new ChangePropertyValue("timefold.version", version, false, true),
+                new ChangePropertyValue("timefoldVersion", version, false, true));
+    }
+
+}

tools/migration/src/main/java/ai/timefold/solver/migration/ChangeVersionRecipe.java

@@ -0,0 +1,54 @@
+package ai.timefold.solver.migration;
+
+import java.util.List;
+
+import ai.timefold.solver.migration.v2.ConstraintArgRemovalMigrationRecipe;
+import ai.timefold.solver.migration.v2.GeneralDependencyDeleteMigrationRecipe;
+import ai.timefold.solver.migration.v2.GeneralMethodChangeNameMigrationRecipe;
+import ai.timefold.solver.migration.v2.GeneralMethodDeleteInvocationMigrationRecipe;
+import ai.timefold.solver.migration.v2.GeneralPackageRenameMigrationRecipe;
+import ai.timefold.solver.migration.v2.GeneralTypeChangeMigrationRecipe;
+import ai.timefold.solver.migration.v2.PlanningSolutionAnnotationCleanupMigrationRecipe;
+import ai.timefold.solver.migration.v2.ProblemIdDeletionMigrationRecipe;
+import ai.timefold.solver.migration.v2.SolverConfigOverrideSolutionDeletionMigrationRecipe;
+import ai.timefold.solver.migration.v2.TestingAPIsMigrationRecipe;
+
+import org.openrewrite.Recipe;
+import org.openrewrite.java.RemoveUnusedImports;
+
+public final class ToLatestRecipe extends AbstractRecipe {
+
+    @Override
+    public String getName() {
+        return "ai.timefold.solver.migration.ToLatest";
+    }
+
+    @Override
+    public String getDisplayName() {
+        return "Upgrade to the latest Timefold Solver";
+    }
+
+    @Override
+    public String getDescription() {
+        return "Replace all your calls to deleted/deprecated types and methods of Timefold Solver with their proper alternatives.";
+    }
+
+    @Override
+    public List<Recipe> getRecipeList() {
+        return List.of(
+                new ToLatestV1Recipe(),
+                new ChangeVersionRecipe(),
+                new ConstraintArgRemovalMigrationRecipe(),
+                new PlanningSolutionAnnotationCleanupMigrationRecipe(),
+                new GeneralMethodDeleteInvocationMigrationRecipe(),
+                new GeneralMethodChangeNameMigrationRecipe(),
+                new GeneralTypeChangeMigrationRecipe(),
+                new ProblemIdDeletionMigrationRecipe(),
+                new TestingAPIsMigrationRecipe(),
+                new GeneralDependencyDeleteMigrationRecipe(),
+                new GeneralPackageRenameMigrationRecipe(),
+                new SolverConfigOverrideSolutionDeletionMigrationRecipe(),
+                new RemoveUnusedImports());
+    }
+
+}

tools/migration/src/main/java/ai/timefold/solver/migration/ToLatestRecipe.java

@@ -0,0 +1,66 @@
+package ai.timefold.solver.migration;
+
+import java.util.List;
+
+import ai.timefold.solver.migration.v1.AsConstraintRecipe;
+import ai.timefold.solver.migration.v1.ConstraintRefRecipe;
+import ai.timefold.solver.migration.v1.NullableRecipe;
+import ai.timefold.solver.migration.v1.RemoveConstraintPackageRecipe;
+import ai.timefold.solver.migration.v1.ScoreGettersRecipe;
+import ai.timefold.solver.migration.v1.ScoreManagerMethodsRecipe;
+import ai.timefold.solver.migration.v1.SingleConstraintAssertionMethodsRecipe;
+import ai.timefold.solver.migration.v1.SolutionManagerRecommendAssignmentRecipe;
+import ai.timefold.solver.migration.v1.SolverManagerBuilderRecipe;
+import ai.timefold.solver.migration.v1.SortingMigrationRecipe;
+
+import org.openrewrite.Recipe;
+import org.openrewrite.java.ChangeMethodName;
+import org.openrewrite.java.ChangeType;
+import org.openrewrite.properties.ChangePropertyKey;
+
+public final class ToLatestV1Recipe extends AbstractRecipe {
+
+    @Override
+    public String getName() {
+        return "ai.timefold.solver.migration.ToLatestV1";
+    }
+
+    @Override
+    public String getDisplayName() {
+        return "Upgrade to the latest Timefold Solver 1.x";
+    }
+
+    @Override
+    public String getDescription() {
+        return "Replace all your calls to deleted/deprecated types and methods of Timefold Solver with their proper alternatives.";
+    }
+
+    @Override
+    public List<Recipe> getRecipeList() {
+        return List.of(
+                new ChangePropertyKey("timefold.solver.solve-length", "timefold.solver.solve.duration", null, null),
+                new ChangePropertyKey("quarkus.timefold.solver.solve-length", "quarkus.timefold.solver.solve.duration", null,
+                        null),
+                new ChangeMethodName("ai.timefold.solver.core.api.score.stream.ConstraintFactory from(Class)",
+                        "forEach", true, false),
+                new ChangeMethodName(
+                        "ai.timefold.solver.core.api.score.stream.ConstraintFactory fromUnfiltered(Class)",
+                        "forEachIncludingUnassigned", true, false),
+                new ChangeMethodName(
+                        "ai.timefold.solver.core.api.score.stream.ConstraintFactory fromUniquePair(..)",
+                        "forEachUniquePair", true, false),
+                new ScoreManagerMethodsRecipe(),
+                new ChangeType("ai.timefold.solver.core.api.score.ScoreManager",
+                        "ai.timefold.solver.core.api.solver.SolutionManager", true),
+                new ScoreGettersRecipe(),
+                new ConstraintRefRecipe(),
+                new SolverManagerBuilderRecipe(),
+                new NullableRecipe(),
+                new SingleConstraintAssertionMethodsRecipe(),
+                new AsConstraintRecipe(),
+                new RemoveConstraintPackageRecipe(),
+                new SolutionManagerRecommendAssignmentRecipe(),
+                new SortingMigrationRecipe());
+    }
+
+}

tools/migration/src/main/java/ai/timefold/solver/migration/ToLatestV1Recipe.java

@@ -0,0 +1,31 @@
+package ai.timefold.solver.migration.v2;
+
+import java.util.List;
+
+import ai.timefold.solver.migration.AbstractRecipe;
+
+import org.openrewrite.Recipe;
+import org.openrewrite.java.DeleteMethodArgument;
+
+public final class ConstraintArgRemovalMigrationRecipe extends AbstractRecipe {
+
+    @Override
+    public String getDisplayName() {
+        return "Remove constraint package argument from ConstraintRef and ConstraintBuilder";
+    }
+
+    @Override
+    public String getDescription() {
+        return "Removes the first (package) argument from ConstraintRef.of() and ConstraintBuilder.asConstraint().";
+    }
+
+    @Override
+    public List<Recipe> getRecipeList() {
+        return List.of(
+                new DeleteMethodArgument(
+                        "ai.timefold.solver.core.api.score.constraint.ConstraintRef of(String, String)", 0),
+                new DeleteMethodArgument(
+                        "ai.timefold.solver.core.api.score.stream.ConstraintBuilder asConstraint(String, String)", 0));
+    }
+
+}

tools/migration/src/main/java/ai/timefold/solver/migration/v2/ConstraintArgRemovalMigrationRecipe.java

@@ -0,0 +1,31 @@
+package ai.timefold.solver.migration.v2;
+
+import java.util.List;
+
+import ai.timefold.solver.migration.AbstractRecipe;
+
+import org.openrewrite.Recipe;
+import org.openrewrite.java.RemoveAnnotationAttribute;
+
+public final class PlanningSolutionAnnotationCleanupMigrationRecipe extends AbstractRecipe {
+
+    @Override
+    public String getDisplayName() {
+        return "Remove deprecated attributes from @PlanningSolution";
+    }
+
+    @Override
+    public String getDescription() {
+        return "Removes deprecated lookUpStrategyType and autoDiscoverMemberType attributes from @PlanningSolution.";
+    }
+
+    @Override
+    public List<Recipe> getRecipeList() {
+        return List.of(
+                new RemoveAnnotationAttribute("ai.timefold.solver.core.api.domain.solution.PlanningSolution",
+                        "lookUpStrategyType"),
+                new RemoveAnnotationAttribute("ai.timefold.solver.core.api.domain.solution.PlanningSolution",
+                        "autoDiscoverMemberType"));
+    }
+
+}

tools/migration/src/main/java/ai/timefold/solver/migration/v2/PlanningSolutionAnnotationCleanupMigrationRecipe.java

@@ -8,5 +8,6 @@
     requires rewrite.core;
     requires rewrite.java;
     requires rewrite.maven;
+    requires rewrite.properties;
 
 }