Merge branch 'main' into support-filename

STAR-ZERO · STAR-ZERO · commit 40f1e8b3b865 · 2023-03-11T12:01:57.000+09:00
diff --git a/gradle.properties b/gradle.properties
@@ -32,4 +32,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.1.1
+VER_MOCKITO=5.2.0
diff --git a/lib/src/main/java/com/diffplug/spotless/generic/LicenseHeaderStep.java b/lib/src/main/java/com/diffplug/spotless/generic/LicenseHeaderStep.java
@@ -45,6 +45,7 @@
 
 /** Prefixes a license header before the package statement. */
 public final class LicenseHeaderStep {
+	public static final String DEFAULT_JAVA_HEADER_DELIMITER = "(package|import|public|class|module) ";
 	private static final Logger LOGGER = LoggerFactory.getLogger(LicenseHeaderStep.class);
 
 	public enum YearMode {
diff --git a/plugin-gradle/CHANGES.md b/plugin-gradle/CHANGES.md
@@ -5,6 +5,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ## [Unreleased]
 ### Added
 * You can now put the filename into a license header template with `$FILE`. ([#1605](https://github.com/diffplug/spotless/pull/1605) fixes [#1147](https://github.com/diffplug/spotless/issues/1147))
+* `licenseHeader` default pattern for Java files is updated to `(package|import|public|class|module) `. ([#1614](https://github.com/diffplug/spotless/pull/1614))
 
 ## [6.16.0] - 2023-02-27
 ### Added
diff --git a/plugin-gradle/README.md b/plugin-gradle/README.md
@@ -430,8 +430,8 @@ spotless {
 ```gradle
 spotless {
   scala {
-    // version and configFile, majorScalaVersion are all optional
-    scalafmt('3.5.9').configFile('scalafmt.conf').majorScalaVersion('2.13')
+    // version and configFile, scalaMajorVersion are all optional
+    scalafmt('3.5.9').configFile('scalafmt.conf').scalaMajorVersion('2.13')
 ```
 
 <a name="applying-to-cc-sources"></a>
diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/JavaExtension.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/JavaExtension.java
@@ -50,9 +50,7 @@ public JavaExtension(SpotlessExtension spotless) {
 		super(spotless);
 	}
 
-	// If this constant changes, don't forget to change the similarly-named one in
-	// testlib/src/test/java/com/diffplug/spotless/generic/LicenseHeaderStepTest.java as well
-	static final String LICENSE_HEADER_DELIMITER = "package ";
+	static final String LICENSE_HEADER_DELIMITER = LicenseHeaderStep.DEFAULT_JAVA_HEADER_DELIMITER;
 
 	@Override
 	public LicenseHeaderConfig licenseHeader(String licenseHeader) {
diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessTaskImpl.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessTaskImpl.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.
@@ -35,6 +35,7 @@
 import org.gradle.work.FileChange;
 import org.gradle.work.InputChanges;
 
+import com.diffplug.common.annotations.VisibleForTesting;
 import com.diffplug.common.base.StringPrinter;
 import com.diffplug.spotless.Formatter;
 import com.diffplug.spotless.PaddedCell;
@@ -92,28 +93,37 @@ public void performAction(InputChanges inputs) throws Exception {
 		}
 	}
 
-	private void processInputFile(@Nullable GitRatchet ratchet, Formatter formatter, File input) throws IOException {
+	@VisibleForTesting
+	void processInputFile(@Nullable GitRatchet ratchet, Formatter formatter, File input) throws IOException {
 		File output = getOutputFile(input);
-		getLogger().debug("Applying format to " + input + " and writing to " + output);
+		getLogger().debug("Applying format to {} and writing to {}", input, output);
 		PaddedCell.DirtyState dirtyState;
 		if (ratchet != null && ratchet.isClean(getProjectDir().get().getAsFile(), getRootTreeSha(), input)) {
 			dirtyState = PaddedCell.isClean();
 		} else {
-			dirtyState = PaddedCell.calculateDirtyState(formatter, input);
+			try {
+				dirtyState = PaddedCell.calculateDirtyState(formatter, input);
+			} catch (IOException e) {
+				throw new IOException("Issue processing file: " + input, e);
+			} catch (RuntimeException e) {
+				throw new IllegalArgumentException("Issue processing file: " + input, e);
+			}
 		}
 		if (dirtyState.isClean()) {
 			// Remove previous output if it exists
 			Files.deleteIfExists(output.toPath());
 		} else if (dirtyState.didNotConverge()) {
-			getLogger().warn("Skipping '" + input + "' because it does not converge.  Run {@code spotlessDiagnose} to understand why");
+			getLogger().warn("Skipping '{}' because it does not converge.  Run {@code spotlessDiagnose} to understand why", input);
 		} else {
 			Path parentDir = output.toPath().getParent();
 			if (parentDir == null) {
-				throw new IllegalStateException("Every file has a parent folder.");
+				throw new IllegalStateException("Every file has a parent folder. But not: " + output);
 			}
 			Files.createDirectories(parentDir);
 			// Need to copy the original file to the tmp location just to remember the file attributes
 			Files.copy(input.toPath(), output.toPath(), StandardCopyOption.REPLACE_EXISTING, StandardCopyOption.COPY_ATTRIBUTES);
+
+			getLogger().info(String.format("Writing clean file: %s", output));
 			dirtyState.writeCanonicalTo(output);
 		}
 	}
diff --git a/plugin-gradle/src/test/java/com/diffplug/gradle/spotless/SpotlessTaskImplTest.java b/plugin-gradle/src/test/java/com/diffplug/gradle/spotless/SpotlessTaskImplTest.java
@@ -0,0 +1,46 @@
+/*
+ * Copyright 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.File;
+import java.nio.file.Paths;
+
+import org.assertj.core.api.Assertions;
+import org.gradle.api.file.DirectoryProperty;
+import org.gradle.api.logging.Logger;
+import org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
+
+import com.diffplug.spotless.Formatter;
+
+public class SpotlessTaskImplTest {
+	@Test
+	public void testThrowsMessageContainsFilename() throws Exception {
+		SpotlessTaskImpl task = Mockito.mock(SpotlessTaskImpl.class, Mockito.CALLS_REAL_METHODS);
+		Mockito.when(task.getLogger()).thenReturn(Mockito.mock(Logger.class));
+
+		File projectDir = Paths.get("unitTests", "projectDir").toFile();
+		DirectoryProperty projectDirProperty = Mockito.mock(DirectoryProperty.class, Mockito.RETURNS_DEEP_STUBS);
+		Mockito.when(projectDirProperty.get().getAsFile()).thenReturn(projectDir);
+
+		Mockito.when(task.getProjectDir()).thenReturn(projectDirProperty);
+
+		File input = Paths.get("unitTests", "projectDir", "someInput").toFile();
+		Formatter formatter = Mockito.mock(Formatter.class);
+
+		Assertions.assertThatThrownBy(() -> task.processInputFile(null, formatter, input)).hasMessageContaining(input.toString());
+	}
+}
diff --git a/plugin-maven/CHANGES.md b/plugin-maven/CHANGES.md
@@ -5,6 +5,8 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ## [Unreleased]
 ### Added
 * You can now put the filename into a license header template with `$FILE`. ([#1605](https://github.com/diffplug/spotless/pull/1605) fixes [#1147](https://github.com/diffplug/spotless/issues/1147))
+### Fixed
+* `licenseHeader` default pattern for Java files is updated to `(package|import|public|class|module) `. ([#1614](https://github.com/diffplug/spotless/pull/1614))
 
 ## [2.34.0] - 2023-02-27
 ### Added
diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/SpotlessApplyMojo.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/SpotlessApplyMojo.java
@@ -54,7 +54,7 @@ protected void process(Iterable<File> files, Formatter formatter, UpToDateChecke
 				} else {
 					counter.checkedButAlreadyClean();
 				}
-			} catch (IOException e) {
+			} catch (IOException | RuntimeException e) {
 				throw new MojoExecutionException("Unable to format file " + file, e);
 			}
 
diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/SpotlessCheckMojo.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/SpotlessCheckMojo.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.
@@ -38,9 +38,12 @@ public class SpotlessCheckMojo extends AbstractSpotlessMojo {
 
 	@Override
 	protected void process(Iterable<File> files, Formatter formatter, UpToDateChecker upToDateChecker) throws MojoExecutionException {
+		ImpactedFilesTracker counter = new ImpactedFilesTracker();
+
 		List<File> problemFiles = new ArrayList<>();
 		for (File file : files) {
 			if (upToDateChecker.isUpToDate(file.toPath())) {
+				counter.skippedAsCleanCache();
 				if (getLog().isDebugEnabled()) {
 					getLog().debug("Spotless will not check an up-to-date file: " + file);
 				}
@@ -51,14 +54,24 @@ protected void process(Iterable<File> files, Formatter formatter, UpToDateChecke
 				PaddedCell.DirtyState dirtyState = PaddedCell.calculateDirtyState(formatter, file);
 				if (!dirtyState.isClean() && !dirtyState.didNotConverge()) {
 					problemFiles.add(file);
+					counter.cleaned();
 				} else {
+					counter.checkedButAlreadyClean();
 					upToDateChecker.setUpToDate(file.toPath());
 				}
-			} catch (IOException e) {
+			} catch (IOException | RuntimeException e) {
 				throw new MojoExecutionException("Unable to format file " + file, e);
 			}
 		}
 
+		// We print the number of considered files which is useful when ratchetFrom is setup
+		if (counter.getTotal() > 0) {
+			getLog().info(String.format("Spotless.%s is keeping %s files clean - %s needs changes to be clean, %s were already clean, %s were skipped because caching determined they were already clean",
+					formatter.getName(), counter.getTotal(), counter.getCleaned(), counter.getCheckedButAlreadyClean(), counter.getSkippedAsCleanCache()));
+		} else {
+			getLog().debug(String.format("Spotless.%s has no target files. Examine your `<includes>`: https://github.com/diffplug/spotless/tree/main/plugin-maven#quickstart", formatter.getName()));
+		}
+
 		if (!problemFiles.isEmpty()) {
 			throw new MojoExecutionException(DiffMessageFormatter.builder()
 					.runToFix("Run 'mvn spotless:apply' to fix these violations.")
diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/groovy/Groovy.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/groovy/Groovy.java
@@ -20,6 +20,7 @@
 import org.apache.maven.project.MavenProject;
 
 import com.diffplug.common.collect.ImmutableSet;
+import com.diffplug.spotless.generic.LicenseHeaderStep;
 import com.diffplug.spotless.maven.FormatterFactory;
 import com.diffplug.spotless.maven.generic.LicenseHeader;
 
@@ -32,7 +33,7 @@
 public class Groovy extends FormatterFactory {
 
 	private static final Set<String> DEFAULT_INCLUDES = ImmutableSet.of("src/main/groovy/**/*.groovy", "src/test/groovy/**/*.groovy");
-	private static final String LICENSE_HEADER_DELIMITER = "package ";
+	private static final String LICENSE_HEADER_DELIMITER = LicenseHeaderStep.DEFAULT_JAVA_HEADER_DELIMITER;
 
 	@Override
 	public Set<String> defaultIncludes(MavenProject project) {
diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/java/Java.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/java/Java.java
@@ -26,6 +26,7 @@
 import org.apache.maven.model.Build;
 import org.apache.maven.project.MavenProject;
 
+import com.diffplug.spotless.generic.LicenseHeaderStep;
 import com.diffplug.spotless.maven.FormatterFactory;
 import com.diffplug.spotless.maven.generic.LicenseHeader;
 
@@ -37,7 +38,7 @@
  */
 public class Java extends FormatterFactory {
 
-	private static final String LICENSE_HEADER_DELIMITER = "package ";
+	private static final String LICENSE_HEADER_DELIMITER = LicenseHeaderStep.DEFAULT_JAVA_HEADER_DELIMITER;
 
 	@Override
 	public Set<String> defaultIncludes(MavenProject project) {
diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/scala/Scala.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/scala/Scala.java
@@ -20,6 +20,7 @@
 import org.apache.maven.project.MavenProject;
 
 import com.diffplug.common.collect.ImmutableSet;
+import com.diffplug.spotless.generic.LicenseHeaderStep;
 import com.diffplug.spotless.maven.FormatterFactory;
 import com.diffplug.spotless.maven.generic.LicenseHeader;
 
@@ -33,7 +34,7 @@ public class Scala extends FormatterFactory {
 
 	private static final Set<String> DEFAULT_INCLUDES = ImmutableSet.of("src/main/scala/**/*.scala",
 			"src/test/scala/**/*.scala", "src/main/scala/**/*.sc", "src/test/scala/**/*.sc");
-	private static final String LICENSE_HEADER_DELIMITER = "package ";
+	private static final String LICENSE_HEADER_DELIMITER = LicenseHeaderStep.DEFAULT_JAVA_HEADER_DELIMITER;
 
 	@Override
 	public Set<String> defaultIncludes(MavenProject project) {
diff --git a/settings.gradle b/settings.gradle
@@ -10,7 +10,7 @@ plugins {
 	// https://plugins.gradle.org/plugin/com.gradle.plugin-publish
 	id 'com.gradle.plugin-publish' version '1.1.0' apply false
 	// https://github.com/gradle-nexus/publish-plugin/releases
-	id 'io.github.gradle-nexus.publish-plugin' version '1.2.0' apply false
+	id 'io.github.gradle-nexus.publish-plugin' version '1.3.0' apply false
 	// https://github.com/spotbugs/spotbugs-gradle-plugin/releases
 	id 'com.github.spotbugs' version '5.0.13' apply false
 	// https://github.com/diffplug/spotless-changelog/blob/main/CHANGELOG.md
@@ -23,7 +23,7 @@ plugins {
 	// https://github.com/davidburstrom/version-compatibility-gradle-plugin/tags
 	id 'io.github.davidburstrom.version-compatibility' version '0.4.0' apply false
 	// https://plugins.gradle.org/plugin/com.gradle.enterprise
-	id 'com.gradle.enterprise' version '3.12.3'
+	id 'com.gradle.enterprise' version '3.12.4'
 }
 
 dependencyResolutionManagement {
diff --git a/testlib/src/main/resources/license/HelloWorld_java.test b/testlib/src/main/resources/license/HelloWorld_java.test
@@ -0,0 +1,5 @@
+public class HelloWorld {
+	public static void main(String[] args) {
+		System.out.print("Hello World");
+	}
+}
diff --git a/testlib/src/main/resources/license/HelloWorld_withImport_java.test b/testlib/src/main/resources/license/HelloWorld_withImport_java.test
@@ -0,0 +1,7 @@
+import java.time.LocalDate;
+
+public class HelloWorld {
+	public static void main(String[] args) {
+		System.out.print("Hello World. Date: " + LocalDate.now());
+	}
+}
diff --git a/testlib/src/main/resources/license/module-info.test b/testlib/src/main/resources/license/module-info.test
@@ -0,0 +1,5 @@
+module java.sql {
+   exports java.sql;
+   exports javax.sql;
+   exports javax.transaction.xa;
+}
diff --git a/testlib/src/test/java/com/diffplug/spotless/generic/LicenseHeaderStepTest.java b/testlib/src/test/java/com/diffplug/spotless/generic/LicenseHeaderStepTest.java
@@ -33,7 +33,7 @@
 
 class LicenseHeaderStepTest extends ResourceHarness {
 	private static final String FILE_NO_LICENSE = "license/FileWithoutLicenseHeader.test";
-	private static final String package_ = "package ";
+	private static final String package_ = LicenseHeaderStep.DEFAULT_JAVA_HEADER_DELIMITER;
 	private static final String HEADER_WITH_$YEAR = "This is a fake license, $YEAR. ACME corp.";
 	private static final String HEADER_WITH_RANGE_TO_$YEAR = "This is a fake license with range, 2009-$YEAR. ACME corp.";
 	private static final String HEADER_WITH_$FILE = "This is a fake license, $FILE. ACME corp.";
@@ -286,12 +286,29 @@ void should_update_license_containing_filename_token() throws Exception {
 	void should_apply_license_containing_YEAR_filename_token() throws Exception {
 		FormatterStep step = LicenseHeaderStep.headerDelimiter(header(HEADER_WITH_$YEAR_$FILE), package_).build();
 		StepHarnessWithFile.forStep(this, step)
-				.test(
-						new File("Test.java"),
-						getTestResource(FILE_NO_LICENSE),
-						hasHeaderYearFileName(HEADER_WITH_$YEAR_$FILE, currentYear(), "Test.java"))
-				.testUnaffected(
-						new File("Test.java"),
-						hasHeaderYearFileName(HEADER_WITH_$YEAR_$FILE, currentYear(), "Test.java"));
+			.test(
+				new File("Test.java"),
+				getTestResource(FILE_NO_LICENSE),
+				hasHeaderYearFileName(HEADER_WITH_$YEAR_$FILE, currentYear(), "Test.java"))
+			.testUnaffected(
+				new File("Test.java"),
+				hasHeaderYearFileName(HEADER_WITH_$YEAR_$FILE, currentYear(), "Test.java"));
+	}
+
+	void noPackage() throws Throwable {
+		String header = header(getTestResource("license/TestLicense"));
+		FormatterStep step = LicenseHeaderStep.headerDelimiter(header, package_).build();
+		StepHarness.forStep(step)
+				.test(ResourceHarness.getTestResource("license/HelloWorld_java.test"), header + ResourceHarness.getTestResource("license/HelloWorld_java.test"))
+				.test(ResourceHarness.getTestResource("license/HelloWorld_withImport_java.test"), header + ResourceHarness.getTestResource("license/HelloWorld_withImport_java.test"));
+	}
+
+	// The following demonstrate the use of 'module' keyword
+	@Test
+	void moduleInfo() throws Throwable {
+		String header = header(getTestResource("license/TestLicense"));
+		FormatterStep step = LicenseHeaderStep.headerDelimiter(header, package_).build();
+		StepHarness.forStep(step)
+				.test(ResourceHarness.getTestResource("license/module-info.test"), header + ResourceHarness.getTestResource("license/module-info.test"));
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -50,9 +50,7 @@ public JavaExtension(SpotlessExtension spotless) {`
`50`	`50`	`super(spotless);`
`51`	`51`	`}`
`52`	`52`
`53`		`- // If this constant changes, don't forget to change the similarly-named one in`
`54`		`- // testlib/src/test/java/com/diffplug/spotless/generic/LicenseHeaderStepTest.java as well`
`55`		`- static final String LICENSE_HEADER_DELIMITER = "package ";`
	`53`	`+ static final String LICENSE_HEADER_DELIMITER = LicenseHeaderStep.DEFAULT_JAVA_HEADER_DELIMITER;`
`56`	`54`
`57`	`55`	`@Override`
`58`	`56`	`public LicenseHeaderConfig licenseHeader(String licenseHeader) {`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ protected void process(Iterable<File> files, Formatter formatter, UpToDateChecke`
`54`	`54`	`} else {`
`55`	`55`	`counter.checkedButAlreadyClean();`
`56`	`56`	`}`
`57`		`- } catch (IOException e) {`
	`57`	`+ } catch (IOException \| RuntimeException e) {`
`58`	`58`	`throw new MojoExecutionException("Unable to format file " + file, e);`
`59`	`59`	`}`
`60`	`60`