-
Notifications
You must be signed in to change notification settings - Fork 450
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 custom JSR-223 based formatters
- Loading branch information
Showing
8 changed files
with
200 additions
and
0 deletions.
There are no files selected for viewing
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
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
77 changes: 77 additions & 0 deletions
77
lib/src/main/java/com/diffplug/spotless/generic/Jsr223Step.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,77 @@ | ||
| /* | ||
| * 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.Serializable; | ||
| import java.util.Objects; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import javax.script.ScriptEngine; | ||
| import javax.script.ScriptEngineManager; | ||
|
|
||
| import com.diffplug.spotless.FormatterFunc; | ||
| import com.diffplug.spotless.FormatterStep; | ||
| import com.diffplug.spotless.JarState; | ||
| import com.diffplug.spotless.Provisioner; | ||
|
|
||
| public final class Jsr223Step { | ||
| // prevent direct instantiation | ||
| private Jsr223Step() {} | ||
|
|
||
| public static FormatterStep create(String name, String dependency, CharSequence engine, CharSequence script, Provisioner provisioner) { | ||
| Objects.requireNonNull(name, "name"); | ||
| Objects.requireNonNull(engine, "engine"); | ||
| Objects.requireNonNull(script, "script"); | ||
| return FormatterStep.createLazy(name, | ||
| () -> new State(dependency == null ? null : JarState.from(dependency, provisioner), engine, script), | ||
| State::toFormatter); | ||
| } | ||
|
|
||
| private static final class State implements Serializable { | ||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| private final JarState jarState; | ||
| private final String engine; | ||
| private final String script; | ||
|
|
||
| State(JarState jarState, CharSequence engine, CharSequence script) { | ||
| this.jarState = jarState; | ||
| this.engine = engine.toString(); | ||
| this.script = script.toString(); | ||
| } | ||
|
|
||
| FormatterFunc toFormatter() { | ||
| ScriptEngineManager scriptEngineManager; | ||
| if (jarState == null) { | ||
| scriptEngineManager = new ScriptEngineManager(ClassLoader.getSystemClassLoader()); | ||
| } else { | ||
| scriptEngineManager = new ScriptEngineManager(jarState.getClassLoader()); | ||
| } | ||
| ScriptEngine scriptEngine = scriptEngineManager.getEngineByName(engine); | ||
|
|
||
| if (scriptEngine == null) { | ||
| throw new IllegalArgumentException("Unknown script engine '" + engine + "'. Available engines: " + | ||
| scriptEngineManager.getEngineFactories().stream().flatMap(f -> f.getNames().stream()).collect(Collectors.joining(", "))); | ||
| } | ||
|
|
||
| // evaluate script code | ||
| return raw -> { | ||
| scriptEngine.put("source", raw); | ||
| return (String) scriptEngine.eval(script); | ||
| }; | ||
| } | ||
| } | ||
| } |
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
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
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
47 changes: 47 additions & 0 deletions
47
plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/Jsr223.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,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 org.apache.maven.plugins.annotations.Parameter; | ||
|
|
||
| import com.diffplug.spotless.FormatterStep; | ||
| import com.diffplug.spotless.generic.Jsr223Step; | ||
| import com.diffplug.spotless.maven.FormatterStepConfig; | ||
| import com.diffplug.spotless.maven.FormatterStepFactory; | ||
|
|
||
| public class Jsr223 implements FormatterStepFactory { | ||
|
|
||
| @Parameter | ||
| private String name; | ||
|
|
||
| @Parameter | ||
| private String dependency; | ||
|
|
||
| @Parameter | ||
| private String engine; | ||
|
|
||
| @Parameter | ||
| private String script; | ||
|
|
||
| @Override | ||
| public FormatterStep newFormatterStep(FormatterStepConfig config) { | ||
| if (name == null || engine == null || script == null) { | ||
| throw new IllegalArgumentException("Must specify 'name', 'engine' and 'script'."); | ||
| } | ||
|
|
||
| return Jsr223Step.create(name, dependency, engine, script, config.getProvisioner()); | ||
| } | ||
| } |
59 changes: 59 additions & 0 deletions
59
plugin-maven/src/test/java/com/diffplug/spotless/maven/generic/Jsr223Test.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,59 @@ | ||
| /* | ||
| * 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 javax.script.ScriptEngineManager; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import com.diffplug.spotless.maven.MavenIntegrationHarness; | ||
|
|
||
| public class Jsr223Test extends MavenIntegrationHarness { | ||
|
|
||
| @Test | ||
| public void buildInNashorn() throws Exception { | ||
| // This will only work for JDKs that bundle nashorn (8-14) | ||
| assumeThat(new ScriptEngineManager().getEngineByName("nashorn")).isNotNull(); | ||
| writePomWithFormatSteps( | ||
| "<jsr223>", | ||
| " <name>Greetings to Mars</name>", | ||
| " <engine>nashorn</engine>", | ||
| " <script>source.replace('World','Mars');</script>", | ||
| "</jsr223>"); | ||
| runTest("Hello World", "Hello Mars"); | ||
| } | ||
|
|
||
| @Test | ||
| public void groovyFromJarState() throws Exception { | ||
| writePomWithFormatSteps( | ||
| "<jsr223>", | ||
| " <name>Greetings to Mars</name>", | ||
| " <dependency>org.codehaus.groovy:groovy-jsr223:3.0.9</dependency>", | ||
| " <engine>groovy</engine>", | ||
| " <script>source.replace('World','Mars')</script>", | ||
| "</jsr223>"); | ||
| 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); | ||
| } | ||
| } |