(re)activate rewrite capability

Author: Vincent Potucek

CONTRIBUTING.md

@@ -89,6 +89,19 @@ Eclipse settings.
 It is forbidden to use _wildcard imports_ (e.g., `import static org.junit.jupiter.api.Assertions.*;`)
 in Java code.
 
+### 🚀 Code Transformation & Automated Rewriting
+*(Advanced Refactoring, Modernization, and Bulk Code Changes)*
+
+#### 🔧 Automated rewriting of source code to
+- **Refactor** safely (e.g., rename methods, migrate APIs)
+- **Modernize** (e.g., Java 8 → Java 17 features)
+- **Fix anti-patterns** (e.g., replace `Vector` with `ArrayList`)
+- **Enforce conventions** (e.g., JUnit's naming rules)
+
+The build system incorporates [Moderne](https://moderne.io/) rewrite capabilities for automated code transformations. These modifications are environment-driven enlisted in the [junitbuild.java-library-conventions.gradle.kts](gradle/plugins/common/src/main/kotlin/junitbuild.java-library-conventions.gradle.kts)
+
+You can use `gradle rewriteRun` to apply these changes.
+
 #### Documentation
 
 Text in `*.adoc` and `*.md` files should be wrapped at 90 characters whenever technically

documentation/src/test/java/example/ClassTemplateDemo.java

@@ -52,9 +52,9 @@ void wellKnown() {
 	}
 
 	// end::user_guide[]
-	static
+	public
 	// tag::user_guide[]
-	public class MyClassTemplateInvocationContextProvider
+	static class MyClassTemplateInvocationContextProvider
 			// tag::custom_line_break[]
 			implements ClassTemplateInvocationContextProvider {
 

documentation/src/test/java/example/ParameterizedMigrationDemo.java

@@ -25,9 +25,9 @@ public class ParameterizedMigrationDemo {
 	// tag::before[]
 	@RunWith(Parameterized.class)
 	// end::before[]
-	static
+	public
 	// tag::before[]
-	public class JUnit4ParameterizedClassTests {
+	static class JUnit4ParameterizedClassTests {
 
 		@Parameterized.Parameters
 		public static Iterable<Object[]> data() {

documentation/src/test/java/example/ParameterizedTestDemo.java

@@ -357,9 +357,9 @@ void testWithArgumentsSource(String argument) {
 	}
 
 	// end::ArgumentsSource_example[]
-	static
+	public
 	// tag::ArgumentsProvider_example[]
-	public class MyArgumentsProvider implements ArgumentsProvider {
+	static class MyArgumentsProvider implements ArgumentsProvider {
 
 		@Override
 		public Stream<? extends Arguments> provideArguments(ParameterDeclarations parameters,
@@ -375,9 +375,9 @@ void testWithArgumentsSourceWithConstructorInjection(String argument) {
 		assertNotNull(argument);
 	}
 
-	static
+	public
 	// tag::ArgumentsProviderWithConstructorInjection_example[]
-	public class MyArgumentsProviderWithConstructorInjection implements ArgumentsProvider {
+	static class MyArgumentsProviderWithConstructorInjection implements ArgumentsProvider {
 
 		private final TestInfo testInfo;
 
@@ -427,9 +427,9 @@ void testWithImplicitFallbackArgumentConversion(Book book) {
 	}
 
 	// end::implicit_fallback_conversion_example[]
-	static
+	public
 	// tag::implicit_fallback_conversion_example_Book[]
-	public class Book {
+	static class Book {
 
 		private final String title;
 
@@ -458,10 +458,10 @@ void testWithExplicitArgumentConversion(
 	}
 
 	// end::explicit_conversion_example[]
-	static
+	public
 	@SuppressWarnings({ "NullableProblems", "NullAway" })
 	// tag::explicit_conversion_example_ToStringArgumentConverter[]
-	public class ToStringArgumentConverter extends SimpleArgumentConverter {
+	static class ToStringArgumentConverter extends SimpleArgumentConverter {
 
 		@Override
 		protected Object convert(Object source, Class<?> targetType) {
@@ -474,10 +474,10 @@ protected Object convert(Object source, Class<?> targetType) {
 	}
 	// end::explicit_conversion_example_ToStringArgumentConverter[]
 
-	static
+	public
 	@SuppressWarnings({ "NullableProblems", "NullAway", "ConstantValue" })
 	// tag::explicit_conversion_example_TypedArgumentConverter[]
-	public class ToLengthArgumentConverter extends TypedArgumentConverter<String, Integer> {
+	static class ToLengthArgumentConverter extends TypedArgumentConverter<String, Integer> {
 
 		protected ToLengthArgumentConverter() {
 			super(String.class, Integer.class);
@@ -516,7 +516,7 @@ void testWithArgumentsAccessor(ArgumentsAccessor arguments) {
 									arguments.get(2, Gender.class),
 									arguments.get(3, LocalDate.class));
 
-		if (person.getFirstName().equals("Jane")) {
+		if ("Jane".equals(person.getFirstName())) {
 			assertEquals(Gender.F, person.getGender());
 		}
 		else {
@@ -540,9 +540,9 @@ void testWithArgumentsAggregator(@AggregateWith(PersonAggregator.class) Person p
 	}
 
 	// end::ArgumentsAggregator_example[]
-	static
+	public
 	// tag::ArgumentsAggregator_example_PersonAggregator[]
-	public class PersonAggregator extends SimpleArgumentsAggregator {
+	static class PersonAggregator extends SimpleArgumentsAggregator {
 		@Override
 		protected Person aggregateArguments(ArgumentsAccessor arguments, Class<?> targetType,
 				AnnotatedElementContext context, int parameterIndex) {

documentation/src/test/java/example/TestInfoDemo.java

@@ -31,13 +31,13 @@ static void beforeAll(TestInfo testInfo) {
 
 	TestInfoDemo(TestInfo testInfo) {
 		String displayName = testInfo.getDisplayName();
-		assertTrue(displayName.equals("TEST 1") || displayName.equals("test2()"));
+		assertTrue("TEST 1".equals(displayName) || "test2()".equals(displayName));
 	}
 
 	@BeforeEach
 	void init(TestInfo testInfo) {
 		String displayName = testInfo.getDisplayName();
-		assertTrue(displayName.equals("TEST 1") || displayName.equals("test2()"));
+		assertTrue("TEST 1".equals(displayName) || "test2()".equals(displayName));
 	}
 
 	@Test

documentation/src/test/java/example/TestTemplateDemo.java

@@ -38,10 +38,10 @@ void testTemplate(String fruit) {
 	}
 
 	// end::user_guide[]
-	static
+	public
 	// @formatter:off
 	// tag::user_guide[]
-	public class MyTestTemplateInvocationContextProvider
+	static class MyTestTemplateInvocationContextProvider
 			implements TestTemplateInvocationContextProvider {
 
 		@Override

documentation/src/test/resources/log4j2-test.xml

@@ -16,4 +16,4 @@
 			<AppenderRef ref="Console" />
 		</Root>
 	</Loggers>
-</Configuration>
+</Configuration>

gradle/plugins/common/src/main/kotlin/junitbuild.java-library-conventions.gradle.kts

@@ -17,13 +17,46 @@ plugins {
 	id("org.openrewrite.rewrite")
 }
 
+/**
+ * activeRecipe("org.openrewrite.java.RemoveUnusedImports") // there are (non); fails to analyze
+ * activeRecipe("org.openrewrite.java.format.AutoFormat") // could remove check, spot, and all other recipes if working
+ * activeRecipe("org.openrewrite.java.format.BlankLines") // IndexOutOfBoundsException: Index 0 out of bounds for length 0
+ * activeRecipe("org.openrewrite.java.format.NormalizeFormat")
+ * activeRecipe("org.openrewrite.java.format.NormalizeLineBreaks")
+ * activeRecipe("org.openrewrite.java.format.RemoveTrailingWhitespace")
+ * activeRecipe("org.openrewrite.java.format.Spaces")
+ * activeRecipe("org.openrewrite.java.format.TabsAndIndents")
+ * activeRecipe("org.openrewrite.java.format.WrappingAndBraces")
+ * activeRecipe("org.openrewrite.java.migrate.UpgradeToJava17")
+ * activeRecipe("org.openrewrite.java.testing.assertj.Assertj")
+ * activeRecipe("org.openrewrite.java.testing.cleanup.AssertTrueNullToAssertNull")
+ * activeRecipe("org.openrewrite.java.testing.cleanup.TestsShouldNotBePublic")
+ * activeRecipe("org.openrewrite.java.testing.junit5.JUnit5BestPractices") // exclude legacy
+ * activeRecipe("org.openrewrite.staticanalysis.CodeCleanup")
+ * activeRecipe("org.openrewrite.staticanalysis.CommonStaticAnalysis")
+ * activeRecipe("org.openrewrite.staticanalysis.FinalizeLocalVariables")
+ * activeRecipe("org.openrewrite.staticanalysis.RedundantFileCreation")
+ * activeRecipe("org.openrewrite.staticanalysis.RemoveUnusedLocalVariables")
+ * activeRecipe("org.openrewrite.staticanalysis.RemoveUnusedPrivateFields")
+ * activeRecipe("org.openrewrite.staticanalysis.RemoveUnusedPrivateMethods") // there are non; fails to analyze (even tho it worked once)
+ * activeRecipe("org.openrewrite.staticanalysis.StringLiteralEquality")
+ * activeRecipe("org.openrewrite.text.EndOfLineAtEndOfFile")
+ * activeRecipe("org.openrewrite.java.migrate.UpgradeToJava21")
+ */
 rewrite {
-	activeRecipe("org.openrewrite.java.migrate.UpgradeToJava17")
+	activeRecipe("org.openrewrite.staticanalysis.EqualsAvoidsNull")
+	activeRecipe("org.openrewrite.staticanalysis.MissingOverrideAnnotation")
+	activeRecipe("org.openrewrite.staticanalysis.ModifierOrder")
+	failOnDryRunResults = true
 }
 
+/**
+ * rewrite("org.openrewrite.recipe:rewrite-testing-frameworks")
+ * rewrite("org.openrewrite.recipe:rewrite-migrate-java")
+ */
 dependencies {
 	rewrite(platform(dependencyFromLibs("openrewrite-recipe-bom")))
-	rewrite("org.openrewrite.recipe:rewrite-migrate-java")
+	rewrite("org.openrewrite.recipe:rewrite-static-analysis")
 }
 
 val mavenizedProjects: List<Project> by rootProject.extra
@@ -281,6 +314,9 @@ tasks {
 	checkstyleTest {
 		config = resources.text.fromFile(checkstyle.configDirectory.file("checkstyleTest.xml"))
 	}
+	check {
+		dependsOn(rewriteDryRun)
+	}
 }
 
 pluginManager.withPlugin("java-test-fixtures") {

gradle/plugins/common/src/main/kotlin/junitbuild.spotless-conventions.gradle.kts

@@ -13,13 +13,11 @@ spotless {
 		targetExclude("gradle/plugins/**/build/**")
 		leadingSpacesToTabs()
 		trimTrailingWhitespace()
-		endWithNewline()
 	}
 
 	format("documentation") {
 		target("*.adoc", "*.md", "src/**/*.adoc", "src/**/*.md")
 		trimTrailingWhitespace()
-		endWithNewline()
 	}
 
 	pluginManager.withPlugin("java") {
@@ -36,7 +34,6 @@ spotless {
 			val majorMinorVersion = "([0-9]+\\.[0-9]+).*".toRegex().matchEntire(fullVersion)!!.let { it.groups[1]!!.value }
 			eclipse(majorMinorVersion).configFile(javaFormatterConfigFile)
 			trimTrailingWhitespace()
-			endWithNewline()
 			removeUnusedImports()
 		}
 
@@ -46,7 +43,6 @@ spotless {
 			})
 			licenseHeaderFile(license.headerFile, "^$")
 			trimTrailingWhitespace()
-			endWithNewline()
 		}
 	}
 
@@ -56,7 +52,6 @@ spotless {
 			ktlint(requiredVersionFromLibs("ktlint"))
 			licenseHeaderFile(license.headerFile)
 			trimTrailingWhitespace()
-			endWithNewline()
 		}
 		configurations.named { it.startsWith("spotless") }.configureEach {
 			// Workaround for CVE-2024-12798 and CVE-2024-12801
@@ -74,7 +69,6 @@ spotless {
 		groovy {
 			licenseHeaderFile(license.headerFile)
 			trimTrailingWhitespace()
-			endWithNewline()
 		}
 	}
 }

junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/extension/TimeoutInvocationFactory.java

@@ -54,7 +54,7 @@ private ScheduledExecutorService getThreadExecutorForSameThreadInvocation() {
 	}
 
 	@SuppressWarnings({ "deprecation", "try" })
-	private static abstract class ExecutorResource implements Store.CloseableResource, AutoCloseable {
+	private abstract static class ExecutorResource implements Store.CloseableResource, AutoCloseable {
 
 		protected final ScheduledExecutorService executor;