#}
++++
+|[[delimiterCommentOpen]]`@delimiterCommentOpen`|`String`|+++
+Defaults to {#
++++
+|[[delimiterExecuteClose]]`@delimiterExecuteClose`|`String`|+++
+Defaults to %}
++++
+|[[delimiterExecuteOpen]]`@delimiterExecuteOpen`|`String`|+++
+Defaults to {%
++++
+|[[delimiterPrintClose]]`@delimiterPrintClose`|`String`|+++
+Defaults to }}
++++
+|[[delimiterPrintOpen]]`@delimiterPrintOpen`|`String`|+++
+Defaults to {{
++++
+|[[literalDecimalTreatedAsInteger]]`@literalDecimalTreatedAsInteger`|`Boolean`|+++
+Sets whether a literal decimal should be treated as Integer. If false, all literal + decimals will be treated as Long.
A literal decimal is considered a numeric string without + a fraction separator (a dot).
Defaults to false. ++++ +|[[newLineTrimming]]`@newLineTrimming`|`Boolean`|+++ +Sets whether a new line after a closing Pebble tag should be trimmed. Defaults to true. ++++ +|[[strictVariables]]`@strictVariables`|`Boolean`|+++ +Sets the Strict Mode of the Pebble Engine.
In Strict Mode, referencing a null or + non-existent variable or attribute will result in an exception.
When Strict Mode is + disabled, such variables/attributes will be rendered as empty. + + Strict mode is disabled by default. ++++ +|[[whitespaceTrim]]`@whitespaceTrim`|`String`|+++ +Defaults to
- Note: this is used for trimming whitespaces adjacent to a Pebble
+ tag, not inside the content rendered by it.
++++
+|===
+
diff --git a/pebble/gradle.properties b/pebble/gradle.properties
new file mode 100644
index 0000000..70b8eae
--- /dev/null
+++ b/pebble/gradle.properties
@@ -0,0 +1,3 @@
+artifactId=knotx-template-engine-pebble
+publication.name=Knot.x Template Engine Pebble
+publication.description=Knot.x Template Engine Pebble
diff --git a/pebble/src/main/java/io/knotx/te/pebble/PebbleEngineSyntaxComposer.java b/pebble/src/main/java/io/knotx/te/pebble/PebbleEngineSyntaxComposer.java
new file mode 100644
index 0000000..44f297a
--- /dev/null
+++ b/pebble/src/main/java/io/knotx/te/pebble/PebbleEngineSyntaxComposer.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright (C) 2019 Knot.x Project
+ *
+ * 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 io.knotx.te.pebble;
+
+import com.mitchellbosecke.pebble.lexer.Syntax;
+import io.knotx.te.pebble.options.PebbleEngineSyntaxOptions;
+
+final class PebbleEngineSyntaxComposer {
+
+ private PebbleEngineSyntaxComposer() {
+ // utility class
+ }
+
+ static Syntax compose(PebbleEngineSyntaxOptions options) {
+ return new Syntax.Builder()
+ .setCommentOpenDelimiter(options.getDelimiterCommentOpen())
+ .setCommentCloseDelimiter(options.getDelimiterCommentClose())
+ .setExecuteOpenDelimiter(options.getDelimiterExecuteOpen())
+ .setExecuteCloseDelimiter(options.getDelimiterExecuteClose())
+ .setPrintOpenDelimiter(options.getDelimiterPrintOpen())
+ .setPrintCloseDelimiter(options.getDelimiterPrintClose())
+ .setWhitespaceTrim(options.getWhitespaceTrim())
+ .build();
+ }
+
+}
diff --git a/pebble/src/main/java/io/knotx/te/pebble/PebbleTemplateEngine.java b/pebble/src/main/java/io/knotx/te/pebble/PebbleTemplateEngine.java
new file mode 100644
index 0000000..1cc07bb
--- /dev/null
+++ b/pebble/src/main/java/io/knotx/te/pebble/PebbleTemplateEngine.java
@@ -0,0 +1,133 @@
+/*
+ * Copyright (C) 2019 Knot.x Project
+ *
+ * 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 io.knotx.te.pebble;
+
+import com.google.common.cache.Cache;
+import com.google.common.cache.CacheBuilder;
+import com.mitchellbosecke.pebble.PebbleEngine;
+import com.mitchellbosecke.pebble.loader.StringLoader;
+import com.mitchellbosecke.pebble.template.PebbleTemplate;
+import io.knotx.commons.json.JsonConverter;
+import io.knotx.fragments.api.Fragment;
+import io.knotx.te.api.TemplateEngine;
+import io.knotx.te.pebble.options.PebbleEngineOptions;
+import io.knotx.te.pebble.options.PebbleEngineSyntaxOptions;
+import io.vertx.core.logging.Logger;
+import io.vertx.core.logging.LoggerFactory;
+import java.io.IOException;
+import java.io.StringWriter;
+import java.nio.charset.StandardCharsets;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
+import java.util.Map;
+import java.util.concurrent.ExecutionException;
+
+/**
+ * This class is registered with Service Provider Interface (see META-INF/services)
+ */
+class PebbleTemplateEngine implements TemplateEngine {
+
+ private static final Logger LOGGER = LoggerFactory.getLogger(PebbleTemplateEngine.class);
+
+ private final PebbleEngine pebbleEngine;
+ private final CacheIn Strict Mode, referencing a null or + * non-existent variable or attribute will result in an exception.
When Strict Mode is + * disabled, such variables/attributes will be rendered as empty. + * + * Strict mode is disabled by default. + * + * @param strictVariables flag indicating whether strict mode should be enabled + */ + public void setStrictVariables(boolean strictVariables) { + this.strictVariables = strictVariables; + } + + /** + * @return flag indicating whether a new line character occurring after a closing Pebble tag + * should be trimmed + */ + public boolean isNewLineTrimming() { + return newLineTrimming; + } + + /** + * Sets whether a new line after a closing Pebble tag should be trimmed. Defaults to true. + * + * @param newLineTrimming flag indicating whether a new line character occurring after a closing + * Pebble tag should be trimmed + */ + public void setNewLineTrimming(boolean newLineTrimming) { + this.newLineTrimming = newLineTrimming; + } + + /** + * @return flag indicating whether a literal decimal should be treated as Integer or Long + */ + public boolean isLiteralDecimalTreatedAsInteger() { + return literalDecimalTreatedAsInteger; + } + + /** + * Sets whether a literal decimal should be treated as Integer.
If false, all literal + * decimals will be treated as Long.
A literal decimal is considered a numeric string without + * a fraction separator (a dot).
Defaults to false. + * + * @param literalDecimalTreatedAsInteger flag indicating whether a literal decimal should be + * treated as Integer or Long + */ + public void setLiteralDecimalTreatedAsInteger(boolean literalDecimalTreatedAsInteger) { + this.literalDecimalTreatedAsInteger = literalDecimalTreatedAsInteger; + } + + /** + * @return custom delimiter for comment start + */ + public String getDelimiterCommentOpen() { + return delimiterCommentOpen; + } + + /** + * Defaults to
{#
+ *
+ * @param delimiterCommentOpen custom delimiter for comment start
+ */
+ public void setDelimiterCommentOpen(String delimiterCommentOpen) {
+ this.delimiterCommentOpen = delimiterCommentOpen;
+ }
+
+ /**
+ * @return custom delimiter for comment end
+ */
+ public String getDelimiterCommentClose() {
+ return delimiterCommentClose;
+ }
+
+ /**
+ * Defaults to #}
+ *
+ * @param delimiterCommentClose custom delimiter for comment end
+ */
+ public void setDelimiterCommentClose(String delimiterCommentClose) {
+ this.delimiterCommentClose = delimiterCommentClose;
+ }
+
+ /**
+ * @return custom delimiter for execution tag start
+ */
+ public String getDelimiterExecuteOpen() {
+ return delimiterExecuteOpen;
+ }
+
+ /**
+ * Defaults to {%
+ *
+ * @param delimiterExecuteOpen custom delimiter for execution tag start
+ */
+ public void setDelimiterExecuteOpen(String delimiterExecuteOpen) {
+ this.delimiterExecuteOpen = delimiterExecuteOpen;
+ }
+
+ /**
+ * @return custom delimiter for execution tag end
+ */
+ public String getDelimiterExecuteClose() {
+ return delimiterExecuteClose;
+ }
+
+ /**
+ * Defaults to %}
+ *
+ * @param delimiterExecuteClose custom delimiter for execution tag end
+ */
+ public void setDelimiterExecuteClose(String delimiterExecuteClose) {
+ this.delimiterExecuteClose = delimiterExecuteClose;
+ }
+
+ /**
+ * @return custom delimiter for print tag start
+ */
+ public String getDelimiterPrintOpen() {
+ return delimiterPrintOpen;
+ }
+
+ /**
+ * Defaults to {{
+ *
+ * @param delimiterPrintOpen custom delimiter for print tag start
+ */
+ public void setDelimiterPrintOpen(String delimiterPrintOpen) {
+ this.delimiterPrintOpen = delimiterPrintOpen;
+ }
+
+ /**
+ * @return custom delimiter for print tag end
+ */
+ public String getDelimiterPrintClose() {
+ return delimiterPrintClose;
+ }
+
+ /**
+ * Defaults to }}
+ *
+ * @param delimiterPrintClose custom delimiter for print tag end
+ */
+ public void setDelimiterPrintClose(String delimiterPrintClose) {
+ this.delimiterPrintClose = delimiterPrintClose;
+ }
+
+ /**
+ * @return custom character used to enable leading/trailing whitespaces trimming
+ */
+ public String getWhitespaceTrim() {
+ return whitespaceTrim;
+ }
+
+ /**
+ * Defaults to - Note: this is used for trimming whitespaces adjacent to a Pebble
+ * tag, not inside the content rendered by it.
+ *
+ * @param whitespaceTrim custom character used to enable leading/trailing whitespaces trimming
+ */
+ public void setWhitespaceTrim(String whitespaceTrim) {
+ this.whitespaceTrim = whitespaceTrim;
+ }
+
+ @Override
+ public String toString() {
+ return "PebbleEngineSyntaxOptions{" +
+ "strictVariables=" + strictVariables +
+ ", newLineTrimming=" + newLineTrimming +
+ ", literalDecimalTreatedAsInteger=" + literalDecimalTreatedAsInteger +
+ ", delimiterCommentOpen='" + delimiterCommentOpen + '\'' +
+ ", delimiterCommentClose='" + delimiterCommentClose + '\'' +
+ ", delimiterExecuteOpen='" + delimiterExecuteOpen + '\'' +
+ ", delimiterExecuteClose='" + delimiterExecuteClose + '\'' +
+ ", delimiterPrintOpen='" + delimiterPrintOpen + '\'' +
+ ", delimiterPrintClose='" + delimiterPrintClose + '\'' +
+ ", whitespaceTrim='" + whitespaceTrim + '\'' +
+ '}';
+ }
+}
diff --git a/pebble/src/main/java/io/knotx/te/pebble/package-info.java b/pebble/src/main/java/io/knotx/te/pebble/package-info.java
new file mode 100644
index 0000000..572e1ca
--- /dev/null
+++ b/pebble/src/main/java/io/knotx/te/pebble/package-info.java
@@ -0,0 +1,19 @@
+/*
+ * Copyright (C) 2019 Knot.x Project
+ *
+ * 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.
+ */
+@ModuleGen(name = "knotx-te-pebble", groupPackage = "io.knotx")
+package io.knotx.te.pebble;
+
+import io.vertx.codegen.annotations.ModuleGen;
diff --git a/pebble/src/main/resources/META-INF/services/io.knotx.te.api.TemplateEngineFactory b/pebble/src/main/resources/META-INF/services/io.knotx.te.api.TemplateEngineFactory
new file mode 100644
index 0000000..4461e89
--- /dev/null
+++ b/pebble/src/main/resources/META-INF/services/io.knotx.te.api.TemplateEngineFactory
@@ -0,0 +1,15 @@
+# Copyright (C) 2019 Knot.x Project
+#
+# 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.
+
+io.knotx.te.pebble.PebbleTemplateEngineFactory
diff --git a/pebble/src/test/java/io/knotx/te/pebble/PebbleTemplateEngineTest.java b/pebble/src/test/java/io/knotx/te/pebble/PebbleTemplateEngineTest.java
new file mode 100644
index 0000000..f198218
--- /dev/null
+++ b/pebble/src/test/java/io/knotx/te/pebble/PebbleTemplateEngineTest.java
@@ -0,0 +1,215 @@
+/*
+ * Copyright (C) 2019 Knot.x Project
+ *
+ * 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 io.knotx.te.pebble;
+
+import static io.knotx.junit5.assertions.KnotxAssertions.assertEqualsIgnoreWhitespace;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import com.google.common.util.concurrent.UncheckedExecutionException;
+import com.mitchellbosecke.pebble.error.AttributeNotFoundException;
+import com.mitchellbosecke.pebble.error.ParserException;
+import com.mitchellbosecke.pebble.error.RootAttributeNotFoundException;
+import io.knotx.fragments.api.Fragment;
+import io.knotx.junit5.util.FileReader;
+import io.knotx.te.pebble.options.PebbleEngineOptions;
+import io.knotx.te.pebble.options.PebbleEngineSyntaxOptions;
+import io.vertx.core.json.JsonObject;
+import java.io.IOException;
+import java.util.stream.Stream;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+class PebbleTemplateEngineTest {
+
+ private static final String TEMPLATE_EMPTY = "templates/empty.peb";
+ private static final String TEMPLATE_SAMPLE = "templates/sample.peb";
+ private static final String TEMPLATE_SERVICE = "templates/service.peb";
+ private static final String TEMPLATE_SERVICE_CUSTOM_SYNTAX = "templates/serviceCustomSyntax.peb";
+ private static final String TEMPLATE_UNDEFINED_HELPER = "templates/undefinedHelper.peb";
+
+ private static final String CONTEXT_EMPTY = "data/emptyContext.json";
+ private static final String CONTEXT_SAMPLE = "data/sampleContext.json";
+ private static final String CONTEXT_SAMPLE_MISSING_FIELD = "data/sampleContextMissingField.json";
+ private static final String CONTEXT_SERVICE = "data/serviceContext.json";
+
+ private static final String RESULT_EMPTY_CONTENT = "results/emptyContent";
+ private static final String RESULT_EMPTY_CONTEXT = "results/emptyContext";
+ private static final String RESULT_SAMPLE = "results/sample";
+ private static final String RESULT_SAMPLE_MISSING_FIELD = "results/sampleMissingField";
+ private static final String RESULT_SERVICE = "results/service";
+
+ private PebbleEngineOptions options;
+
+ private static Stream
+ 
+ 
+
+ {% for swatch in item.swatches %}
+ {% set links = swatch.all_swatch_links | split('\|') %}
+ {% set ids = swatch.all_swatch_ids | split('\|') %}
+ {% set images = swatch.all_swatch_images | split('\|') %}
+
+{% endfor %}
+
+{# This is a comment and will not be printed #}
diff --git a/pebble/src/test/resources/templates/serviceCustomSyntax.peb b/pebble/src/test/resources/templates/serviceCustomSyntax.peb
new file mode 100644
index 0000000..706cb2d
--- /dev/null
+++ b/pebble/src/test/resources/templates/serviceCustomSyntax.peb
@@ -0,0 +1,21 @@
+<< for item in items >>
+ -
+ {% for link in links %}
+
-
+
{{ loop.index + 1 }}
+ ++ +
+ {% endfor %}
+
+ << for swatch in item.swatches >>
+ << set links = swatch.all_swatch_links | split('\|') >>
+ << set ids = swatch.all_swatch_ids | split('\|') >>
+ << set images = swatch.all_swatch_images | split('\|') >>
+
+<< endfor >>
+
+/* This is a comment and will not be printed */
diff --git a/pebble/src/test/resources/templates/undefinedHelper.peb b/pebble/src/test/resources/templates/undefinedHelper.peb
new file mode 100644
index 0000000..5cf870b
--- /dev/null
+++ b/pebble/src/test/resources/templates/undefinedHelper.peb
@@ -0,0 +1,3 @@
+ First: {{ sample.result.first}}
+ Second: {{sample.result.second.foo}}
+ Empty: {{#notDefinedSymbol}}This will cause exception{{/notDefinedSymbol}}
diff --git a/settings.gradle.kts b/settings.gradle.kts
index dc60338..0ace288 100644
--- a/settings.gradle.kts
+++ b/settings.gradle.kts
@@ -19,8 +19,10 @@ include("knotx-template-engine-api")
include("knotx-template-engine-core")
include("knotx-template-engine-handlebars")
include("knotx-template-engine-it-test")
+include("knotx-template-engine-pebble")
project(":knotx-template-engine-api").projectDir = file("api")
project(":knotx-template-engine-core").projectDir = file("core")
project(":knotx-template-engine-handlebars").projectDir = file("handlebars")
+project(":knotx-template-engine-pebble").projectDir = file("pebble")
project(":knotx-template-engine-it-test").projectDir = file("it-test")
-
+ << for link in links >>
+
-
+
<| loop.index + 1 |>
+ ++ +
+ << endfor >>
+