Changed AddPropertyIfClassExists to AddSpringPropertyIfClassExists

Author: JohannesRabauer

spring-data-eclipse-store-migration/pom.xml

@@ -114,8 +114,8 @@
 			<artifactId>rewrite-java</artifactId>
 		</dependency>
 		<dependency>
-			<groupId>org.openrewrite</groupId>
-			<artifactId>rewrite-properties</artifactId>
+			<groupId>org.openrewrite.recipe</groupId>
+			<artifactId>rewrite-spring</artifactId>
 		</dependency>
 		<dependency>
 			<groupId>org.projectlombok</groupId>

spring-data-eclipse-store-migration/src/main/java/software/xdev/spring/data/eclipse/store/AddPropertyIfClassExists.java renamed to spring-data-eclipse-store-migration/src/main/java/software/xdev/spring/data/eclipse/store/AddSpringPropertyIfClassExists.java

@@ -15,13 +15,15 @@
  */
 package software.xdev.spring.data.eclipse.store;
 
+import java.util.List;
+
 import org.jetbrains.annotations.NotNull;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Option;
 import org.openrewrite.Recipe;
 import org.openrewrite.TreeVisitor;
 import org.openrewrite.internal.lang.Nullable;
-import org.openrewrite.properties.AddProperty;
+import org.openrewrite.java.spring.AddSpringProperty;
 
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;
@@ -35,7 +37,7 @@
 @AllArgsConstructor
 @NoArgsConstructor
 @EqualsAndHashCode(callSuper = true)
