Updated Branches: refs/heads/master db2767306 -> 5ec63db94
Initial Mustache component commit Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/bddf3d1f Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/bddf3d1f Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/bddf3d1f Branch: refs/heads/master Commit: bddf3d1f3f821e7dda81675ff602cf0b935925fc Parents: 13c1dd9 Author: Gerald Quintana <gerald.quint...@gmail.com> Authored: Wed Jun 19 22:06:17 2013 +0100 Committer: Gerald Quintana <gerald.quint...@gmail.com> Committed: Wed Jun 19 23:09:52 2013 +0200 ---------------------------------------------------------------------- components/camel-mustache/ReadMe.wiki | 96 +++++++++ components/camel-mustache/pom.xml | 64 ++++++ .../component/mustache/MustacheComponent.java | 70 +++++++ .../component/mustache/MustacheConstants.java | 39 ++++ .../component/mustache/MustacheEndpoint.java | 180 ++++++++++++++++ .../src/main/resources/LICENSE.txt | 203 +++++++++++++++++++ .../org/apache/camel/component/mustache | 1 + .../src/main/resources/NOTICE.txt | 11 + .../mustache/MustacheComponentTest.java | 147 ++++++++++++++ .../component/mustache/MustacheLetterTest.java | 66 ++++++ .../src/test/resources/another.mustache | 4 + .../src/test/resources/child.mustache | 4 + .../src/test/resources/included.mustache | 1 + .../src/test/resources/includer.mustache | 3 + .../src/test/resources/letter.mustache | 6 + .../src/test/resources/log4j.properties | 36 ++++ .../src/test/resources/parent.mustache | 5 + .../src/test/resources/simple.mustache | 1 + components/pom.xml | 1 + 19 files changed, 938 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/ReadMe.wiki ---------------------------------------------------------------------- diff --git a/components/camel-mustache/ReadMe.wiki b/components/camel-mustache/ReadMe.wiki new file mode 100644 index 0000000..0642e9b --- /dev/null +++ b/components/camel-mustache/ReadMe.wiki @@ -0,0 +1,96 @@ +h2. Mustache + +The *mustache:* component allows for processing a message using a [Mustache|http://mustache.github.io/] template. This can be ideal when using [Templating] to generate responses for requests. + +Maven users will need to add the following dependency to their {{pom.xml}} for this component: +{code:xml} +<dependency> +<groupId>org.apache.camel</groupId> +<artifactId>camel-mustache</artifactId> +<version>x.x.x</version> <!-- use the same version as your Camel core version --> +</dependency> +{code} + +h3. URI format + +{code} +mustache:templateName[?options] +{code} + +Where *templateName* is the classpath-local URI of the template to invoke; or the complete URL of the remote template (eg: file://folder/myfile.mustache). + +You can append query options to the URI in the following format, {{?option=value&option=value&...}} + +h3. Options +{div:class=confluenceTableSmall} +|| Option || Default || Description || +| {{encoding}} | {{null}} | Character encoding of the resource content. | +| {{startDelimiter}} | {{ | Characters used to mark template code beginning. | +| {{endDelimiter}} | }} | Characters used to mark template code end. | +{div} + +h3. Mustache Context +Camel will provide exchange information in the Mustache context (just a {{Map}}). The {{Exchange}} is transferred as: +{div:class=confluenceTableSmall} +|| key || value || +| {{exchange}} | The {{Exchange}} itself. | +| {{exchange.properties}} | The {{Exchange}} properties. | +| {{headers}} | The headers of the In message. | +| {{camelContext}} | The Camel Context. | +| {{request}} | The In message. | +| {{body}} | The In message body. | +| {{response}} | The Out message (only for InOut message exchange pattern). | +{div} + +h3. Dynamic templates + +Camel provides two headers by which you can define a different resource location for a template or the template content itself. If any of these headers is set then Camel uses this over the endpoint configured resource. This allows you to provide a dynamic template at runtime. +{div:class=confluenceTableSmall} +|| Header || Type || Description || Support Version || +| MustacheConstants.MUSTACHE_RESOURCE | org.springframework.core.io.Resource | The template resource | | +| MustacheConstants.MUSTACHE_RESOURCE_URI | String | A URI for the template resource to use instead of the endpoint configured. | | +| MustacheConstants.MUSTACHE_TEMPLATE | String | The template to use instead of the endpoint configured. | | +{div} + +h3. Samples + +For example you could use something like: + +{code} +from("activemq:My.Queue"). +to("mustache:com/acme/MyResponse.mustache"); +{code} + +To use a Mustache template to formulate a response for a message for InOut message exchanges (where there is a {{JMSReplyTo}} header). + +If you want to use InOnly and consume the message and send it to another destination you could use: + +{code} +from("activemq:My.Queue"). +to("mustache:com/acme/MyResponse.mustache"). +to("activemq:Another.Queue"); +{code} + +It's possible to specify what template the component should use dynamically via a header, so for example: +{code} +from("direct:in"). +setHeader(MustacheConstants.MUSTACHE_RESOURCE_URI).constant("path/to/my/template.mustache"). +to("mustache:dummy"); +{code} + +h3. The Email Sample +In this sample we want to use Mustache templating for an order confirmation email. The email template is laid out in Mustache as: +{code} +Dear {{headers.lastName}}}, {{headers.firstName}} + +Thanks for the order of {{headers.item}}. + +Regards Camel Riders Bookstore +{{body}} +{code} + +And the java code: + +{snippet:id=e1|lang=java|url=camel/trunk/components/camel-mustache/src/test/java/org/apache/camel/component/mustache/MustacheLetterTest.java} + +{include:Endpoint See Also} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/pom.xml ---------------------------------------------------------------------- diff --git a/components/camel-mustache/pom.xml b/components/camel-mustache/pom.xml new file mode 100644 index 0000000..f6be585 --- /dev/null +++ b/components/camel-mustache/pom.xml @@ -0,0 +1,64 @@ +<?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>components</artifactId> + <version>2.12-SNAPSHOT</version> + </parent> + <artifactId>camel-mustache</artifactId> + <packaging>bundle</packaging> + <name>Camel :: Mustache</name> + <description>Camel Mustache support</description> + <properties> + <camel.osgi.export.pkg>org.apache.camel.component.mustache.*</camel.osgi.export.pkg> + <camel.osgi.export.service>org.apache.camel.spi.ComponentResolver;component=mustache</camel.osgi.export.service> + </properties> + + <dependencies> + + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-core</artifactId> + </dependency> + <dependency> + <groupId>com.github.spullara.mustache.java</groupId> + <artifactId>compiler</artifactId> + <version>0.8.12</version> + </dependency> + + <!-- testing --> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-test</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-log4j12</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <scope>test</scope> + </dependency> + </dependencies> +</project> http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheComponent.java b/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheComponent.java new file mode 100644 index 0000000..8777b38 --- /dev/null +++ b/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheComponent.java @@ -0,0 +1,70 @@ +/** + * 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.component.mustache; + +import com.github.mustachejava.DefaultMustacheFactory; +import com.github.mustachejava.MustacheFactory; +import java.util.Map; + +import org.apache.camel.Endpoint; +import org.apache.camel.impl.DefaultComponent; +import org.apache.camel.util.ObjectHelper; + +/** + * Represents the component that manages {@link MustacheEndpoint}. + * URI pattern: {@code mustache://template_name.mustache} + * Supports parameters: + * <ul> + * <li>encoding: default platform one </li> + * <li>startDelimiter: default "{{" </li> + * <li>endDelimiter: default "}}" </li> + * </li> + */ +public class MustacheComponent extends DefaultComponent { + /** + * Mustache factory + */ + private MustacheFactory mustacheFactory = new DefaultMustacheFactory(); + @Override + protected Endpoint createEndpoint(String uri, String remaining, Map<String, Object> parameters) throws Exception { + MustacheEndpoint endpoint = new MustacheEndpoint(uri, this, remaining); + endpoint.setMustacheFactory(getMustacheFactory()); + String encoding = getAndRemoveParameter(parameters, "encoding", String.class); + if (ObjectHelper.isNotEmpty(encoding)) { + endpoint.setEncoding(encoding); + } + String startDelimiter = getAndRemoveParameter(parameters, "startDelimiter", String.class); + if (ObjectHelper.isNotEmpty(startDelimiter)) { + endpoint.setStartDelimiter(startDelimiter); + } + String endDelimiter = getAndRemoveParameter(parameters, "endDelimiter", String.class); + if (ObjectHelper.isNotEmpty(endDelimiter)) { + endpoint.setEndDelimiter(endDelimiter); + } + setProperties(endpoint, parameters); + return endpoint; + } + + public MustacheFactory getMustacheFactory() { + return mustacheFactory; + } + + public void setMustacheFactory(MustacheFactory mustacheFactory) { + this.mustacheFactory = mustacheFactory; + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheConstants.java ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheConstants.java b/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheConstants.java new file mode 100644 index 0000000..a3f3966 --- /dev/null +++ b/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheConstants.java @@ -0,0 +1,39 @@ +/** + * 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.component.mustache; + +/** + * Mustache component constants + */ +public final class MustacheConstants { + /** + * Header containing a Mustache template location + */ + public static final String MUSTACHE_RESOURCE_URI = "MustacheResourceUri"; + /** + * Header containing the Mustache template code + */ + public static final String MUSTACHE_TEMPLATE = "MustacheTemplate"; + /** + * Mustache endpoint URI prefix + */ + public static final String MUSTACHE_ENDPOINT_URI_PREFIX="mustache:"; + private MustacheConstants() { + // Utility class + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheEndpoint.java b/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheEndpoint.java new file mode 100644 index 0000000..4f00026 --- /dev/null +++ b/components/camel-mustache/src/main/java/org/apache/camel/component/mustache/MustacheEndpoint.java @@ -0,0 +1,180 @@ +/** + * 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.component.mustache; + +import com.github.mustachejava.DefaultMustacheFactory; +import com.github.mustachejava.Mustache; +import com.github.mustachejava.MustacheFactory; +import java.io.IOException; +import java.io.InputStreamReader; +import java.io.Reader; +import java.io.StringReader; +import java.io.StringWriter; +import java.util.Map; +import org.apache.camel.Component; +import org.apache.camel.Exchange; +import org.apache.camel.ExchangePattern; +import org.apache.camel.Message; +import org.apache.camel.component.ResourceEndpoint; +import org.apache.camel.util.ExchangeHelper; +import static org.apache.camel.component.mustache.MustacheConstants.*; +/** + * Represents a Camel Mustache endpoint. + */ +public class MustacheEndpoint extends ResourceEndpoint { + /** + * Mustache factory + */ + private MustacheFactory mustacheFactory; + /** + * Mustache template + */ + private Mustache mustache; + /** + * Encoding + */ + private String encoding; + /** + * Start delimiter, usually {{ + */ + private String startDelimiter; + /** + * End delimiter, usually }} + */ + private String endDelimiter; + + public MustacheEndpoint() { + } + + public MustacheEndpoint(String endpointUri, Component component, String resourceUri) { + super(endpointUri, component, resourceUri); + } + @Override + public boolean isSingleton() { + return true; + } + + @Override + public ExchangePattern getExchangePattern() { + return ExchangePattern.InOut; + } + + @Override + protected String createEndpointUri() { + return MUSTACHE_ENDPOINT_URI_PREFIX + getResourceUri(); + } + + @Override + public void clearContentCache() { + this.mustache = null; + super.clearContentCache(); + } + + @Override + protected void onExchange(Exchange exchange) throws Exception { + String newResourceUri = exchange.getIn().getHeader(MUSTACHE_RESOURCE_URI, String.class); + if (newResourceUri == null) { + // Get Mustache + String newTemplate = exchange.getIn().getHeader(MUSTACHE_TEMPLATE, String.class); + Mustache newMustache; + if (newTemplate==null) { + newMustache = getOrCreateMustache(); + } else { + newMustache = createMustache(new StringReader(newTemplate), "mustache:temp#"+newTemplate.hashCode()); + exchange.getIn().removeHeader(MUSTACHE_TEMPLATE); + } + // Execute Mustache + Map<String, Object> variableMap = ExchangeHelper.createVariableMap(exchange); + StringWriter writer = new StringWriter(); + newMustache.execute(writer, variableMap); + writer.flush(); + // Fill out message + Message out = exchange.getOut(); + out.setBody(writer.toString()); + out.setHeaders(exchange.getIn().getHeaders()); + out.setAttachments(exchange.getIn().getAttachments()); + } else { + exchange.getIn().removeHeader(MustacheConstants.MUSTACHE_RESOURCE_URI); + MustacheEndpoint newEndpoint = getCamelContext() + .getEndpoint(MUSTACHE_ENDPOINT_URI_PREFIX+newResourceUri, MustacheEndpoint.class); + newEndpoint.onExchange(exchange); + } + } + /** + * Read and compile a Mustache template + * @param resourceReader Reader used to get template + * @param resourceUri Template Id + * @return Template + */ + private Mustache createMustache(Reader resourceReader, String resourceUri) throws IOException { + try { + Mustache newMustache; + if (startDelimiter!=null && endDelimiter!=null && mustacheFactory instanceof DefaultMustacheFactory) { + DefaultMustacheFactory defaultMustacheFactory = (DefaultMustacheFactory) mustacheFactory; + newMustache= defaultMustacheFactory.compile(resourceReader, resourceUri, startDelimiter, endDelimiter); + } else { + newMustache = mustacheFactory.compile(resourceReader, resourceUri); + } + return newMustache; + } finally { + resourceReader.close(); + } + } + private Mustache getOrCreateMustache() throws IOException{ + if (mustache == null) { + mustache = createMustache(getResourceAsReader(), getResourceUri()); + } + return mustache; + } + public MustacheFactory getMustacheFactory() { + return mustacheFactory; + } + + public void setMustacheFactory(MustacheFactory mustacheFactory) { + this.mustacheFactory = mustacheFactory; + } + + public String getEncoding() { + return encoding; + } + + public void setEncoding(String encoding) { + this.encoding = encoding; + } + private Reader getResourceAsReader() throws IOException { + return encoding == null + ? new InputStreamReader(getResourceAsInputStream()) + : new InputStreamReader(getResourceAsInputStream(), encoding); + } + + public String getStartDelimiter() { + return startDelimiter; + } + + public void setStartDelimiter(String startDelimiter) { + this.startDelimiter = startDelimiter; + } + + public String getEndDelimiter() { + return endDelimiter; + } + + public void setEndDelimiter(String endDelimiter) { + this.endDelimiter = endDelimiter; + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/main/resources/LICENSE.txt ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/main/resources/LICENSE.txt b/components/camel-mustache/src/main/resources/LICENSE.txt new file mode 100644 index 0000000..6b0b127 --- /dev/null +++ b/components/camel-mustache/src/main/resources/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/bddf3d1f/components/camel-mustache/src/main/resources/META-INF/services/org/apache/camel/component/mustache ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/main/resources/META-INF/services/org/apache/camel/component/mustache b/components/camel-mustache/src/main/resources/META-INF/services/org/apache/camel/component/mustache new file mode 100644 index 0000000..4205166 --- /dev/null +++ b/components/camel-mustache/src/main/resources/META-INF/services/org/apache/camel/component/mustache @@ -0,0 +1 @@ +class=org.apache.camel.component.mustache.MustacheComponent http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/main/resources/NOTICE.txt ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/main/resources/NOTICE.txt b/components/camel-mustache/src/main/resources/NOTICE.txt new file mode 100644 index 0000000..2e215bf --- /dev/null +++ b/components/camel-mustache/src/main/resources/NOTICE.txt @@ -0,0 +1,11 @@ + ========================================================================= + == 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/). + + Please read the different LICENSE files present in the licenses directory of + this distribution. http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/test/java/org/apache/camel/component/mustache/MustacheComponentTest.java ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/test/java/org/apache/camel/component/mustache/MustacheComponentTest.java b/components/camel-mustache/src/test/java/org/apache/camel/component/mustache/MustacheComponentTest.java new file mode 100644 index 0000000..7dae863 --- /dev/null +++ b/components/camel-mustache/src/test/java/org/apache/camel/component/mustache/MustacheComponentTest.java @@ -0,0 +1,147 @@ +/** + * 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.component.mustache; + +import org.apache.camel.component.mustache.MustacheConstants; +import org.apache.camel.EndpointInject; +import org.apache.camel.Exchange; +import org.apache.camel.Produce; +import org.apache.camel.ProducerTemplate; +import org.apache.camel.builder.RouteBuilder; +import org.apache.camel.component.mock.MockEndpoint; +import org.apache.camel.test.junit4.CamelTestSupport; +import org.apache.camel.util.StopWatch; +import org.junit.Test; +import org.slf4j.LoggerFactory; +/** + * Unit test for {@link MustacheComponent} and {@link MustacheEndpoint} + */ +public class MustacheComponentTest extends CamelTestSupport { + + @EndpointInject(uri = "mock:endSimple") + protected MockEndpoint endSimpleMock; + + @Produce(uri = "direct:startSimple") + protected ProducerTemplate startSimpleProducerTemplate; + /** + * Main test + */ + @Test + public void testMustache() throws Exception { + // Prepare + endSimpleMock.expectedMessageCount(1); + endSimpleMock.expectedBodiesReceived("Message with body 'The Body' and some header 'Some Header'"); + // Act + startSimpleProducerTemplate.sendBodyAndHeader("The Body", "someHeader", "Some Header"); + // Verify + assertMockEndpointsSatisfied(); + } + + /** + * Test using code Template header + */ + @Test + public void testMustacheWithTemplateHeader() throws Exception { + // Prepare + Exchange exchange=createExchangeWithBody("The Body"); + exchange.getIn().setHeader("someHeader", "Some Header"); + exchange.getIn().setHeader(MustacheConstants.MUSTACHE_TEMPLATE, "Body='{{body}}'|SomeHeader='{{headers.someHeader}}'"); + endSimpleMock.expectedMessageCount(1); + endSimpleMock.expectedBodiesReceived("Body='The Body'|SomeHeader='Some Header'"); + // Act + startSimpleProducerTemplate.send(exchange); + // Verify + assertMockEndpointsSatisfied(); + } + + /** + * Test using Resource URI header + */ + @Test + public void testMustacheWithResourceUriHeader() throws Exception { + // Prepare + Exchange exchange=createExchangeWithBody("The Body"); + exchange.getIn().setHeader("someHeader", "Some Header"); + exchange.getIn().setHeader(MustacheConstants.MUSTACHE_RESOURCE_URI, "/another.mustache"); + endSimpleMock.expectedMessageCount(1); + endSimpleMock.expectedBodiesReceived("Yet another Mustache with body:\n" + + " 'The Body'\n" + + "and some header:\n" + + " 'Some Header'\n"); + // Act + startSimpleProducerTemplate.send(exchange); + // Verify + assertMockEndpointsSatisfied(); + } + @Test + public void testMustacheWithInheritance() throws Exception { + // Prepare + Exchange exchange=createExchangeWithBody("The Body"); + exchange.getIn().setHeader(MustacheConstants.MUSTACHE_RESOURCE_URI, "/child.mustache"); + endSimpleMock.expectedMessageCount(1); + endSimpleMock.expectedBodiesReceived("Start\n" + +"Content 1: Child 1\n" + +"Middle\n" + +"Content 2: Child 2\n" + +"End"); + // Act + startSimpleProducerTemplate.send(exchange); + // Verify + assertMockEndpointsSatisfied(); + } + @Test + public void testMustacheWithPartials() throws Exception { + // Prepare + Exchange exchange=createExchangeWithBody("The Body"); + exchange.getIn().setHeader(MustacheConstants.MUSTACHE_RESOURCE_URI, "/includer.mustache"); + endSimpleMock.expectedMessageCount(1); + endSimpleMock.expectedBodiesReceived("Start\n" + +"Included\n" + +"End"); + // Act + startSimpleProducerTemplate.send(exchange); + // Verify + assertMockEndpointsSatisfied(); + } + /** + * Main test + */ + @Test + public void testMustachePerformance() throws Exception { + int messageCount=10000; + endSimpleMock.expectedMessageCount(messageCount); + StopWatch stopwatch=new StopWatch(true); + for(int i=0;i<messageCount;i++) { + startSimpleProducerTemplate.sendBodyAndHeader("The Body", "someHeader", "Some Header"); + } + assertMockEndpointsSatisfied(); + LoggerFactory.getLogger(getClass()).info("Mustache performance: "+stopwatch.stop()+"ms for "+messageCount+" messages"); + + } + + @Override + protected RouteBuilder createRouteBuilder() throws Exception { + return new RouteBuilder() { + @Override + public void configure() { + from("direct:startSimple") + .to("mustache://simple.mustache") + .to("mock:endSimple"); + } + }; + } +} http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/test/java/org/apache/camel/component/mustache/MustacheLetterTest.java ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/test/java/org/apache/camel/component/mustache/MustacheLetterTest.java b/components/camel-mustache/src/test/java/org/apache/camel/component/mustache/MustacheLetterTest.java new file mode 100644 index 0000000..9d02afb --- /dev/null +++ b/components/camel-mustache/src/test/java/org/apache/camel/component/mustache/MustacheLetterTest.java @@ -0,0 +1,66 @@ +/** + * 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.component.mustache; + +import org.apache.camel.Exchange; +import org.apache.camel.Message; +import org.apache.camel.builder.RouteBuilder; +import org.apache.camel.component.mock.MockEndpoint; +import org.apache.camel.test.junit4.CamelTestSupport; +import org.junit.Test; + +/** + * Unit test for wiki documentation + */ +public class MustacheLetterTest extends CamelTestSupport { + + // START SNIPPET: e1 + private Exchange createLetter() { + Exchange exchange = context.getEndpoint("direct:a").createExchange(); + + Message msg = exchange.getIn(); + msg.setHeader("firstName", "Claus"); + msg.setHeader("lastName", "Ibsen"); + msg.setHeader("item", "Camel in Action"); + msg.setBody("PS: Next beer is on me, James"); + + return exchange; + } + + @Test + public void testFreemarkerLetter() throws Exception { + MockEndpoint mock = getMockEndpoint("mock:result"); + mock.expectedMessageCount(1); + mock.expectedBodiesReceived("Dear Ibsen, Claus\n\nThanks for the order of Camel in Action." + + "\n\nRegards Camel Riders Bookstore\nPS: Next beer is on me, James"); + + template.send("direct:a", createLetter()); + + mock.assertIsSatisfied(); + } + + protected RouteBuilder createRouteBuilder() throws Exception { + return new RouteBuilder() { + public void configure() throws Exception { + from("direct:a") + .to("mustache:letter.mustache") + .to("mock:result"); + } + }; + } + // END SNIPPET: e1 +} http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/test/resources/another.mustache ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/test/resources/another.mustache b/components/camel-mustache/src/test/resources/another.mustache new file mode 100644 index 0000000..059e159 --- /dev/null +++ b/components/camel-mustache/src/test/resources/another.mustache @@ -0,0 +1,4 @@ +Yet another Mustache with body: + '{{body}}' +and some header: + '{{headers.someHeader}}' http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/test/resources/child.mustache ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/test/resources/child.mustache b/components/camel-mustache/src/test/resources/child.mustache new file mode 100644 index 0000000..1689504 --- /dev/null +++ b/components/camel-mustache/src/test/resources/child.mustache @@ -0,0 +1,4 @@ +{{<parent}} +{{$content1}}Child 1{{/content1}} +{{$content2}}Child 2{{/content2}} +{{/parent}} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/test/resources/included.mustache ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/test/resources/included.mustache b/components/camel-mustache/src/test/resources/included.mustache new file mode 100644 index 0000000..c709afe --- /dev/null +++ b/components/camel-mustache/src/test/resources/included.mustache @@ -0,0 +1 @@ +Included \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/test/resources/includer.mustache ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/test/resources/includer.mustache b/components/camel-mustache/src/test/resources/includer.mustache new file mode 100644 index 0000000..def64eb --- /dev/null +++ b/components/camel-mustache/src/test/resources/includer.mustache @@ -0,0 +1,3 @@ +Start +{{> included}} +End \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/test/resources/letter.mustache ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/test/resources/letter.mustache b/components/camel-mustache/src/test/resources/letter.mustache new file mode 100644 index 0000000..42206c3 --- /dev/null +++ b/components/camel-mustache/src/test/resources/letter.mustache @@ -0,0 +1,6 @@ +Dear {{headers.lastName}}, {{headers.firstName}} + +Thanks for the order of {{headers.item}}. + +Regards Camel Riders Bookstore +{{body}} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/test/resources/log4j.properties ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/test/resources/log4j.properties b/components/camel-mustache/src/test/resources/log4j.properties new file mode 100644 index 0000000..99a4f38 --- /dev/null +++ b/components/camel-mustache/src/test/resources/log4j.properties @@ -0,0 +1,36 @@ +## --------------------------------------------------------------------------- +## 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. +## --------------------------------------------------------------------------- + +# +# The logging properties used during tests.. +# +log4j.rootLogger=INFO, out + +log4j.logger.org.apache.activemq.spring=WARN +log4j.logger.org.apache.camel.component.freemarker=DEBUG + +# CONSOLE appender not used by default +log4j.appender.stdout=org.apache.log4j.ConsoleAppender +log4j.appender.stdout.layout=org.apache.log4j.PatternLayout +log4j.appender.stdout.layout.ConversionPattern=%d [%-15.15t] %-5p %-30.30c{1} - %m%n + +# File appender +log4j.appender.out=org.apache.log4j.FileAppender +log4j.appender.out.layout=org.apache.log4j.PatternLayout +log4j.appender.out.layout.ConversionPattern=%d [%-15.15t] %-5p %-30.30c{1} - %m%n +log4j.appender.out.file=target/camel-freemarker-test.log +log4j.appender.out.append=true http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/test/resources/parent.mustache ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/test/resources/parent.mustache b/components/camel-mustache/src/test/resources/parent.mustache new file mode 100644 index 0000000..acd6f71 --- /dev/null +++ b/components/camel-mustache/src/test/resources/parent.mustache @@ -0,0 +1,5 @@ +Start +Content 1: {{$content1}}Parent 1{{/content1}} +Middle +Content 2: {{$content2}}Parent 2{{/content2}} +End \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/camel-mustache/src/test/resources/simple.mustache ---------------------------------------------------------------------- diff --git a/components/camel-mustache/src/test/resources/simple.mustache b/components/camel-mustache/src/test/resources/simple.mustache new file mode 100644 index 0000000..6d9b347 --- /dev/null +++ b/components/camel-mustache/src/test/resources/simple.mustache @@ -0,0 +1 @@ +Message with body '{{body}}' and some header '{{headers.someHeader}}' \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/bddf3d1f/components/pom.xml ---------------------------------------------------------------------- diff --git a/components/pom.xml b/components/pom.xml index bba5686..e902a89 100644 --- a/components/pom.xml +++ b/components/pom.xml @@ -125,6 +125,7 @@ <module>camel-mongodb</module> <module>camel-mqtt</module> <module>camel-msv</module> + <module>camel-mustache</module> <module>camel-mvel</module> <module>camel-mybatis</module> <module>camel-nagios</module>
