Use Provider API for Gradle properties

Author: simonlebras

CHANGES.md

@@ -13,7 +13,8 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ### Changes
 * Bump default `ktfmt` version to latest `0.58` -> `0.59`. ([#2681](https://github.com/diffplug/spotless/pull/2681)
 ### Fixed
-- palantirJavaFormat is no longer arbitrarily set to outdated versions on Java 17, latest available version is always used ([#2686](https://github.com/diffplug/spotless/pull/2686) fixes [#2685](https://github.com/diffplug/spotless/issues/2685))
+* palantirJavaFormat is no longer arbitrarily set to outdated versions on Java 17, latest available version is always used ([#2686](https://github.com/diffplug/spotless/pull/2686) fixes [#2685](https://github.com/diffplug/spotless/issues/2685))
+* Use Provider API for Gradle properties. ([#2718](https://github.com/diffplug/spotless/pull/2718)
 ### Removed
 * **BREAKING** Drop support for older Ktlint versions. ([#2711](https://github.com/diffplug/spotless/pull/2711))
 

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

@@ -630,8 +630,11 @@ public LicenseHeaderConfig updateYearWithLatest(boolean updateYearWithLatest) {
 
 		FormatterStep createStep() {
 			return builder.withYearModeLazy(() -> {
-				if ("true".equals(spotless.project
-						.findProperty(LicenseHeaderStep.FLAG_SET_LICENSE_HEADER_YEARS_FROM_GIT_HISTORY()))) {
+				if (spotless.project
+						.getProviders()
+						.gradleProperty(LicenseHeaderStep.FLAG_SET_LICENSE_HEADER_YEARS_FROM_GIT_HISTORY())
+						.map(Boolean::parseBoolean)
+						.getOrElse(false)) {
 					return YearMode.SET_FROM_GIT;
 				} else {
 					boolean updateYear = updateYearWithLatest == null ? getRatchetFrom() != null : updateYearWithLatest;

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

@@ -19,9 +19,8 @@
 import java.io.IOException;
 import java.nio.file.Files;
 
-import javax.annotation.Nullable;
-
 import org.gradle.api.Project;
+import org.gradle.api.provider.Provider;
 
 import com.diffplug.common.base.Errors;
 import com.diffplug.common.io.ByteStreams;
@@ -31,19 +30,22 @@
 
 final class IdeHook {
 	static class State extends NoLambda.EqualityBasedOnSerialization {
-		final @Nullable String path;
-		final boolean useStdIn;
-		final boolean useStdOut;
+		final Provider<String> path;
+		final Provider<Boolean> useStdIn;
+		final Provider<Boolean> useStdOut;
 
 		State(Project project) {
-			path = (String) project.findProperty(PROPERTY);
-			if (path != null) {
-				useStdIn = project.hasProperty(USE_STD_IN);
-				useStdOut = project.hasProperty(USE_STD_OUT);
-			} else {
-				useStdIn = false;
-				useStdOut = false;
-			}
+			this.path = project.getProviders().gradleProperty(PROPERTY);
+
+			this.useStdIn = path.map(path -> project.getProviders()
+					.gradleProperty(USE_STD_IN)
+					.isPresent())
+					.orElse(false);
+
+			this.useStdOut = path.map(path -> project.getProviders()
+					.gradleProperty(USE_STD_OUT)
+					.isPresent())
+					.orElse(false);
 		}
 	}
 
@@ -56,7 +58,7 @@ private static void dumpIsClean() {
 	}
 
 	static void performHook(SpotlessTaskImpl spotlessTask, IdeHook.State state) {
-		File file = new File(state.path);
+		File file = new File(state.path.get());
 		if (!file.isAbsolute()) {
 			System.err.println("Argument passed to " + PROPERTY + " must be an absolute path");
 			return;
@@ -71,7 +73,7 @@ static void performHook(SpotlessTaskImpl spotlessTask, IdeHook.State state) {
 					}
 				}
 				byte[] bytes;
-				if (state.useStdIn) {
+				if (state.useStdIn.get()) {
 					bytes = ByteStreams.toByteArray(System.in);
 				} else {
 					bytes = Files.readAllBytes(file.toPath());
@@ -84,7 +86,7 @@ static void performHook(SpotlessTaskImpl spotlessTask, IdeHook.State state) {
 					System.err.println("Run 'spotlessDiagnose' for details https://github.com/diffplug/spotless/blob/main/PADDEDCELL.md");
 				} else {
 					System.err.println("IS DIRTY");
-					if (state.useStdOut) {
+					if (state.useStdOut.get()) {
 						dirty.writeCanonicalTo(System.out);
 					} else {
 						dirty.writeCanonicalTo(file);

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

@@ -42,7 +42,7 @@ public void apply(Project project) {
 					+ "https://docs.gradle.org/current/userguide/building_java_projects.html#sec:java_cross_compilation");
 		}
 		// if -PspotlessModern=true, then use the modern stuff instead of the legacy stuff
-		if (project.hasProperty(SPOTLESS_MODERN)) {
+		if (project.getProviders().gradleProperty(SPOTLESS_MODERN).isPresent()) {
 			project.getLogger().warn("'spotlessModern' has no effect as of Spotless 5.0, recommend removing it.");
 		}
 		// make sure there's a `clean` and a `check`