-public class AddPropertyIfClassExists extends Recipe
+public class AddSpringPropertyIfClassExists extends Recipe
 {
 	@Option(displayName = "Class that must exist in the classpath to add the property",
 		description = "Name of the class that must exist in the classpath to execute the recipe to add a property in the properties file.",
@@ -50,7 +52,8 @@ public class AddPropertyIfClassExists extends Recipe
 	private String property;
 	@Option(
 		displayName = "Property value",
-		description = "The value of the new property key."
+		description = "The value of the new property key.",
+		example = "true"
 	)
 	private String value;
 	@Option(
@@ -61,24 +64,25 @@ public class AddPropertyIfClassExists extends Recipe
 	)
 	private @Nullable String comment;
 	@Option(
-		displayName = "Optional delimiter",
-		description = "Property entries support different delimiters (`=`, `:`, or whitespace). The default value is "
-			+ "`=` unless provided the delimiter of the new property entry.",
+		displayName = "Optional list of file path matcher",
+		description = "Each value in this list represents a glob expression that is used to match which files will be "
+			+ "modified. If this value is not present, this recipe will query the execution context for reasonable "
+			+ "defaults. (\"**/application.yml\", \"**/application.yml\", and \"**/application.properties\".",
 		required = false,
-		example = ":"
+		example = "[\"**/application.yml\"]"
 	)
-	private @Nullable String delimiter;
+	private @Nullable List<String> pathExpressions;
 
 	@Override
 	public @NotNull String getDisplayName()
 	{
-		return "AddPropertyIfClassExists";
+		return "AddSpringPropertyIfClassExists";
 	}
 
 	@Override
 	public @NotNull String getDescription()
 	{
-		return "Add a property to the properties file if a specific class exists.";
+		return "Add a spring property to the properties file if a specific class exists.";
 	}
 
 	@Override
@@ -88,8 +92,8 @@ public class AddPropertyIfClassExists extends Recipe
 		{
 			return TreeVisitor.noop();
 		}
-		return new AddProperty(
-			this.property, this.value, this.comment, this.delimiter
+		return new AddSpringProperty(
+			this.property, this.value, this.comment, this.pathExpressions
 		).getVisitor();
 	}
 

spring-data-eclipse-store-migration/src/main/resources/META-INF/rewrite/rewrite.yml

@@ -16,12 +16,11 @@ recipeList:
       classPath: 'spring-data-eclipse-store'
       annotationTypeToAddSimpleName: 'EnableEclipseStoreRepositories'
 
-  - software.xdev.spring.data.eclipse.store.AddPropertyIfClassExists:
+  - software.xdev.spring.data.eclipse.store.AddSpringPropertyIfClassExists:
       className: 'org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration'
       property: 'spring.autoconfigure.exclude'
       value: 'org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration'
       comment: 'This suppresses the use of JPA in the project. It is needed to let EclipseStore coexist with JPA.'
-      delimiter: =
 
   - org.openrewrite.maven.AddDependency:
       groupId: software.xdev

spring-data-eclipse-store-migration/src/test/java/software/xdev/spring/data/eclipse/store/AddPropertyIfClassExistsTest.java renamed to spring-data-eclipse-store-migration/src/test/java/software/xdev/spring/data/eclipse/store/AddSpringPropertyIfClassExistsTest.java

@@ -16,6 +16,7 @@
 package software.xdev.spring.data.eclipse.store;
 
 import static org.openrewrite.properties.Assertions.properties;
+import static org.openrewrite.yaml.Assertions.yaml;
 
 import org.junit.jupiter.api.Test;
 import org.openrewrite.test.RecipeSpec;
@@ -25,42 +26,84 @@
 import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
 
 
-class AddPropertyIfClassExistsTest implements RewriteTest
+class AddSpringPropertyIfClassExistsTest implements RewriteTest
 {
 
 	@Override
 	public void defaults(final RecipeSpec recipeSpec)
 	{
 		recipeSpec
-			.recipe(new AddPropertyIfClassExists(
+			.recipe(new AddSpringPropertyIfClassExists(
 				HibernateJpaAutoConfiguration.class.getName(),
 				"spring.autoconfigure.exclude",
 				DataSourceAutoConfiguration.class.getName()
 					+ ","
 					+ DataSourceTransactionManagerAutoConfiguration.class.getName()
 					+ ","
 					+ HibernateJpaAutoConfiguration.class.getName(),
-				"",
-				"="));
+				"", null));
 	}
 
 	@Test
-	void testSimple()
+	void testSimpleProperties()
 	{
 		this.rewriteRun
 			(
 				properties(
 					"",
 					"""
 						spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration
-						"""
+						""",
+					s -> s.path("application.properties")
+				)
+			);
+	}
+	
+	@Test
+	void testSimpleYaml()
+	{
+		this.rewriteRun
+			(
+				yaml(
+					"",
+					"""
+						spring:
+						  autoconfigure:
+						    exclude: org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration
+						""",
+					s -> s.path("application.yml")
+				)
+			);
+	}
+	
+	@Test
+	void testWrongFileNameYaml()
+	{
+		this.rewriteRun
+			(
+				yaml(
+					"",
+					s -> s.path("random.yml")
+				)
+			);
+	}
+	
+	@Test
+	void testWrongFileNameProperties()
+	{
+		this.rewriteRun
+			(
+				properties(
+					"",
+					s -> s.path("random.properties")
 				)
 			);
 	}
 
 	/**
 	 * It's not clear if this is a desired behavior, but since the Open Rewrite Recipe
-	 * {@link org.openrewrite.properties.AddProperty} is doing this, and we are only using this recipe, this is how it
+	 * {@link org.openrewrite.java.spring.AddSpringProperty} is doing this, and we are only using this recipe, this is
+	 * how it
 	 * works now.
 	 * <p>
 	 * Might change in the future.
@@ -75,13 +118,17 @@ void testMultipleProperties()
 					"",
 					"""
 						spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration
-						"""
+						""",
+					s -> s.path("application.properties")
 				),
-				properties(
+				yaml(
 					"",
 					"""
-						spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration
-						"""
+						spring:
+						  autoconfigure:
+						    exclude: org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration
+						""",
+					s -> s.path("application.yml")
 				)
 			);
 	}
@@ -105,14 +152,15 @@ void testClassNotExisting()
 		this.rewriteRun
 			(
 				recipeSpec ->
-					recipeSpec.recipe(new AddPropertyIfClassExists(
+					recipeSpec.recipe(new AddSpringPropertyIfClassExists(
 						"not.existing.Class",
 						"spring.autoconfigure.exclude",
 						"DummyValue",
 						"",
-						"=")),
+						null)),
 				properties(
-					""
+					"",
+					s -> s.path("application.properties")
 				)
 			);
 	}