-
Notifications
You must be signed in to change notification settings - Fork 455
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
260 additions
and
21 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
99 changes: 99 additions & 0 deletions
99
lib/src/jackson/java/com/diffplug/spotless/glue/yaml/YamlJacksonFormatterFunc.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,99 @@ | ||
| /* | ||
| * Copyright 2021-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.spotless.glue.yaml; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.List; | ||
|
|
||
| import com.fasterxml.jackson.core.JsonProcessingException; | ||
| import com.fasterxml.jackson.core.type.TypeReference; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.fasterxml.jackson.databind.SerializationFeature; | ||
| import com.fasterxml.jackson.databind.node.ObjectNode; | ||
| import com.fasterxml.jackson.dataformat.yaml.YAMLFactory; | ||
|
|
||
| import com.diffplug.spotless.FormatterFunc; | ||
|
|
||
| public class YamlJacksonFormatterFunc implements FormatterFunc { | ||
| private List<String> enabledFeatures; | ||
| private List<String> disabledFeatures; | ||
|
|
||
| // private static final Logger logger = LoggerFactory.getLogger(YamlJacksonFormatterFunc.class); | ||
|
|
||
| public YamlJacksonFormatterFunc(List<String> enabledFeatures, List<String> disabledFeatures) { | ||
| this.enabledFeatures = enabledFeatures; | ||
| this.disabledFeatures = disabledFeatures; | ||
| } | ||
|
|
||
| @Override | ||
| public String apply(String input) throws Exception { | ||
| ObjectMapper objectMapper = makeObjectMapper(); | ||
|
|
||
| return format(objectMapper, input); | ||
| } | ||
|
|
||
| protected ObjectMapper makeObjectMapper() { | ||
| YAMLFactory yamlFactory = new YAMLFactory(); | ||
| ObjectMapper objectMapper = new ObjectMapper(yamlFactory); | ||
|
|
||
| // Configure the ObjectMapper | ||
| // https://github.com/FasterXML/jackson-databind#commonly-used-features | ||
| for (String rawFeature : enabledFeatures) { | ||
| // https://stackoverflow.com/questions/3735927/java-instantiating-an-enum-using-reflection | ||
| SerializationFeature feature = SerializationFeature.valueOf(rawFeature); | ||
|
|
||
| objectMapper.enable(feature); | ||
| } | ||
|
|
||
| for (String rawFeature : disabledFeatures) { | ||
| // https://stackoverflow.com/questions/3735927/java-instantiating-an-enum-using-reflection | ||
| SerializationFeature feature = SerializationFeature.valueOf(rawFeature); | ||
|
|
||
| objectMapper.disable(feature); | ||
| } | ||
| return objectMapper; | ||
| } | ||
|
|
||
| protected String format(ObjectMapper objectMapper, String input) throws IllegalArgumentException, IOException { | ||
| // We may consider adding manually an initial '---' prefix to help management of multiple documents | ||
| // if (!input.trim().startsWith("---")) { | ||
| // input = "---" + "\n" + input; | ||
| // } | ||
|
|
||
| try { | ||
| // https://stackoverflow.com/questions/25222327/deserialize-pojos-from-multiple-yaml-documents-in-a-single-file-in-jackson | ||
| // https://github.com/FasterXML/jackson-dataformats-text/issues/66#issuecomment-375328648 | ||
| // 2023-01: For now, we get 'Cannot deserialize value of type `com.fasterxml.jackson.databind.node.ObjectNode` from Array value' | ||
| // JsonParser yamlParser = objectMapper.getFactory().createParser(input); | ||
| // List<ObjectNode> docs = objectMapper.readValues(yamlParser, ObjectNode.class).readAll(); | ||
| // return objectMapper.writeValueAsString(docs); | ||
|
|
||
| // 2023-01: This returns JSON instead of YAML | ||
| // This will transit with a JsonNode | ||
| // A JsonNode may keep the comments from the input node | ||
| // JsonNode jsonNode = objectMapper.readTree(input); | ||
| //Not 'toPrettyString' as one could require no INDENT_OUTPUT | ||
| // return jsonNode.toPrettyString(); | ||
| ObjectNode objectNode = objectMapper.readValue(input, ObjectNode.class); | ||
| return objectMapper.writeValueAsString(objectNode); | ||
| } catch (JsonProcessingException e) { | ||
| throw new AssertionError("Unable to format YAML. input='" + input + "'", e); | ||
| } | ||
| } | ||
|
|
||
| // Spotbugs | ||
| private static class ObjectNodeTypeReference extends TypeReference<ObjectNode> {} | ||
| } |
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/yaml/YamlJacksonV2Step.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-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.spotless.yaml; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.Serializable; | ||
| import java.lang.reflect.Constructor; | ||
| import java.lang.reflect.InvocationTargetException; | ||
| import java.util.Arrays; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
|
|
||
| import com.diffplug.spotless.FormatterFunc; | ||
| import com.diffplug.spotless.FormatterStep; | ||
| import com.diffplug.spotless.JarState; | ||
| import com.diffplug.spotless.Provisioner; | ||
|
|
||
| public class YamlJacksonV2Step { | ||
| private YamlJacksonV2Step() {} | ||
|
|
||
| public static String defaultVersion() { | ||
| return YamlJacksonStep.DEFAULT_VERSION; | ||
| } | ||
|
|
||
| public static FormatterStep create(List<String> enabledFeatures, | ||
| List<String> disabledFeatures, | ||
| String jacksonVersion, | ||
| Provisioner provisioner) { | ||
| Objects.requireNonNull(provisioner, "provisioner cannot be null"); | ||
| return FormatterStep.createLazy("yaml", | ||
| () -> new State(enabledFeatures, disabledFeatures, jacksonVersion, provisioner), | ||
| State::toFormatter); | ||
| } | ||
|
|
||
| public static FormatterStep create(Provisioner provisioner) { | ||
| return create(Arrays.asList("INDENT_OUTPUT"), Arrays.asList(), defaultVersion(), provisioner); | ||
| } | ||
|
|
||
| private static final class State implements Serializable { | ||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| private final List<String> enabledFeatures; | ||
| private final List<String> disabledFeatures; | ||
|
|
||
| private final JarState jarState; | ||
|
|
||
| private State(List<String> enabledFeatures, | ||
| List<String> disabledFeatures, | ||
| String jacksonVersion, | ||
| Provisioner provisioner) throws IOException { | ||
| this.enabledFeatures = enabledFeatures; | ||
| this.disabledFeatures = disabledFeatures; | ||
|
|
||
| this.jarState = JarState.from(YamlJacksonStep.MAVEN_COORDINATE + jacksonVersion, provisioner); | ||
| } | ||
|
|
||
| FormatterFunc toFormatter() throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException, | ||
| InstantiationException, IllegalAccessException { | ||
| Class<?> formatterFunc = jarState.getClassLoader().loadClass("com.diffplug.spotless.glue.yaml.YamlJacksonFormatterFunc"); | ||
| Constructor<?> constructor = formatterFunc.getConstructor(List.class, List.class); | ||
| return (FormatterFunc) constructor.newInstance(enabledFeatures, disabledFeatures); | ||
| } | ||
| } | ||
| } |
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
Oops, something went wrong.