Resolved TODO: custom steps only allowed on Gradle 8+

Author: nedtwigg

plugin-gradle/CHANGES.md

@@ -4,6 +4,8 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 
 ## [Unreleased]
 ### Added
+* Full, no-asterisk support of Gradle configuration cache. ([#1274](https://github.com/diffplug/spotless/issues/1274), giving up on [#987](https://github.com/diffplug/spotless/issues/987))
+  * In order to use `custom`, you must now use Gradle 8.0+. 
 * Respect `.editorconfig` settings for formatting shell via `shfmt` ([#2031](https://github.com/diffplug/spotless/pull/2031))
 * Add support for formatting and sorting Maven POMs ([#2082](https://github.com/diffplug/spotless/issues/2082))
 ### Fixed

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

@@ -16,6 +16,7 @@
 package com.diffplug.gradle.spotless;
 
 import static com.diffplug.gradle.spotless.PluginGradlePreconditions.requireElementsNonNull;
+import static com.diffplug.gradle.spotless.SpotlessPluginRedirect.badSemver;
 import static java.util.Objects.requireNonNull;
 
 import java.io.File;
@@ -451,6 +452,12 @@ public String apply(String unixNewlines) {
 	 */
 	public void custom(String name, FormatterFunc formatter) {
 		requireNonNull(formatter, "formatter");
+		if (badSemver(getProject()) < badSemver(SpotlessPlugin.VER_GRADLE_minVersionForCustom)) {
+			throw new GradleException("The 'custom' method is only available if you are using Gradle "
+					+ SpotlessPlugin.VER_GRADLE_minVersionForCustom
+					+ " or newer, this is "
+					+ getProject().getGradle().getGradleVersion());
+		}
 		addStep(FormatterStep.createLazy(name, () -> globalState, SerializedFunction.alwaysReturns(formatter)));
 	}
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,6 +28,7 @@ public class SpotlessPlugin implements Plugin<Project> {
 	static final String SPOTLESS_MODERN = "spotlessModern";
 	static final String VER_GRADLE_min = "6.1.1";
 	static final String VER_GRADLE_javaPluginExtension = "7.1";
+	static final String VER_GRADLE_minVersionForCustom = "8.0";
 	private static final int MINIMUM_JRE = 11;
 
 	@Override

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 DiffPlug
+ * Copyright 2020-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,7 +27,11 @@
 public class SpotlessPluginRedirect implements Plugin<Project> {
 	private static final Pattern BAD_SEMVER = Pattern.compile("(\\d+)\\.(\\d+)");
 
-	private static int badSemver(String input) {
+	static int badSemver(Project project) {
+		return badSemver(project.getGradle().getGradleVersion());
+	}
+
+	static int badSemver(String input) {
 		Matcher matcher = BAD_SEMVER.matcher(input);
 		if (!matcher.find() || matcher.start() != 0) {
 			throw new IllegalArgumentException("Version must start with " + BAD_SEMVER.pattern());
@@ -46,7 +50,7 @@ private static int badSemver(int major, int minor) {
 
 	static boolean gradleIsTooOld(Project project) {
 		if (gradleIsTooOld == null) {
-			gradleIsTooOld = badSemver(project.getGradle().getGradleVersion()) < badSemver(SpotlessPlugin.VER_GRADLE_min);
+			gradleIsTooOld = badSemver(project) < badSemver(SpotlessPlugin.VER_GRADLE_min);
 		}
 		return gradleIsTooOld.booleanValue();
 	}

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

@@ -17,15 +17,9 @@
 
 import java.io.IOException;
 
-import org.gradle.testkit.runner.GradleRunner;
 import org.junit.jupiter.api.Test;
 
 class BumpThisNumberIfACustomStepChangesTest extends GradleIntegrationHarness {
-	@Override
-	protected GradleRunner gradleRunner() throws IOException {
-		return super.gradleRunner().withGradleVersion("8.0");
-	}
-
 	private void writeBuildFile(String toInsert) throws IOException {
 		setFile("build.gradle").toLines(
 				"plugins {",

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

@@ -53,7 +53,7 @@ private Git initRepo() throws IllegalStateException, GitAPIException, IOExceptio
 
 	@Override
 	protected GradleRunner gradleRunner() throws IOException {
-		return super.gradleRunner().withGradleVersion(GradleVersionSupport.CONFIGURATION_CACHE.version);
+		return super.gradleRunner().withGradleVersion(GradleVersionSupport.CUSTOM_STEPS.version);
 	}
 
 	@ParameterizedTest

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -43,7 +43,7 @@
 
 public class GradleIntegrationHarness extends ResourceHarness {
 	public enum GradleVersionSupport {
-		JRE_11("5.0"), MINIMUM(SpotlessPlugin.VER_GRADLE_min),
+		JRE_11("5.0"), MINIMUM(SpotlessPlugin.VER_GRADLE_min), CUSTOM_STEPS(SpotlessPlugin.VER_GRADLE_minVersionForCustom),
 		// technically, this API exists in 6.5, but the flags for it change in 6.6, so we build to that
 		CONFIGURATION_CACHE("6.6"),
 		// https://docs.gradle.org/7.5/userguide/configuration_cache.html#config_cache:stable
@@ -116,8 +116,14 @@ void gitAttributes() throws IOException {
 	}
 
 	protected GradleRunner gradleRunner() throws IOException {
+		GradleVersionSupport version;
+		if (newFile("build.gradle").exists() && read("build.gradle").contains("custom")) {
+			version = GradleVersionSupport.CUSTOM_STEPS;
+		} else {
+			version = GradleVersionSupport.MINIMUM;
+		}
 		return GradleRunner.create()
-				.withGradleVersion(GradleVersionSupport.MINIMUM.version)
+				.withGradleVersion(version.version)
 				.withProjectDir(rootFolder())
 				.withTestKitDir(getTestKitDir())
 				.withPluginClasspath();