Added support for generic NativeCmd step

CHANGES.md

@@ -10,6 +10,8 @@ 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]
+### Added
+* Added support for calling local binary formatters ([#949](https://github.com/diffplug/spotless/pull/949))
 ### Changed
 * Added support and bump Eclipse formatter default versions to `4.21` for `eclipse-cdt`, `eclipse-jdt`, `eclipse-wtp`. Change is only applied for JVM 11+.
 * Added `groupArtifact` option for `google-java-format` ([#944](https://github.com/diffplug/spotless/pull/944))

README.md

@@ -47,6 +47,7 @@ output = [
 lib('generic.EndWithNewlineStep')                +'{{yes}}       | {{yes}}      | {{no}}       | {{no}}  |',
 lib('generic.IndentStep')                        +'{{yes}}       | {{yes}}      | {{no}}       | {{no}}  |',
 lib('generic.LicenseHeaderStep')                 +'{{yes}}       | {{yes}}      | {{yes}}      | {{no}}  |',
+lib('generic.NativeCmdStep')                     +'{{no}}        | {{yes}}      | {{no}}      | {{no}}  |',
 lib('generic.ReplaceRegexStep')                  +'{{yes}}       | {{yes}}      | {{no}}       | {{no}}  |',
 lib('generic.ReplaceStep')                       +'{{yes}}       | {{yes}}      | {{no}}       | {{no}}  |',
 lib('generic.TrimTrailingWhitespaceStep')        +'{{yes}}       | {{yes}}      | {{no}}       | {{no}}  |',
@@ -83,6 +84,7 @@ extra('wtp.EclipseWtpFormatterStep')             +'{{yes}}       | {{yes}}
 | [`generic.EndWithNewlineStep`](lib/src/main/java/com/diffplug/spotless/generic/EndWithNewlineStep.java) | :+1:       | :+1:      | :white_large_square:       | :white_large_square:  |
 | [`generic.IndentStep`](lib/src/main/java/com/diffplug/spotless/generic/IndentStep.java) | :+1:       | :+1:      | :white_large_square:       | :white_large_square:  |
 | [`generic.LicenseHeaderStep`](lib/src/main/java/com/diffplug/spotless/generic/LicenseHeaderStep.java) | :+1:       | :+1:      | :+1:      | :white_large_square:  |
+| [`generic.NativeCmdStep`](lib/src/main/java/com/diffplug/spotless/generic/NativeCmdStep.java) | :white_large_square:        | :+1:      | :white_large_square:      | :white_large_square:  |
 | [`generic.ReplaceRegexStep`](lib/src/main/java/com/diffplug/spotless/generic/ReplaceRegexStep.java) | :+1:       | :+1:      | :white_large_square:       | :white_large_square:  |
 | [`generic.ReplaceStep`](lib/src/main/java/com/diffplug/spotless/generic/ReplaceStep.java) | :+1:       | :+1:      | :white_large_square:       | :white_large_square:  |
 | [`generic.TrimTrailingWhitespaceStep`](lib/src/main/java/com/diffplug/spotless/generic/TrimTrailingWhitespaceStep.java) | :+1:       | :+1:      | :white_large_square:       | :white_large_square:  |

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

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2021 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.generic;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.Serializable;
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Objects;
+
+import com.diffplug.spotless.FileSignature;
+import com.diffplug.spotless.FormatterFunc;
+import com.diffplug.spotless.FormatterStep;
+import com.diffplug.spotless.ProcessRunner;
+
+public class NativeCmdStep {
+	// prevent direct instantiation
+	private NativeCmdStep() {}
+
+	public static FormatterStep create(String name, File pathToExe, List<String> arguments) {
+		Objects.requireNonNull(name, "name");
+		Objects.requireNonNull(pathToExe, "pathToExe");
+		return FormatterStep.createLazy(name, () -> new State(FileSignature.signAsList(pathToExe), arguments), State::toFunc);
+	}
+
+	static class State implements Serializable {
+		private static final long serialVersionUID = 1L;
+
+		final FileSignature pathToExe;
+
+		final List<String> arguments;
+
+		State(FileSignature pathToExe, List<String> arguments) {
+			this.pathToExe = pathToExe;
+			this.arguments = arguments;
+		}
+
+		String format(ProcessRunner runner, String input) throws IOException, InterruptedException {
+			List<String> argumentsWithPathToExe = new ArrayList<>();
+			argumentsWithPathToExe.add(pathToExe.getOnlyFile().getAbsolutePath());
+			if (arguments != null) {
+				argumentsWithPathToExe.addAll(arguments);
+			}
+			return runner.exec(input.getBytes(StandardCharsets.UTF_8), argumentsWithPathToExe).assertExitZero(StandardCharsets.UTF_8);
+		}
+
+		FormatterFunc.Closeable toFunc() {
+			ProcessRunner runner = new ProcessRunner();
+			return FormatterFunc.Closeable.of(runner, this::format);
+		}
+	}
+}

plugin-maven/CHANGES.md

@@ -3,6 +3,8 @@
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`).
 
 ## [Unreleased]
+### Added
+* Added support for calling local binary formatters ([#949](https://github.com/diffplug/spotless/pull/949))
 ### Changed
 * Added support and bump Eclipse formatter default versions to `4.21` for `eclipse-cdt`, `eclipse-jdt`, `eclipse-wtp`. Change is only applied for JVM 11+.
 * Added `groupArtifact` option for `google-java-format` ([#944](https://github.com/diffplug/spotless/pull/944))

plugin-maven/README.md

@@ -769,6 +769,14 @@ to true.
   <spacesPerTab>4</spacesPerTab> <!-- optional, default is 4 -->
 </indent>
 
+<nativeCmd> <!-- run a native binary -->
+  <name>Greetings to Mars from sed</name>
+  <pathToExe>/usr/bin/sed</pathToExe> <!-- path to the binary, unformatted code is send via StdIn, formatted code is expected on StdOut -->
+  <arguments> <!-- optional, list with arguments for the binary call-->
+    <argument>s/World/Mars/g</argument>
+  </arguments>
+</nativeCmd>
+
 <replace> <!-- specify replacements using search and replace -->
   <name>Say Hello to Mars</name>
   <search>World</search>

plugin-maven/src/main/java/com/diffplug/spotless/maven/FormatterFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 DiffPlug
+ * Copyright 2016-2021 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -118,6 +118,10 @@ public final void addReplace(Replace replace) {
 		addStepFactory(replace);
 	}
 
+	public final void addNativeCmd(NativeCmd nativeCmd) {
+		addStepFactory(nativeCmd);
+	}
+
 	public final void addReplaceRegex(ReplaceRegex replaceRegex) {
 		addStepFactory(replaceRegex);
 	}

plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/NativeCmd.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2021 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.maven.generic;
+
+import java.io.File;
+import java.util.List;
+
+import org.apache.maven.plugins.annotations.Parameter;
+
+import com.diffplug.spotless.FormatterStep;
+import com.diffplug.spotless.generic.NativeCmdStep;
+import com.diffplug.spotless.maven.FormatterStepConfig;
+import com.diffplug.spotless.maven.FormatterStepFactory;
+
+public class NativeCmd implements FormatterStepFactory {
+
+	@Parameter
+	private String name;
+
+	@Parameter
+	private File pathToExe;
+
+	@Parameter
+	private List<String> arguments;
+
+	@Override
+	public FormatterStep newFormatterStep(FormatterStepConfig config) {
+		if (name == null || pathToExe == null) {
+			throw new IllegalArgumentException("Must specify 'name' and 'pathToExe'.");
+		}
+
+		return NativeCmdStep.create(name, pathToExe, arguments);
+	}
+}

plugin-maven/src/test/java/com/diffplug/spotless/maven/generic/NativeCmdTest.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2021 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.maven.generic;
+
+import static org.assertj.core.api.Assumptions.assumeThat;
+
+import java.io.File;
+
+import org.junit.jupiter.api.Test;
+
+import com.diffplug.spotless.maven.MavenIntegrationHarness;
+
+public class NativeCmdTest extends MavenIntegrationHarness {
+
+	@Test
+	public void fromStdInToStdOut() throws Exception {
+		// This will only work if /usr/bin/sed is available
+		assumeThat(new File("/usr/bin/sed")).exists();
+		writePomWithFormatSteps(
+				"<nativeCmd>",
+				"  <name>Greetings to Mars</name>",
+				"  <pathToExe>/usr/bin/sed</pathToExe>",
+				"  <arguments>",
+				"    <argument>s/World/Mars/g</argument>",
+				"  </arguments>",
+				"</nativeCmd>");
+		runTest("Hello World", "Hello Mars");
+	}
+
+	private void runTest(String sourceContent, String targetContent) throws Exception {
+		String path = "src/main/java/test.java";
+		setFile(path).toContent(sourceContent);
+		mavenRunner().withArguments("spotless:apply").runNoError();
+		assertFile(path).hasContent(targetContent);
+	}
+}