rife2/rife2-template-renderers
rife2/rife2-template-renderers
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Added EncodeJS

Browse source
This commit is contained in:
Erik C. Thauvin 2023-03-16 01:03:32 -07:00
parent 79fcc243de
commit 54f40eb41e
5 changed files with 113 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

56
README.md
View file

@ -9,40 +9,40 @@ This project provides a collection of template renderers.
## Date/Time Renderers ## Date/Time Renderers
| Renderer | Description | | Renderer | Description |
|:---------------------------------|:-----------------------------------------------------------------| |:---------------------------------|:----------------------------------------------------------------|
| `rife.render.BeatTime` | Renders the current time in Swatch Internet (.beat) Time format. | | `rife.render.BeatTime` | Renders the current time in Swatch Internet (.beat) Time format |
| `rife.render.DateIso` | Renders the current date in ISO 8061 format. | | `rife.render.DateIso` | Renders the current date in ISO 8061 format |
| `rife.render.DateTimeIso` | Renders the current date and time in ISO 8061 format. | | `rife.render.DateTimeIso` | Renders the current date and time in ISO 8061 format |
| `rife.render.DateTimeRfc2822` | Renders the current date and time in RFC 2822 format. | | `rife.render.DateTimeRfc2822` | Renders the current date and time in RFC 2822 format |
| `rife.render.DateTimeUtc` | Renders the current UTC date and time in ISO 8061 format. | | `rife.render.DateTimeUtc` | Renders the current UTC date and time in ISO 8061 format |
| `rife.render.TimeIso` | Renders the current time in ISO 8061 format. | | `rife.render.TimeIso` | Renders the current time in ISO 8061 format |
| `rife.render.Year` | Renders the current year. | | `rife.render.Year` | Renders the current year |
## Encoding Renderers ## Encoding Renderers
| Renderer | Description | | Renderer | Description |
|:-----------------------------------|:--------------------------------------------------------| |:---------------------------------|:-------------------------------------------------------|
| `rife.render.EncodeBase64` | Encodes a template value to Base64. | | `rife.render.EncodeBase64` | Encodes a template value to Base64 |
| `rife.render.EncodeHtml` | Encodes a template value to HTML. | | `rife.render.EncodeHtml` | Encodes a template value to HTML |
| `rife.render.EncodeHtmlEntities` | Encodes a template value to HTML decimal entities. | | `rife.render.EncodeHtmlEntities` | Encodes a template value to HTML decimal entities |
| `rife.render.EncodeJson` | Encodes a template value to JSON. | | `rife.render.EncodeJS` | Encodes a template value to JavaScript/ECMAScript |
| `rife.render.EncodeQp` | Converts a template value to a quoted-printable string. | | `rife.render.EncodeQp` | Converts a template value to a quoted-printable string |
| `rife.render.EncodeUnicode` | Encodes a template value to Unicode escape codes. | | `rife.render.EncodeUnicode` | Encodes a template value to Unicode escape codes |
| `rife.render.EncodeUrl` | URL-encodes a template value. | | `rife.render.EncodeUrl` | URL-encodes a template value |
| `rife.render.EncodeXml` | Encodes a template value to XML. | | `rife.render.EncodeXml` | Encodes a template value to XML |
## Text Renderers ## Text Renderers
| Renderer | Description | | Renderer | Description |
|:----------------------------|:---------------------------------------------------------------| |:----------------------------|:--------------------------------------------------------------|
| `rife.render.Capitalize` | Capitalizes a template value. | | `rife.render.Capitalize` | Capitalizes a template value |
| `rife.render.Lowercase` | Converts a template value to lowercase. | | `rife.render.Lowercase` | Converts a template value to lowercase |
| `rife.render.Rot13` | Translates a template value to/from ROT13. | | `rife.render.Rot13` | Translates a template value to/from ROT13 |
| `rife.render.SwapCase` | Swap case of a template value. | | `rife.render.SwapCase` | Swap case of a template value |
| `rife.render.Trim` | Removes leading and trailing whitespace from a template value. | | `rife.render.Trim` | Removes leading and trailing whitespace from a template value |
| `rife.render.Uncapitalize` | Un-capitalizes a template value. | | `rife.render.Uncapitalize` | Un-capitalizes a template value |
| `rife.render.Uppercase` | Converts a template value to uppercase. | | `rife.render.Uppercase` | Converts a template value to uppercase |
## Usage in Templates ## Usage in Templates

