CAMEL-10696: build our own json-simple-order parser that is patched to preserve the order which is needed by Camel
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/5cf67b3a Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/5cf67b3a Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/5cf67b3a Branch: refs/heads/json-simple Commit: 5cf67b3a11531f0a52438933b3a79e7bda7c875e Parents: af1dd3a Author: Claus Ibsen <davscl...@apache.org> Authored: Sun Sep 24 13:23:21 2017 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Sun Sep 24 13:23:21 2017 +0200 ---------------------------------------------------------------------- tooling/json-simple-ordered/pom.xml | 114 +++++++++++ .../src/main/java/.gitignore | 2 + .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 14 ++ .../json/simple/JsonSimpleOrderedTest.java | 90 ++++++++ .../src/test/resources/bean.json | 33 +++ tooling/pom.xml | 1 + 7 files changed, 457 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/5cf67b3a/tooling/json-simple-ordered/pom.xml ---------------------------------------------------------------------- diff --git a/tooling/json-simple-ordered/pom.xml b/tooling/json-simple-ordered/pom.xml new file mode 100644 index 0000000..388ee17 --- /dev/null +++ b/tooling/json-simple-ordered/pom.xml @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You 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. + +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.camel</groupId> + <artifactId>tooling</artifactId> + <version>2.20.0-SNAPSHOT</version> + </parent> + + <!-- should not be OSGi bundle as we shade this component into camel-core and camel-catalog --> + + <artifactId>json-simple-ordered</artifactId> + <name>Camel :: JSon Simple Ordered</name> + <description>A patched json-simple parser that preserves the ordering in Map as read from JSon source</description> + + <!-- TODO: this is only needed until https://github.com/cliftonlabs/json-simple/issues/17 is fixed and released --> + + <dependencies> + + <!-- json parser --> + <dependency> + <groupId>com.github.cliftonlabs</groupId> + <artifactId>json-simple</artifactId> + <version>${json-simple2-version}</version> + <scope>provided</scope> + </dependency> + + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <scope>test</scope> + </dependency> + </dependencies> + + <build> + <plugins> + + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-dependency-plugin</artifactId> + <version>3.0.2</version> + <executions> + <execution> + <id>unpack-source</id> + <phase>initialize</phase> + <goals> + <goal>unpack-dependencies</goal> + </goals> + <configuration> + <classifier>sources</classifier> + <includeGroupIds>com.github.cliftonlabs</includeGroupIds> + <outputDirectory>src/main/java</outputDirectory> + <excludes>META-INF/**,**/JSONArray.java,**/JSONObject.java</excludes> + </configuration> + </execution> + </executions> + </plugin> + + <!-- patch json-simple --> + <plugin> + <groupId>com.google.code.maven-replacer-plugin</groupId> + <artifactId>replacer</artifactId> + <version>1.5.3</version> + <executions> + <execution> + <phase>generate-sources</phase> + <goals> + <goal>replace</goal> + </goals> + </execution> + </executions> + <configuration> + <includes> + <include>${basedir}/src/main/java/org/json/simple/JsonObject.java</include> + </includes> + <replacements> + <replacement> + <token>import java.util.HashMap;</token> + <value>import java.util.LinkedHashMap;</value> + </replacement> + <replacement> + <token>public class JsonObject extends HashMap</token> + <value>public class JsonObject extends LinkedHashMap</value> + </replacement> + </replacements> + </configuration> + </plugin> + + </plugins> + + </build> + +</project> http://git-wip-us.apache.org/repos/asf/camel/blob/5cf67b3a/tooling/json-simple-ordered/src/main/java/.gitignore ---------------------------------------------------------------------- diff --git a/tooling/json-simple-ordered/src/main/java/.gitignore b/tooling/json-simple-ordered/src/main/java/.gitignore new file mode 100644 index 0000000..3bd67e5 --- /dev/null +++ b/tooling/json-simple-ordered/src/main/java/.gitignore @@ -0,0 +1,2 @@ +# source file is copied from archive and rebuild each time +org \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/5cf67b3a/tooling/json-simple-ordered/src/main/resources/META-INF/LICENSE.txt ---------------------------------------------------------------------- diff --git a/tooling/json-simple-ordered/src/main/resources/META-INF/LICENSE.txt b/tooling/json-simple-ordered/src/main/resources/META-INF/LICENSE.txt new file mode 100755 index 0000000..6b0b127 --- /dev/null +++ b/tooling/json-simple-ordered/src/main/resources/META-INF/LICENSE.txt @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. + http://git-wip-us.apache.org/repos/asf/camel/blob/5cf67b3a/tooling/json-simple-ordered/src/main/resources/META-INF/NOTICE.txt ---------------------------------------------------------------------- diff --git a/tooling/json-simple-ordered/src/main/resources/META-INF/NOTICE.txt b/tooling/json-simple-ordered/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 0000000..0291ff5 --- /dev/null +++ b/tooling/json-simple-ordered/src/main/resources/META-INF/NOTICE.txt @@ -0,0 +1,14 @@ + ========================================================================= + == NOTICE file corresponding to the section 4 d of == + == the Apache License, Version 2.0, == + == in this case for the Apache Camel distribution. == + ========================================================================= + + This product includes software developed by + The Apache Software Foundation (http://www.apache.org/). + + This product includes software developed by + Clifton Labs (https://github.com/cliftonlabs/json-simple). + + Please read the different LICENSE files present in the licenses directory of + this distribution. http://git-wip-us.apache.org/repos/asf/camel/blob/5cf67b3a/tooling/json-simple-ordered/src/test/java/org/apache/camel/json/simple/JsonSimpleOrderedTest.java ---------------------------------------------------------------------- diff --git a/tooling/json-simple-ordered/src/test/java/org/apache/camel/json/simple/JsonSimpleOrderedTest.java b/tooling/json-simple-ordered/src/test/java/org/apache/camel/json/simple/JsonSimpleOrderedTest.java new file mode 100644 index 0000000..f6ff70f --- /dev/null +++ b/tooling/json-simple-ordered/src/test/java/org/apache/camel/json/simple/JsonSimpleOrderedTest.java @@ -0,0 +1,90 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.camel.json.simple; + +import java.io.BufferedReader; +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.util.Iterator; +import java.util.LinkedHashMap; +import java.util.Map; + +import junit.framework.TestCase; +import org.json.simple.JsonObject; +import org.json.simple.Jsoner; +import org.junit.Test; + +public class JsonSimpleOrderedTest extends TestCase { + + @Test + public void testOrdered() throws Exception { + InputStream is = new FileInputStream("src/test/resources/bean.json"); + String json = loadText(is); + JsonObject output = Jsoner.deserialize(json, new JsonObject()); + + assertNotNull(output); + + // should preserve order + Map map = output.getMap("component"); + assertTrue(map instanceof LinkedHashMap); + Iterator it = map.keySet().iterator(); + assertEquals("kind", it.next()); + assertEquals("scheme", it.next()); + assertEquals("syntax", it.next()); + assertEquals("title", it.next()); + assertEquals("description", it.next()); + assertEquals("label", it.next()); + assertEquals("deprecated", it.next()); + assertEquals("deprecationNote", it.next()); + assertEquals("async", it.next()); + assertEquals("consumerOnly", it.next()); + assertEquals("producerOnly", it.next()); + assertEquals("lenientProperties", it.next()); + assertEquals("javaType", it.next()); + assertEquals("firstVersion", it.next()); + assertEquals("groupId", it.next()); + assertEquals("artifactId", it.next()); + assertEquals("version", it.next()); + assertFalse(it.hasNext()); + } + + public static String loadText(InputStream in) throws IOException { + StringBuilder builder = new StringBuilder(); + InputStreamReader isr = new InputStreamReader(in); + + try { + BufferedReader reader = new BufferedReader(isr); + + while(true) { + String line = reader.readLine(); + if (line == null) { + line = builder.toString(); + return line; + } + + builder.append(line); + builder.append("\n"); + } + } finally { + isr.close(); + in.close(); + } + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/5cf67b3a/tooling/json-simple-ordered/src/test/resources/bean.json ---------------------------------------------------------------------- diff --git a/tooling/json-simple-ordered/src/test/resources/bean.json b/tooling/json-simple-ordered/src/test/resources/bean.json new file mode 100644 index 0000000..5ef9f54 --- /dev/null +++ b/tooling/json-simple-ordered/src/test/resources/bean.json @@ -0,0 +1,33 @@ +{ + "component": { + "kind": "component", + "scheme": "bean", + "syntax": "bean:beanName", + "title": "Bean", + "description": "The bean component is for invoking Java beans from Camel.", + "label": "core,java", + "deprecated": false, + "deprecationNote": "", + "async": false, + "consumerOnly": false, + "producerOnly": true, + "lenientProperties": false, + "javaType": "org.apache.camel.component.bean.BeanComponent", + "firstVersion": "1.0.0", + "groupId": "org.apache.camel", + "artifactId": "camel-core", + "version": "2.20.0-SNAPSHOT" + }, + "componentProperties": { + "resolvePropertyPlaceholders": { "kind": "property", "displayName": "Resolve Property Placeholders", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": true, "description": "Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders." } + }, + "properties": { + "beanName": { "kind": "path", "displayName": "Bean Name", "group": "producer", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Sets the name of the bean to invoke" }, + "method": { "kind": "parameter", "displayName": "Method", "group": "producer", "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Sets the name of the method to invoke on the bean" }, + "cache": { "kind": "parameter", "displayName": "Cache", "group": "advanced", "label": "advanced", "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "If enabled Camel will cache the result of the first Registry look-up. Cache can be enabled if the bean in the Registry is defined as a singleton scope." }, + "multiParameterArray": { "kind": "parameter", "displayName": "Multi Parameter Array", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": true, "deprecationNote": "This option is used internally by Camel, and is not intended for end users to use.", "secret": false, "defaultValue": false, "description": "How to treat the parameters which are passed from the message body; if it is true the message body should be an array of parameters. Note: This option is used internally by Camel and is not intended for end users to use." }, + "parameters": { "kind": "parameter", "displayName": "Parameters", "group": "advanced", "label": "advanced", "type": "object", "javaType": "java.util.Map<java.lang.String,java.lang.Object>", "prefix": "bean.", "multiValue": true, "deprecated": false, "secret": false, "description": "Used for configuring additional properties on the bean" }, + "synchronous": { "kind": "parameter", "displayName": "Synchronous", "group": "advanced", "label": "advanced", "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported)." } + } +} + http://git-wip-us.apache.org/repos/asf/camel/blob/5cf67b3a/tooling/pom.xml ---------------------------------------------------------------------- diff --git a/tooling/pom.xml b/tooling/pom.xml index a01f18c..4081bfb 100644 --- a/tooling/pom.xml +++ b/tooling/pom.xml @@ -40,6 +40,7 @@ <modules> <module>parent</module> <module>spi-annotations</module> + <module>json-simple-ordered</module> <module>apt</module> <module>camel-route-parser</module> <module>swagger-rest-dsl-generator</module>
