Add Gradle compatibility

Author: blacelle

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/JavaExtension.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2022 DiffPlug
+ * Copyright 2016-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -34,6 +34,7 @@
 import com.diffplug.spotless.extra.EclipseBasedStepBuilder;
 import com.diffplug.spotless.extra.java.EclipseJdtFormatterStep;
 import com.diffplug.spotless.generic.LicenseHeaderStep;
+import com.diffplug.spotless.java.CleanthatJavaStep;
 import com.diffplug.spotless.java.FormatAnnotationsStep;
 import com.diffplug.spotless.java.GoogleJavaFormatStep;
 import com.diffplug.spotless.java.ImportOrderStep;
@@ -270,6 +271,77 @@ private FormatterStep createStep() {
 		}
 	}
 
+	/** Apply CleanThat refactoring rules. */
+	public CleanthatJavaConfig cleanthat() {
+		return new CleanthatJavaConfig();
+	}
+
+	public class CleanthatJavaConfig {
+		private String groupArtifact = CleanthatJavaStep.defaultGroupArtifact();
+
+		private String version = CleanthatJavaStep.defaultVersion();
+
+		private String sourceJdk = CleanthatJavaStep.defaultJdkVersion();
+
+		private List<String> mutators = CleanthatJavaStep.defaultMutators();
+
+		private List<String> excludedMutators = CleanthatJavaStep.defaultExcludedMutators();
+
+		CleanthatJavaConfig() {
+			addStep(createStep());
+		}
+
+		public CleanthatJavaConfig groupArtifact(String groupArtifact) {
+			Objects.requireNonNull(groupArtifact);
+			this.groupArtifact = groupArtifact;
+			replaceStep(createStep());
+			return this;
+		}
+
+		public CleanthatJavaConfig version(String version) {
+			Objects.requireNonNull(version);
+			this.version = version;
+			replaceStep(createStep());
+			return this;
+		}
+
+		public CleanthatJavaConfig sourceJdk(String sourceJdk) {
+			Objects.requireNonNull(sourceJdk);
+			this.sourceJdk = sourceJdk;
+			replaceStep(createStep());
+			return this;
+		}
+
+		// Especially useful to clear default mutators
+		public CleanthatJavaConfig clearMutators() {
+			this.mutators.clear();
+			replaceStep(createStep());
+			return this;
+		}
+
+		// The fully qualified name of a class implementing eu.solven.cleanthat.engine.java.refactorer.meta.IMutator
+		// or '*' to include all default mutators
+		public CleanthatJavaConfig addMutator(String mutator) {
+			this.mutators.add(mutator);
+			replaceStep(createStep());
+			return this;
+		}
+
+		// useful to exclude a mutator amongst the default list of mutators
+		public CleanthatJavaConfig excludeMutator(String mutator) {
+			this.excludedMutators.add(mutator);
+			replaceStep(createStep());
+			return this;
+		}
+
+		private FormatterStep createStep() {
+			return CleanthatJavaStep.create(
+					groupArtifact,
+					version,
+					sourceJdk, mutators, excludedMutators, provisioner());
+		}
+	}
+
 	/** If the user hasn't specified the files yet, we'll assume he/she means all of the java files. */
 	@Override
 	protected void setupTask(SpotlessTask task) {

plugin-gradle/src/test/java/com/diffplug/gradle/spotless/CleanthatJavaIntegrationTest.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2022-2023 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.diffplug.gradle.spotless;
+
+import java.io.IOException;
+
+import org.junit.jupiter.api.Test;
+
+class CleanthatJavaIntegrationTest extends GradleIntegrationHarness {
+	@Test
+	void integration() throws IOException {
+		setFile("build.gradle").toLines(
+				"plugins {",
+				"    id 'com.diffplug.spotless'",
+				"}",
+				"repositories { mavenCentral() }",
+				"",
+				"spotless {",
+				"    java {",
+				"        target file('test.java')",
+				"        cleanthat().sourceJdk('11')",
+				"    }",
+				"}");
+
+		setFile("test.java").toResource("java/cleanthat/MultipleMutators.dirty.java");
+		gradleRunner().withArguments("spotlessApply").build();
+		assertFile("test.java").sameAsResource("java/cleanthat/MultipleMutators.clean.java");
+	}
+}