74
lib/src/main/java/rife/render/EncodeJS.java Normal file
View file

@ -0,0 +1,74 @@
/*
* Copyright 2023 the original author or authors.
*
* 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
*
* https://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 rife.render;
import rife.template.Template;
import rife.template.ValueRenderer;
import rife.tools.StringUtils;
/**
* <p>Encodes a template value to JavaScript/ECMAScript.</p>
*
* <p>Usage:</p>
*
* <pre>
* &lt;!--v render:rife.render.EncodeJS:valueId/--&gt;
* {{v render:rife.render.EncodeJS:valueId/}}
* </pre>
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see StringUtils#encodeJson(String)
* @since 1.0
*/
public class EncodeJS implements ValueRenderer {
/**
* Encodes a string to JavaScript/ECMAScript.
*
* @param src the source string.
* @return the enocded string
*/
public static String encodeJS(String src) {
if (src == null || src.isBlank()) {
return src;
}
var sb = new StringBuilder();
var len = src.length();
char c;
for (var i = 0; i < len; i++) {
c = src.charAt(i);
switch (c) {
case '\'' -> sb.append("\\'");
case '"' -> sb.append("\\\"");
case '\\' -> sb.append("\\\\");
case '/' -> sb.append("\\/");
default -> sb.append(c);
}
}
return sb.toString();
}
/**
* {@inheritDoc}
*/
@Override
public String render(Template template, String valueId, String differentiator) {
return encodeJS(RenderUtils.fetchValue(template, differentiator));
}
}

2
lib/src/test/java/rife/render/TestDateTime.java
View file

@ -49,7 +49,7 @@ class TestDateTime {
} }
@Test @Test
void testDateTimeUtc2() { void testDateTimeUtc() {
var t = TemplateFactory.HTML.get("dateTimeUtc"); var t = TemplateFactory.HTML.get("dateTimeUtc");
assertThatCode(() -> DateTimeIso.iso8601Formatter.parse(t.getContent())).doesNotThrowAnyException(); assertThatCode(() -> DateTimeIso.iso8601Formatter.parse(t.getContent())).doesNotThrowAnyException();
} }

12
lib/src/test/java/rife/render/TestEncode.java
View file

@ -44,6 +44,13 @@ class TestEncode {
assertThat(t.getContent()).isEqualTo("<a href=\"mailto:&#106;&#111;&#104;&#110;&#64;&#100;&#111;&#101;&#46;&#99;&#111;&#109;\">Email</a>"); assertThat(t.getContent()).isEqualTo("<a href=\"mailto:&#106;&#111;&#104;&#110;&#64;&#100;&#111;&#101;&#46;&#99;&#111;&#109;\">Email</a>");
} }
@Test
void testEncodeJS() {
var t = TemplateFactory.TXT.get("encodeJS");
t.setAttribute(TestCase.FOO, "'\"\\/");
assertThat(t.getContent()).isEqualTo("\\'\\\"\\\\\\/");
}
@Test @Test
void testEncodeJson() { void testEncodeJson() {
var t = TemplateFactory.JSON.get("encodeJson"); var t = TemplateFactory.JSON.get("encodeJson");
@ -61,17 +68,16 @@ class TestEncode {
@Test @Test
void testEncodeRot13() { void testEncodeRot13() {
var t = TemplateFactory.TXT.get("rot13"); var t = TemplateFactory.TXT.get("rot13");
var value = TestCase.SAMPLE_TEXT;
var rot13 = "Guvf vf n grfg."; var rot13 = "Guvf vf n grfg.";
// Encode // Encode
var bean = new ValueBean(value); var bean = new ValueBean(TestCase.SAMPLE_TEXT);
t.setBean(bean); t.setBean(bean);
assertThat(t.getContent()).isEqualTo(bean.getValue() + ": " + rot13); assertThat(t.getContent()).isEqualTo(bean.getValue() + ": " + rot13);
// Decode // Decode
t.setValue("value", rot13); t.setValue("value", rot13);
assertThat(t.getContent()).isEqualTo(rot13 + ": " + value); assertThat(t.getContent()).isEqualTo(rot13 + ": " + TestCase.SAMPLE_TEXT);
} }
@Test @Test

1
lib/src/test/resources/templates/encodeJS.txt Normal file
View file

@ -0,0 +1 @@
{{v render:rife.render.EncodeJS:foo/}}