-
Notifications
You must be signed in to change notification settings - Fork 459
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added support for generic NativeCmd step
- Loading branch information
Showing
4 changed files
with
158 additions
and
0 deletions.
There are no files selected for viewing
65 changes: 65 additions & 0 deletions
65
lib/src/main/java/com/diffplug/spotless/generic/NativeCmdStep.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
/* | ||
* 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.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.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, String pathToExe, List<String> arguments) { | ||
Objects.requireNonNull(name, "name"); | ||
Objects.requireNonNull(pathToExe, "pathToExe"); | ||
List<String> argumentsWithPathToExe = new ArrayList<>(); | ||
argumentsWithPathToExe.add(pathToExe); | ||
if (arguments != null) { | ||
argumentsWithPathToExe.addAll(arguments); | ||
} | ||
return FormatterStep.createLazy(name, () -> new State(pathToExe, argumentsWithPathToExe), State::toFunc); | ||
} | ||
|
||
static class State implements Serializable { | ||
private static final long serialVersionUID = 1L; | ||
|
||
final String pathToExe; | ||
|
||
final List<String> arguments; | ||
|
||
State(String pathToExe, List<String> arguments) { | ||
this.pathToExe = pathToExe; | ||
this.arguments = arguments; | ||
} | ||
|
||
String format(ProcessRunner runner, String input) throws IOException, InterruptedException { | ||
return runner.exec(input.getBytes(StandardCharsets.UTF_8), arguments).assertExitZero(StandardCharsets.UTF_8); | ||
} | ||
|
||
FormatterFunc.Closeable toFunc() { | ||
ProcessRunner runner = new ProcessRunner(); | ||
return FormatterFunc.Closeable.of(runner, this::format); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletions
46
plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/NativeCmd.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
/* | ||
* 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.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 String 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); | ||
} | ||
} |
43 changes: 43 additions & 0 deletions
43
plugin-maven/src/test/java/com/diffplug/spotless/maven/generic/NativeCmdTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
/* | ||
* 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 org.junit.Test; | ||
|
||
import com.diffplug.spotless.maven.MavenIntegrationHarness; | ||
|
||
public class NativeCmdTest extends MavenIntegrationHarness { | ||
|
||
@Test | ||
public void fromStdOutToStdOut() throws Exception { | ||
writePomWithFormatSteps( | ||
"<nativeCmd>", | ||
" <name>Greetings to Mars</name>", | ||
" <pathToExe>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); | ||
} | ||
} |