Merge remote-tracking branch 'origin/main' into IntroduceCleanthatRefactorer

Author: blacelle

CHANGES.md

@@ -10,8 +10,13 @@ This document is intended for Spotless developers.
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`).
 
 ## [Unreleased]
+
+## [2.34.1] - 2023-02-05
 ### Changes
 * **POTENTIALLY BREAKING** Bump bytecode from Java 8 to 11 ([#1530](https://github.com/diffplug/spotless/pull/1530) part 2 of [#1337](https://github.com/diffplug/spotless/issues/1337))
+### Fixed
+* **POTENTIALLY BREAKING** `sortByKeys` for JSON formatting now takes into account objects inside arrays ([#1546](https://github.com/diffplug/spotless/pull/1546))
+* `freshmark` fixed on java 15+ ([#1304](https://github.com/diffplug/spotless/pull/1304) fixes [#803](https://github.com/diffplug/spotless/issues/803))
 
 ## [2.34.0] - 2023-01-26
 ### Added

CONTRIBUTING.md

@@ -207,7 +207,7 @@ If it doesn't work, you can check the JitPack log at `https://jitpack.io/com/git
 
 ### Maven
 
-Run `./gradlew publishToMavenLocal` to publish this to your local repository. The maven plugin is not published to JitPack due to [jitpack/jitpack.io#4112](https://github.com/jitpack/jitpack.io/issues/4112).
+Run `./gradlew publishToMavenLocal` to publish this to your local repository. You can also use the JitPack artifacts, using the same principles as Gradle above.
 
 ## License
 

gradle.properties

@@ -28,4 +28,4 @@ VER_DURIAN=1.2.0
 VER_JGIT=6.4.0.202211300538-r
 VER_JUNIT=5.9.2
 VER_ASSERTJ=3.24.2
-VER_MOCKITO=5.0.0
+VER_MOCKITO=5.1.1

gradle/java-publish.gradle

@@ -170,7 +170,11 @@ model {
 	}
 }
 
