Merge branch 'main' into topic/scalafmt-file-path

Author: nedtwigg

CHANGES.md

@@ -19,12 +19,14 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 * Bump default `shfmt` version to latest `3.7.0` -> `3.8.0`. ([#2050](https://github.com/diffplug/spotless/pull/2050))
 * Bump default `ktlint` version to latest `1.1.1` -> `1.2.1`. ([#2057](https://github.com/diffplug/spotless/pull/2057))
 * Bump default `sortpom` version to latest `3.4.0` -> `3.4.1`. ([#2078](https://github.com/diffplug/spotless/pull/2078))
+* Bump default `sortpom` version to latest `3.4.1` -> `4.0.0` and support versions back to `3.2.1`. ([#2115](https://github.com/diffplug/spotless/pull/2115))
 ### Removed
 * **BREAKING** Remove `JarState.getMavenCoordinate(String prefix)`. ([#1945](https://github.com/diffplug/spotless/pull/1945))
 * **BREAKING** Replace `PipeStepPair` with `FenceStep`. ([#1954](https://github.com/diffplug/spotless/pull/1954))
 ### Fixed
 * Ignore system git config when running tests ([#1990](https://github.com/diffplug/spotless/issues/1990))
 * Correctly provide EditorConfig property types for Ktlint ([#2052](https://github.com/diffplug/spotless/issues/2052))
+* Made ShadowCopy (`npmInstallCache`) more robust by re-creating the cache dir if it goes missing ([#1984](https://github.com/diffplug/spotless/issues/1984),[2096](https://github.com/diffplug/spotless/pull/2096))
 
 ## [2.45.0] - 2024-01-23
 ### Added

lib-extra/src/main/java/com/diffplug/spotless/extra/EquoBasedStepBuilder.java

@@ -53,12 +53,6 @@ public abstract class EquoBasedStepBuilder {
 	private Iterable<File> settingsFiles = new ArrayList<>();
 	private Map<String, String> p2Mirrors = Map.of();
 
-	/** @deprecated if you use this constructor you *must* call {@link #setVersion(String)} before calling {@link #build()} */
-	@Deprecated
-	public EquoBasedStepBuilder(String formatterName, Provisioner mavenProvisioner, SerializedFunction<State, FormatterFunc> stateToFormatter) {
-		this(formatterName, mavenProvisioner, null, stateToFormatter);
-	}
-
 	/** Initialize valid default configuration, taking latest version */
 	public EquoBasedStepBuilder(String formatterName, Provisioner mavenProvisioner, @Nullable String defaultVersion, SerializedFunction<State, FormatterFunc> stateToFormatter) {
 		this.formatterName = formatterName;

lib/build.gradle

@@ -128,7 +128,7 @@ dependencies {
 	// scalafmt
 	scalafmtCompileOnly "org.scalameta:scalafmt-core_2.13:3.7.3"
 	// sortPom
-	sortPomCompileOnly 'com.github.ekryd.sortpom:sortpom-sorter:3.4.1'
+	sortPomCompileOnly 'com.github.ekryd.sortpom:sortpom-sorter:4.0.0'
 	sortPomCompileOnly 'org.slf4j:slf4j-api:2.0.12'
 	// zjsonPatch
 	zjsonPatchCompileOnly 'com.flipkart.zjsonpatch:zjsonpatch:0.4.14'

lib/src/main/java/com/diffplug/spotless/FormatterFunc.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.
@@ -71,12 +71,6 @@ public String apply(String unix) throws Exception {
 			};
 		}
 
-		/** @deprecated synonym for {@link #ofDangerous(AutoCloseable, FormatterFunc)} */
-		@Deprecated
-		public static Closeable of(AutoCloseable closeable, FormatterFunc function) {
-			return ofDangerous(closeable, function);
-		}
-
 		@FunctionalInterface
 		interface ResourceFunc<T extends AutoCloseable> {
 			String apply(T resource, String unix) throws Exception;

lib/src/main/java/com/diffplug/spotless/FormatterStep.java

@@ -46,19 +46,6 @@ public interface FormatterStep extends Serializable, AutoCloseable {
 	@Nullable
 	String format(String rawUnix, File file) throws Exception;
 
-	/**
-	 * Returns a new FormatterStep which will only apply its changes
-	 * to files which pass the given filter.
-	 *
-	 * @param contentPattern
-	 *            java regular expression used to filter out files which content doesn't contain pattern
-	 * @return FormatterStep
-	 */
-	@Deprecated
-	default FormatterStep filterByContentPattern(String contentPattern) {
-		return filterByContent(OnMatch.INCLUDE, contentPattern);
-	}
-
 	/**
 	 * Returns a new {@code FormatterStep} which, observing the value of {@code formatIfMatches},
 	 * will only apply, or not, its changes to files which pass the given filter.

lib/src/main/java/com/diffplug/spotless/generic/PipeStepPair.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 DiffPlug
+ * Copyright 2023-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -38,11 +38,11 @@ public class NodeModulesCachingNpmProcessFactory implements NpmProcessFactory {
 
 	private NodeModulesCachingNpmProcessFactory(@Nonnull File cacheDir) {
 		this.cacheDir = Objects.requireNonNull(cacheDir);
-		assertDir(cacheDir);
-		this.shadowCopy = new ShadowCopy(cacheDir);
+		assertDir(); // throws if cacheDir is not a directory
+		this.shadowCopy = new ShadowCopy(this::assertDir);
 	}
 
-	private void assertDir(File cacheDir) {
+	private synchronized File assertDir() {
 		if (cacheDir.exists() && !cacheDir.isDirectory()) {
 			throw new IllegalArgumentException("Cache dir must be a directory");
 		}
@@ -51,6 +51,7 @@ private void assertDir(File cacheDir) {
 				throw new IllegalArgumentException("Cache dir could not be created.");
 			}
 		}
+		return cacheDir;
 	}
 
 	public static NodeModulesCachingNpmProcessFactory create(@Nonnull File cacheDir) {

lib/src/main/java/com/diffplug/spotless/npm/NodeModulesCachingNpmProcessFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 DiffPlug
+ * Copyright 2023-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,6 +27,7 @@
 import java.nio.file.attribute.BasicFileAttributes;
 import java.time.Duration;
 import java.util.concurrent.TimeoutException;
+import java.util.function.Supplier;
 
 import javax.annotation.Nonnull;
 
@@ -39,13 +40,18 @@ class ShadowCopy {
 
 	private static final Logger logger = LoggerFactory.getLogger(ShadowCopy.class);
 
-	private final File shadowCopyRoot;
+	private final Supplier<File> shadowCopyRootSupplier;
 
-	public ShadowCopy(@Nonnull File shadowCopyRoot) {
-		this.shadowCopyRoot = shadowCopyRoot;
+	public ShadowCopy(@Nonnull Supplier<File> shadowCopyRootSupplier) {
+		this.shadowCopyRootSupplier = shadowCopyRootSupplier;
+	}
+
+	private File shadowCopyRoot() {
+		File shadowCopyRoot = shadowCopyRootSupplier.get();
 		if (!shadowCopyRoot.isDirectory()) {
-			throw new IllegalArgumentException("Shadow copy root must be a directory: " + shadowCopyRoot);
+			throw new IllegalStateException("Shadow copy root must be a directory: " + shadowCopyRoot);
 		}
+		return shadowCopyRoot;
 	}
 
 	public void addEntry(String key, File orig) {
@@ -86,17 +92,17 @@ private void cleanupReservation(String key) {
 	}
 
 	private Path markerFilePath(String key) {
-		return Paths.get(shadowCopyRoot.getAbsolutePath(), key + ".marker");
+		return Paths.get(shadowCopyRoot().getAbsolutePath(), key + ".marker");
 	}
 
 	private File entry(String key, String origName) {
-		return Paths.get(shadowCopyRoot.getAbsolutePath(), key, origName).toFile();
+		return Paths.get(shadowCopyRoot().getAbsolutePath(), key, origName).toFile();
 	}
 
 	private boolean reserveSubFolder(String key) {
 		// put a marker file named "key".marker in "shadowCopyRoot" to make sure no other process is using it or return false if it already exists
 		try {
-			Files.createFile(Paths.get(shadowCopyRoot.getAbsolutePath(), key + ".marker"));
+			Files.createFile(Paths.get(shadowCopyRoot().getAbsolutePath(), key + ".marker"));
 			return true;
 		} catch (FileAlreadyExistsException e) {
 			return false;

lib/src/main/java/com/diffplug/spotless/npm/ShadowCopy.java

@@ -21,7 +21,7 @@
 public class SortPomCfg implements Serializable {
 	private static final long serialVersionUID = 1L;
 
-	public String version = "3.4.1";
+	public String version = "4.0.0";
 
 	public String encoding = "UTF-8";
 
@@ -41,6 +41,8 @@ public class SortPomCfg implements Serializable {
 
 	public boolean indentSchemaLocation = false;
 
+	public String indentAttribute = null;
+
 	public String predefinedSortOrder = "recommended_2008_06";
 
 	public String sortOrderFile = null;