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

Added links to wiki for EncodeHtmlEntities, EncodeUnicode and EncodeUrl

Browse source
This commit is contained in:
Erik C. Thauvin 2023-03-18 21:39:41 -07:00
parent ea941d2200
commit 2297011feb
5 changed files with 14 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -21,17 +21,16 @@ This project provides a collection of useful template renderers.
## Encoding Renderers ## Encoding Renderers
| Renderer | Description | | Renderer | Description |
|:------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------| |:-------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------|
| [rife.render.EncodeBase64](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeBase64) | Encodes a template value to Base64 | | [rife.render.EncodeBase64](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeBase64) | Encodes a template value to Base64 |
| [rife.render.EncodeHtml](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeHtml) | Encodes a template value to HTML | | [rife.render.EncodeHtml](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeHtml) | Encodes a template value to HTML |
| `rife.render.EncodeHtmlEntities` | Encodes a template value to HTML decimal entities | | [rife.render.EncodeHtmlEntities](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeHtmlEntities0) | Encodes a template value to HTML decimal entities |
| [rife.render.EncodeJs](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeJs) | Encodes a template value to JavaScript/ECMAScript | | [rife.render.EncodeJs](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeJs) | Encodes a template value to JavaScript/ECMAScript |
| [rife.render.EncodeJson](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeJson) | Encodes a template value to JSON | | [rife.render.EncodeJson](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeJson) | Encodes a template value to JSON |
| `rife.render.EncodeQp` | Converts a template value to a quoted-printable string | | [rife.render.EncodeUnicode](https://github.com/rife2/rife2-template-renderers/wiki/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](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeUrl) | URL-encodes a template value |
| `rife.render.EncodeUrl` | URL-encodes a template value | | [rife.render.EncodeXml](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeXml) | Encodes a template value to XML |
| [rife.render.EncodeXml](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeXml) | Encodes a template value to XML |
## Format Renderers ## Format Renderers
@ -56,4 +55,4 @@ This project provides a collection of useful template renderers.
## Documentation ## Documentation
Read more in the [full documenation](https://github.com/rife2/rife2/wiki). Read more in the [full documenation](https://github.com/rife2/rife2-template-renderers/wiki).

5
lib/src/main/java/rife/render/EncodeHtmlEntities.java
View file

@ -30,11 +30,8 @@ import rife.template.ValueRenderer;
* {{v render:rife.render.EncodeHtmlEntities:valueId/}} * {{v render:rife.render.EncodeHtmlEntities:valueId/}}
* </pre> * </pre>
* *
* <p>For example {@code john@doe.com} would be encoded to:</p>
*
* <pre>&amp;#106;&amp;#111;&amp;#104;&amp;#110;&amp;#64;&amp;#100;&amp;#111;&amp;#101;&amp;#46;&amp;#99;&amp;#111;&amp;#109;</pre>
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a> * @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeHtmlEntities">rife.render.EncodeHtmlEntities</a>
* @since 1.0 * @since 1.0
*/ */
public class EncodeHtmlEntities implements ValueRenderer { public class EncodeHtmlEntities implements ValueRenderer {

1
lib/src/main/java/rife/render/EncodeUnicode.java
View file

@ -32,6 +32,7 @@ import rife.tools.StringUtils;
* </pre> * </pre>
* *
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a> * @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeUnicode">rife.render.EncodeUnicode</a>
* @see StringUtils#encodeUnicode(String) * @see StringUtils#encodeUnicode(String)
* @since 1.0 * @since 1.0
*/ */

1
lib/src/main/java/rife/render/EncodeUrl.java
View file

@ -32,6 +32,7 @@ import rife.tools.StringUtils;
* </pre> * </pre>
* *
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a> * @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeUrl">rife.render.EncodeUrl</a>
* @see StringUtils#encodeUrl(String) * @see StringUtils#encodeUrl(String)
* @since 1.0 * @since 1.0
*/ */

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

@ -58,13 +58,6 @@ class TestEncode {
assertThat(t.getContent()).isEqualTo("{\n \"foo\": \"This is a \\\"\\u2022test\\\"\"\n}"); assertThat(t.getContent()).isEqualTo("{\n \"foo\": \"This is a \\\"\\u2022test\\\"\"\n}");
} }
@Test
void testEncodeQp() {
var t = TemplateFactory.TXT.get("encodeQp");
t.setAttribute(TestCase.FOO, TestCase.SAMPLE_TEXT + "\nAnd one more test for =A0.");
assertThat(t.getContent()).isEqualTo("This=20is=20a=20test=2E=0AAnd=20one=20more=20test=20for=20=3DA0=2E");
}
@Test @Test
void testEncodeRot13() { void testEncodeRot13() {
var t = TemplateFactory.TXT.get("rot13"); var t = TemplateFactory.TXT.get("rot13");