-if (!version.endsWith('-SNAPSHOT')) {
+if (System.env['JITPACK'] == 'true' || version.endsWith('-SNAPSHOT')) {
+	signing {
+		setRequired(false)
+	}
+} else {
 	signing {
 		String gpg_key = decode64('ORG_GRADLE_PROJECT_gpg_key64')
 		useInMemoryPgpKeys(gpg_key, System.env['ORG_GRADLE_PROJECT_gpg_passphrase'])

gradle/spotless-freshmark.gradle

@@ -1,30 +1,4 @@
 
-import java.util.regex.Matcher
-import java.util.regex.Pattern
-
-
-def thisVm() {
-	String jre = System.getProperty("java.version")
-	if (jre.startsWith("1.8")) {
-		return 8
-	} else {
-		Matcher matcher = Pattern.compile("(\\d+)").matcher(jre)
-		if (!matcher.find()) {
-			throw new IllegalArgumentException("Expected " + jre + " to start with an integer")
-		}
-		int version = Integer.parseInt(matcher.group(1))
-		if (version <= 8) {
-			throw new IllegalArgumentException("Expected " + jre + " to start with an integer greater than 8")
-		}
-		return version
-	}
-}
-
-if (thisVm() >= 15) {
-	// freshmark doesn't run on JRE 15+
-	return
-}
-
 apply plugin: 'com.diffplug.spotless'
 
 import com.diffplug.gradle.spotless.FreshMarkExtension

jitpack.yml

@@ -0,0 +1,2 @@
+jdk:
+  - openjdk11

lib-extra/src/main/java/com/diffplug/spotless/extra/GitAttributesLineEndings.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.
@@ -42,6 +42,8 @@
 import org.eclipse.jgit.storage.file.FileBasedConfig;
 import org.eclipse.jgit.util.FS;
 import org.eclipse.jgit.util.SystemReader;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import com.googlecode.concurrenttrees.radix.ConcurrentRadixTree;
 import com.googlecode.concurrenttrees.radix.node.concrete.DefaultCharSequenceNodeFactory;
@@ -61,6 +63,8 @@
  * back to the platform native.
  */
 public final class GitAttributesLineEndings {
+	private static final Logger LOGGER = LoggerFactory.getLogger(GitAttributesLineEndings.class);
+
 	// prevent direct instantiation
 	private GitAttributesLineEndings() {}
 
@@ -261,7 +265,7 @@ private static String convertEolToLineEnding(String eol, File file) {
 			case "crlf":
 				return LineEnding.WINDOWS.str();
 			default:
-				System.err.println(".gitattributes file has unspecified eol value: " + eol + " for " + file + ", defaulting to platform native");
+				LOGGER.warn(".gitattributes file has unspecified eol value: {} for {}, defaulting to platform native", eol, file);
 				return LineEnding.PLATFORM_NATIVE.str();
 			}
 		}
@@ -341,8 +345,7 @@ private static List<AttributesRule> parseRules(@Nullable File file) {
 				return parsed.getRules();
 			} catch (IOException e) {
 				// no need to crash the whole plugin
-				System.err.println("Problem parsing " + file.getAbsolutePath());
-				e.printStackTrace();
+				LOGGER.warn("Problem parsing {}", file.getAbsolutePath(), e);
 			}
 		}
 		return Collections.emptyList();

lib/src/gson/java/com/diffplug/spotless/glue/gson/GsonFormatterFunc.java

@@ -21,6 +21,7 @@
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
+import com.google.gson.JsonArray;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.stream.JsonWriter;
@@ -57,8 +58,8 @@ public String apply(String inputString) {
 			if (jsonElement == null) {
 				throw new AssertionError(FAILED_TO_PARSE_ERROR_MESSAGE);
 			}
-			if (gsonConfig.isSortByKeys() && jsonElement.isJsonObject()) {
-				jsonElement = sortByKeys(jsonElement.getAsJsonObject());
+			if (gsonConfig.isSortByKeys()) {
+				jsonElement = sortByKeys(jsonElement);
 			}
 			try (StringWriter stringWriter = new StringWriter()) {
 				JsonWriter jsonWriter = new JsonWriter(stringWriter);
@@ -72,19 +73,36 @@ public String apply(String inputString) {
 		return result;
 	}
 
+	private JsonElement sortByKeys(JsonElement jsonElement) {
+		if (jsonElement.isJsonArray()) {
+			return sortByKeys(jsonElement.getAsJsonArray());
+		} else if (jsonElement.isJsonObject()) {
+			return sortByKeys(jsonElement.getAsJsonObject());
+		} else {
+			return jsonElement;
+		}
+	}
+
 	private JsonElement sortByKeys(JsonObject jsonObject) {
 		JsonObject result = new JsonObject();
 		jsonObject.keySet().stream().sorted()
 				.forEach(key -> {
-					JsonElement element = jsonObject.get(key);
-					if (element.isJsonObject()) {
-						element = sortByKeys(element.getAsJsonObject());
-					}
-					result.add(key, element);
+					JsonElement sorted = sortByKeys(jsonObject.get(key));
+					result.add(key, sorted);
 				});
 		return result;
 	}
 
+	private JsonElement sortByKeys(JsonArray jsonArray) {
+		var result = new JsonArray();
+		for (JsonElement element : jsonArray) {
+			JsonElement sorted = sortByKeys(element);
+			result.add(sorted);
+		}
+
+		return result;
+	}
+
 	private String generateIndent(int indentSpaces) {
 		return String.join("", Collections.nCopies(indentSpaces, " "));
 	}

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

@@ -39,13 +39,16 @@
 public final class Formatter implements Serializable, AutoCloseable {
 	private static final long serialVersionUID = 1L;
 
+	// The name is used for logging purpose. It does not convey any applicative purpose
+	private String name;
 	private LineEnding.Policy lineEndingsPolicy;
 	private Charset encoding;
 	private Path rootDir;
 	private List<FormatterStep> steps;
 	private FormatExceptionPolicy exceptionPolicy;
 
-	private Formatter(LineEnding.Policy lineEndingsPolicy, Charset encoding, Path rootDirectory, List<FormatterStep> steps, FormatExceptionPolicy exceptionPolicy) {
+	private Formatter(String name, LineEnding.Policy lineEndingsPolicy, Charset encoding, Path rootDirectory, List<FormatterStep> steps, FormatExceptionPolicy exceptionPolicy) {
+		this.name = name;
 		this.lineEndingsPolicy = Objects.requireNonNull(lineEndingsPolicy, "lineEndingsPolicy");
 		this.encoding = Objects.requireNonNull(encoding, "encoding");
 		this.rootDir = Objects.requireNonNull(rootDirectory, "rootDir");
@@ -55,6 +58,7 @@ private Formatter(LineEnding.Policy lineEndingsPolicy, Charset encoding, Path ro
 
 	// override serialize output
 	private void writeObject(ObjectOutputStream out) throws IOException {
+		out.writeObject(name);
 		out.writeObject(lineEndingsPolicy);
 		out.writeObject(encoding.name());
 		out.writeObject(rootDir.toString());
@@ -65,6 +69,7 @@ private void writeObject(ObjectOutputStream out) throws IOException {
 	// override serialize input
 	@SuppressWarnings("unchecked")
 	private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
+		name = (String) in.readObject();
 		lineEndingsPolicy = (LineEnding.Policy) in.readObject();
 		encoding = Charset.forName((String) in.readObject());
 		rootDir = Paths.get((String) in.readObject());
@@ -78,6 +83,10 @@ private void readObjectNoData() throws ObjectStreamException {
 		throw new UnsupportedOperationException();
 	}
 
+	public String getName() {
+		return name;
+	}
+
 	public LineEnding.Policy getLineEndingsPolicy() {
 		return lineEndingsPolicy;
 	}
@@ -103,6 +112,8 @@ public static Formatter.Builder builder() {
 	}
 
 	public static class Builder {
+		// optional parameters
+		private String name = "unnamed";
 		// required parameters
 		private LineEnding.Policy lineEndingsPolicy;
 		private Charset encoding;
@@ -112,6 +123,11 @@ public static class Builder {
 
 		private Builder() {}
 
+		public Builder name(String name) {
+			this.name = name;
+			return this;
+		}
+
 		public Builder lineEndingsPolicy(LineEnding.Policy lineEndingsPolicy) {
 			this.lineEndingsPolicy = lineEndingsPolicy;
 			return this;
@@ -138,7 +154,7 @@ public Builder exceptionPolicy(FormatExceptionPolicy exceptionPolicy) {
 		}
 
 		public Formatter build() {
-			return new Formatter(lineEndingsPolicy, encoding, rootDir, steps,
+			return new Formatter(name, lineEndingsPolicy, encoding, rootDir, steps,
 					exceptionPolicy == null ? FormatExceptionPolicy.failOnlyOnError() : exceptionPolicy);
 		}
 	}
@@ -253,6 +269,7 @@ public String compute(String unix, File file) {
 	public int hashCode() {
 		final int prime = 31;
 		int result = 1;
+		result = prime * result + name.hashCode();
 		result = prime * result + encoding.hashCode();
 		result = prime * result + lineEndingsPolicy.hashCode();
 		result = prime * result + rootDir.hashCode();
@@ -273,7 +290,8 @@ public boolean equals(Object obj) {
 			return false;
 		}
 		Formatter other = (Formatter) obj;
-		return encoding.equals(other.encoding) &&
+		return name.equals(other.name) &&
+				encoding.equals(other.encoding) &&
 				lineEndingsPolicy.equals(other.lineEndingsPolicy) &&
 				rootDir.equals(other.rootDir) &&
 				steps.equals(other.steps) &&

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 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.
@@ -27,13 +27,18 @@
 
 import javax.annotation.Nullable;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 
 /**
  * Spotless' global cache. {@link SpotlessCache#clear()} should be called
  * when Spotless is no longer in use to release any resources it has grabbed.
  */
 public final class SpotlessCache {
+	private static final Logger LOGGER = LoggerFactory.getLogger(SpotlessCache.class);
+
 	/** Allows comparing keys based on their serialization. */
 	static final class SerializedKey {
 		final byte[] serialized;
@@ -68,7 +73,10 @@ synchronized ClassLoader classloader(JarState state) {
 	synchronized ClassLoader classloader(Serializable key, JarState state) {
 		SerializedKey serializedKey = new SerializedKey(key);
 		return cache
-				.computeIfAbsent(serializedKey, k -> new FeatureClassLoader(state.jarUrls(), this.getClass().getClassLoader()));
+				.computeIfAbsent(serializedKey, k -> {
+					LOGGER.debug("Allocating an additional FeatureClassLoader for key={} Cache.size was {}", key, cache.size());
+					return new FeatureClassLoader(state.jarUrls(), this.getClass().getClassLoader());
+				});
 	}
 
 	static SpotlessCache instance() {