feat: poc of cli (step 3)

Author: simschla

cli/src/main/java/com/diffplug/spotless/cli/SpotlessCLI.java

@@ -15,15 +15,17 @@
  */
 package com.diffplug.spotless.cli;
 
+import java.util.List;
+
 import com.diffplug.spotless.cli.execution.SpotlessExecutionStrategy;
 import com.diffplug.spotless.cli.subcommands.SpotlessApply;
 import com.diffplug.spotless.cli.subcommands.SpotlessCheck;
+import com.diffplug.spotless.cli.version.SpotlessCLIVersionProvider;
 
 import picocli.CommandLine;
 import picocli.CommandLine.Command;
 
-@Command(name = "spotless cli", mixinStandardHelpOptions = true, version = "spotless ${version}", // https://picocli.info/#_dynamic_version_information
-		description = "Runs spotless", subcommands = {SpotlessCheck.class, SpotlessApply.class})
+@Command(name = "spotless", mixinStandardHelpOptions = true, versionProvider = SpotlessCLIVersionProvider.class, description = "Runs spotless", subcommands = {SpotlessCheck.class, SpotlessApply.class})
 public class SpotlessCLI implements SpotlessCommand {
 
 	@CommandLine.Option(names = {"-V", "--version"}, versionHelp = true, description = "Print version information and exit")
@@ -32,9 +34,13 @@ public class SpotlessCLI implements SpotlessCommand {
 	@CommandLine.Option(names = {"-h", "--help"}, usageHelp = true, description = "display this help message")
 	boolean usageHelpRequested;
 
+	@CommandLine.Option(names = {"--target", "-t"}, required = true, arity = "1..*", description = "The target files to format", scope = CommandLine.ScopeType.INHERIT)
+	public List<String> targets;
+
 	public static void main(String... args) {
 		//		args = new String[]{"--version"};
-		args = new String[]{"apply", "license-header", "--header-file", "CHANGES.md", "--delimiter-for", "java", "license-header", "--header", "abc"};
+		//		args = new String[]{"apply", "license-header", "--header-file", "CHANGES.md", "--delimiter-for", "java", "license-header", "--header", "abc"};
+		args = new String[]{"apply", "--target", "src/poc/java/**/*.java", "license-header", "--header", "abc", "--delimiter-for", "java", "license-header", "--header-file", "TestHeader.txt"};
 		int exitCode = new CommandLine(new SpotlessCLI())
 				.setExecutionStrategy(new SpotlessExecutionStrategy())
 				.setCaseInsensitiveEnumValuesAllowed(true)

cli/src/main/java/com/diffplug/spotless/cli/core/TargetResolver.java

@@ -0,0 +1,110 @@
+/*
+ * Copyright 2024 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.spotless.cli.core;
+
+import static java.util.function.Predicate.not;
+
+import java.io.File;
+import java.nio.file.FileSystems;
+import java.nio.file.FileVisitOption;
+import java.nio.file.FileVisitResult;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.PathMatcher;
+import java.nio.file.SimpleFileVisitor;
+import java.nio.file.attribute.BasicFileAttributes;
+import java.util.ArrayList;
+import java.util.EnumSet;
+import java.util.List;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import com.diffplug.spotless.ThrowingEx;
+
+public class TargetResolver {
+
+	private final List<String> targets;
+
+	public TargetResolver(List<String> targets) {
+		this.targets = targets;
+	}
+
+	public Stream<Path> resolveTargets() {
+		return targets.stream()
+				.flatMap(this::resolveTarget);
+	}
+
+	private Stream<Path> resolveTarget(String target) {
+
+		final boolean isGlob = target.contains("*") || target.contains("?");
+
+		if (isGlob) {
+			return resolveGlob(target);
+		}
+		return resolveDir(Path.of(target));
+	}
+
+	private Stream<Path> resolveDir(Path startDir) {
+		List<Path> collected = new ArrayList<>();
+		ThrowingEx.run(() -> Files.walkFileTree(startDir,
+				EnumSet.of(FileVisitOption.FOLLOW_LINKS),
+				Integer.MAX_VALUE,
+				new SimpleFileVisitor<>() {
+					@Override
+					public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) {
+						collected.add(file);
+						return FileVisitResult.CONTINUE;
+					}
+				}));
+		return collected.stream();
+	}
+
+	private Stream<Path> resolveGlob(String glob) {
+		Path startDir;
+		String globPart;
+		// if the glob is absolute, we need to split the glob into its parts and use all parts except glob chars '*', '**', and '?'
+		String[] parts = glob.split("\\Q" + File.separator + "\\E");
+		List<String> startDirParts = Stream.of(parts)
+				.takeWhile(not(TargetResolver::isGlobPathPart))
+				.collect(Collectors.toList());
+
+		startDir = Path.of(glob.startsWith(File.separator) ? File.separator : "", startDirParts.toArray(String[]::new));
+		globPart = Stream.of(parts)
+				.skip(startDirParts.size())
+				.collect(Collectors.joining(File.separator));
+
+		PathMatcher matcher = FileSystems.getDefault().getPathMatcher("glob:" + globPart);
+		List<Path> collected = new ArrayList<>();
+		ThrowingEx.run(() -> Files.walkFileTree(startDir,
+				EnumSet.of(FileVisitOption.FOLLOW_LINKS),
+				Integer.MAX_VALUE,
+				new SimpleFileVisitor<>() {
+					@Override
+					public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) {
+						if (matcher.matches(file)) {
+							collected.add(file);
+						}
+						return FileVisitResult.CONTINUE;
+					}
+				}));
+		return collected.stream()
+				.map(Path::toAbsolutePath);
+	}
+
+	private static boolean isGlobPathPart(String part) {
+		return part.contains("*") || part.contains("?") || part.matches(".*\\[.*].*") || part.matches(".*\\{.*}.*");
+	}
+}

cli/src/main/java/com/diffplug/spotless/cli/subcommands/SpotlessActionSubCommand.java

@@ -15,11 +15,23 @@
  */
 package com.diffplug.spotless.cli.subcommands;
 
+import java.nio.charset.Charset;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.List;
+import java.util.stream.Collectors;
 
 import javax.annotation.Nonnull;
+import javax.xml.transform.Result;
 
+import com.diffplug.spotless.FormatExceptionPolicyStrict;
+import com.diffplug.spotless.Formatter;
 import com.diffplug.spotless.FormatterStep;
+import com.diffplug.spotless.LineEnding;
+import com.diffplug.spotless.ThrowingEx;
+import com.diffplug.spotless.cli.SpotlessCLI;
+import com.diffplug.spotless.cli.core.TargetResolver;
 import com.diffplug.spotless.cli.subcommands.steps.generic.LicenseHeader;
 import com.diffplug.spotless.cli.subcommands.steps.generic.RemoveMeLaterSubCommand;
 
@@ -35,10 +47,59 @@
 })
 public abstract class SpotlessActionSubCommand implements SpotlessActionCommand {
 
+	@CommandLine.ParentCommand
+	SpotlessCLI parent;
+
 	@Override
 	public Integer executeSpotlessAction(@Nonnull List<FormatterStep> formatterSteps) {
-		System.out.println("Hello " + getClass().getSimpleName() + ", abc!");
-		formatterSteps.forEach(step -> System.out.println("Step: " + step));
-		return 0;
+		TargetResolver targetResolver = new TargetResolver(parent.targets);
+
+		try (Formatter formatter = Formatter.builder()
+				.lineEndingsPolicy(LineEnding.UNIX.createPolicy())
+				.encoding(Charset.defaultCharset()) // TODO charset!
+				.rootDir(Paths.get(".")) // TODO root dir?
+				.steps(formatterSteps)
+				.exceptionPolicy(new FormatExceptionPolicyStrict())
+				.build()) {
+
+			boolean success = targetResolver.resolveTargets()
+					.parallel() // needed?
+					.map(target -> this.executeFormatter(formatter, target))
+					.filter(result -> result.success && result.updated != null)
+					.peek(this::writeBack)
+					.allMatch(result -> result.success);
+			System.out.println("Hello " + getClass().getSimpleName() + ", abc! Files: " + new TargetResolver(parent.targets).resolveTargets().collect(Collectors.toList()));
+			System.out.println("success: " + success);
+			formatterSteps.forEach(step -> System.out.println("Step: " + step));
+			return 0;
+		}
+	}
+
+	private Result executeFormatter(Formatter formatter, Path target) {
+		System.out.println("Formatting file: " + target + " in Thread " + Thread.currentThread().getName());
+		String targetContent = ThrowingEx.get(() -> Files.readString(target, Charset.defaultCharset())); // TODO charset!
+
+		String computed = formatter.compute(targetContent, target.toFile());
+		// computed is null if file already up to date
+		return new Result(target, true, computed);
+	}
+
+	private void writeBack(Result result) {
+		if (result.updated != null) {
+			ThrowingEx.run(() -> Files.writeString(result.target, result.updated, Charset.defaultCharset())); // TODO charset!
+		}
+		//		System.out.println("Writing back to file:" + result.target + " with content:\n" + result.updated);
+	}
+
+	private static final class Result {
+		private final Path target;
+		private final boolean success;
+		private final String updated;
+
+		public Result(Path target, boolean success, String updated) {
+			this.target = target;
+			this.success = success;
+			this.updated = updated;
+		}
 	}
 }

cli/src/main/java/com/diffplug/spotless/cli/subcommands/steps/generic/LicenseHeader.java

@@ -84,6 +84,7 @@ private ThrowingEx.Supplier<String> headerSource() {
 	}
 
 	private String delimiter() {
+		// TODO (simschla, 01.11.2024): here should somehow be automatically determined which type is needed (e.g. by file extension of files to be formatted)
 		if (licenseHeaderDelimiterOption == null) {
 			return DefaultDelimiterType.JAVA.delimiterExpression;
 		}

cli/src/main/java/com/diffplug/spotless/cli/version/SpotlessCLIVersionProvider.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024 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.spotless.cli.version;
+
+import picocli.CommandLine;
+
+public class SpotlessCLIVersionProvider implements CommandLine.IVersionProvider {
+
+	@Override
+	public String[] getVersion() throws Exception {
+		return new String[]{"Spotless CLI 1.0.0", "TODO"};
+	}
+}