Writing recipes over multiple source file types
When creating new recipes, you may find it desirable to examine multiple source files, potentially of different types, to make key decisions in your visitor. For example, you may want to look for a particular condition to be present in a Maven POM file and, if that condition is met, alter an application property in a YAML file.
You should use the
visit(List<SourceFile> before, ExecutionContext ctx) method in the Recipe class to iterate over and maintain the decision state, and then ListUtils.map to execute the transformation.package org.openrewrite;
import org.openrewrite.internal.ListUtils;
import org.openrewrite.maven.tree.Maven;
import org.openrewrite.yaml.YamlVisitor;
import java.util.List;
public class MavenYamlRecipe extends Recipe {
@Override
public String getDisplayName() {
return "Something with Maven and something with YAML";
}
@Override
protected List<SourceFile> visit(List<SourceFile> before, ExecutionContext ctx) {
boolean pomConditionMet = false;
for (SourceFile sourceFile : before) {
if(sourceFile instanceof Maven) {
Maven m = (Maven) sourceFile;
// pomConditionMet = ...
}
}
return ListUtils.map(before, sourceFile -> (SourceFile) new YamlVisitor<Integer>() {
// whatever your YAML visitor does can now respond to pomConditionMet
}.visitNonNull(sourceFile, 0));
}
}
To write a unit test that tests multiple source file types, use their respective parsers:
package org.openrewrite
import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
import org.openrewrite.maven.MavenParser
import org.openrewrite.yaml.YamlParser
class MavenYamlTest {
@Test
fun mavenYaml() {
val sources =
MavenParser.builder().build().parse(
"""
<project>
<groupId>org.openrewrite</groupId>
<artifactId>test</artifactId>
<version>0.1.0</version>
</project>
"""
).plus(
YamlParser().parse("""
key: value
""")
)
val results = MavenYaml().run(sources)
assertThat(results.map { it.after!!.printAll() }).containsExactly(
"""
key: changedValue
""".trimIndent()
)
}
}