@@ -58,8 +53,6 @@
-
-
@@ -113,4 +106,4 @@
-
\ No newline at end of file
+
diff --git a/lib/bld/bld-wrapper.jar b/lib/bld/bld-wrapper.jar
index 15c39db..1c1580c 100644
Binary files a/lib/bld/bld-wrapper.jar and b/lib/bld/bld-wrapper.jar differ
diff --git a/lib/bld/bld-wrapper.properties b/lib/bld/bld-wrapper.properties
index d3d50c0..c1d316f 100644
--- a/lib/bld/bld-wrapper.properties
+++ b/lib/bld/bld-wrapper.properties
@@ -1,8 +1,8 @@
bld.downloadExtensionJavadoc=false
bld.downloadExtensionSources=true
-bld.extension-pmd=com.uwyn.rife2:bld-pmd:0.9.7
-bld.extension-jacoco=com.uwyn.rife2:bld-jacoco-report:0.9.3
+bld.downloadLocation=
+bld.extension-jacoco=com.uwyn.rife2:bld-jacoco-report:0.9.9
+bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.2.0
bld.extension-tests=com.uwyn.rife2:bld-tests-badge:1.4.6
bld.repositories=MAVEN_CENTRAL,MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
-bld.downloadLocation=
-bld.version=1.9.0
+bld.version=2.2.1
diff --git a/src/bld/java/rife/render/TemplateRenderersBuild.java b/src/bld/java/rife/render/TemplateRenderersBuild.java
index d8b05d1..4f4fc5e 100644
--- a/src/bld/java/rife/render/TemplateRenderersBuild.java
+++ b/src/bld/java/rife/render/TemplateRenderersBuild.java
@@ -27,7 +27,6 @@ import rife.bld.publish.PublishInfo;
import rife.bld.publish.PublishLicense;
import rife.bld.publish.PublishScm;
-import java.io.IOException;
import java.util.List;
import static rife.bld.dependencies.Repository.*;
@@ -41,7 +40,7 @@ public class TemplateRenderersBuild extends Project {
public TemplateRenderersBuild() {
pkg = "rife.render";
name = "rife2-template-renderers";
- version = version(1, 1, 5);
+ version = version(1, 2, 1, "SNAPSHOT");
javaRelease = 17;
downloadSources = true;
@@ -49,11 +48,11 @@ public class TemplateRenderersBuild extends Project {
repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES);
scope(compile)
- .include(dependency("com.uwyn.rife2", "rife2", version(1, 7, 3)));
+ .include(dependency("com.uwyn.rife2", "rife2", version(1, 9, 1)));
scope(test)
- .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 2)))
- .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 2)))
- .include(dependency("org.assertj", "assertj-core", version(3, 25, 3)));
+ .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 12, 0)))
+ .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 12, 0)))
+ .include(dependency("org.assertj", "assertj-core", version(3, 27, 3)));
javadocOperation().javadocOptions()
.docTitle("RIFE2 Template Renderers")
@@ -62,13 +61,13 @@ public class TemplateRenderersBuild extends Project {
.link("https://rife2.github.io/rife2/");
publishOperation()
- .repository(version.isSnapshot() ? repository(SONATYPE_SNAPSHOTS.location())
+ .repository(version.isSnapshot() ? SONATYPE_SNAPSHOTS
.withCredentials(property("sonatypeUser"), property("sonatypePassword"))
- : repository(SONATYPE_RELEASES.location())
+ : SONATYPE_RELEASES
.withCredentials(property("sonatypeUser"), property("sonatypePassword")))
- .repository(version.isSnapshot() ? repository(RIFE2_SNAPSHOTS.location())
+ .repository(version.isSnapshot() ? RIFE2_SNAPSHOTS
.withCredentials(property("rife2Username"), property("rife2Password"))
- : repository(RIFE2_RELEASES.location())
+ : RIFE2_RELEASES
.withCredentials(property("rife2Username"), property("rife2Password")))
.info(new PublishInfo()
.groupId("com.uwyn.rife2")
@@ -76,13 +75,21 @@ public class TemplateRenderersBuild extends Project {
.name("RIFE2 Template Renderers")
.description("Template Renderers for the RIFE2 web framework")
.url("https://github.com/rife2/rife2-template-renderers")
- .developer(new PublishDeveloper().id("ethauvin").name("Erik C. Thauvin").email("erik@thauvin.net")
+ .developer(new PublishDeveloper()
+ .id("ethauvin")
+ .name("Erik C. Thauvin")
+ .email("erik@thauvin.net")
.url("https://erik.thauvin.net/"))
- .developer(new PublishDeveloper().id("gbevin").name("Geert Bevin").email("gbevin@uwyn.com")
+ .developer(new PublishDeveloper()
+ .id("gbevin")
+ .name("Geert Bevin")
+ .email("gbevin@uwyn.com")
.url("https://github.com/gbevin"))
- .license(new PublishLicense().name("The Apache License, Version 2.0")
- .url("http://www.apache.org/licenses/LICENSE-2.0.txt"))
- .scm(new PublishScm().connection("scm:git:https://github.com/rife2/rife2-template-renderers.git")
+ .license(new PublishLicense()
+ .name("The Apache License, Version 2.0")
+ .url("https://www.apache.org/licenses/LICENSE-2.0.txt"))
+ .scm(new PublishScm()
+ .connection("scm:git:https://github.com/rife2/rife2-template-renderers.git")
.developerConnection("scm:git:git@github.com:rife2/rife2-template-renderers.git")
.url("https://github.com/rife2/rife2-template-renderers"))
.signKey(property("signKey"))
@@ -94,14 +101,14 @@ public class TemplateRenderersBuild extends Project {
}
@BuildCommand(summary = "Generates JaCoCo Reports")
- public void jacoco() throws IOException {
+ public void jacoco() throws Exception {
new JacocoReportOperation()
.fromProject(this)
.execute();
}
@BuildCommand(summary = "Runs PMD analysis")
- public void pmd() {
+ public void pmd() throws Exception {
new PmdOperation()
.fromProject(this)
.failOnViolation(true)
@@ -115,4 +122,4 @@ public class TemplateRenderersBuild extends Project {
.apiKey(property("testsBadgeApiKey"))
.fromProject(this));
}
-}
\ No newline at end of file
+}
diff --git a/src/main/java/rife/render/Abbreviate.java b/src/main/java/rife/render/Abbreviate.java
index b0b38e5..dfacacb 100644
--- a/src/main/java/rife/render/Abbreviate.java
+++ b/src/main/java/rife/render/Abbreviate.java
@@ -21,7 +21,7 @@ import rife.template.Template;
import rife.template.ValueRenderer;
/**
- * Abbreviate a template value with ellipses.
+ * Abbreviates a template value with ellipses.
*
* Usage:
*
@@ -36,7 +36,18 @@ import rife.template.ValueRenderer;
*/
public class Abbreviate implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value abbreviated with ellipses.
+ *
+ * Two parameters can be specified:
+ *
+ * mark: the string that will be used to abbreviate the value. Default is ...max: the maximum number of characters to render. Default is -1 (no abbreviation).
+ *
+ * @param template the template that contains the value
+ * @param valueId the id of the value to render
+ * @param differentiator a generic string that can be used to differentiate the rendering
+ * @return the abbreviated value, or the original value if no abbreviation is necessary
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/BeatTime.java b/src/main/java/rife/render/BeatTime.java
index 23849f3..f11f97f 100644
--- a/src/main/java/rife/render/BeatTime.java
+++ b/src/main/java/rife/render/BeatTime.java
@@ -38,7 +38,12 @@ import java.time.ZonedDateTime;
*/
public class BeatTime implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the current time in Swatch Internet (.beat) Time format.
+ *
+ * @param template the template instance
+ * @param valueId the value id
+ * @param differentiator the differentiator
+ * @return the rendered value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/Capitalize.java b/src/main/java/rife/render/Capitalize.java
index 7805b4c..e0d769f 100644
--- a/src/main/java/rife/render/Capitalize.java
+++ b/src/main/java/rife/render/Capitalize.java
@@ -37,7 +37,12 @@ import rife.tools.StringUtils;
*/
public class Capitalize implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value by capitalizing it.
+ *
+ * @param template the template containing the value to be rendered
+ * @param valueId the identifier of the value to render
+ * @param differentiator a string used to differentiate the rendering
+ * @return the capitalized and encoded value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/CapitalizeWords.java b/src/main/java/rife/render/CapitalizeWords.java
new file mode 100644
index 0000000..e95e6f8
--- /dev/null
+++ b/src/main/java/rife/render/CapitalizeWords.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2023-2024 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;
+
+/**
+ * Capitalizes words of a template value.
+ *
+ * Usage:
+ *
+ *
+ * <!--v render:rife.render.CapitalizeWords:valueId/-->
+ * {{v render:rife.render.CapitalizeWords:valueId/}}
+ *
+ *
+ * @author Erik C. Thauvin
+ * @see rife.render.CapitalizeWords
+ * @since 1.2
+ */
+public class CapitalizeWords implements ValueRenderer {
+ /**
+ * Returns the template value by capitalizing it.
+ *
+ * @param template the template containing the value to be rendered
+ * @param valueId the identifier of the value to render
+ * @param differentiator a string used to differentiate the rendering
+ * @return the capitalized and encoded value
+ */
+ @Override
+ public String render(Template template, String valueId, String differentiator) {
+ return template.getEncoder().encode(RenderUtils.capitalizeWords(template.getValueOrAttribute(differentiator)));
+ }
+}
diff --git a/src/main/java/rife/render/DateIso.java b/src/main/java/rife/render/DateIso.java
index a2f1f9e..0da04e6 100644
--- a/src/main/java/rife/render/DateIso.java
+++ b/src/main/java/rife/render/DateIso.java
@@ -23,7 +23,7 @@ import rife.template.ValueRenderer;
import java.time.ZonedDateTime;
/**
- * Return the current date in ISO 8601 format.
+ * Renders the current date in ISO 8601 format.
*
* Usage:
*
@@ -38,7 +38,12 @@ import java.time.ZonedDateTime;
*/
public class DateIso implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the current date in ISO 8601 format, encoded according to the template's encoding rules.
+ *
+ * @param template the template that is currently being rendered
+ * @param valueId the value id that triggers the rendering of this value renderer
+ * @param differentiator a differentiator that may be used to differentiate the rendering of this value renderer
+ * @return the current date in ISO 8601 format, encoded according to the template's encoding rules
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/DateTimeIso.java b/src/main/java/rife/render/DateTimeIso.java
index 805a6cd..e8513bb 100644
--- a/src/main/java/rife/render/DateTimeIso.java
+++ b/src/main/java/rife/render/DateTimeIso.java
@@ -24,7 +24,7 @@ import java.time.ZoneId;
import java.time.ZonedDateTime;
/**
- * Return the current date and time in ISO 8601 format.
+ * Renders the current date and time in ISO 8601 format.
*
* Usage:
*
@@ -39,7 +39,15 @@ import java.time.ZonedDateTime;
*/
public class DateTimeIso implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Renders the current date and time in ISO 8601 format.
+ *
+ * Additionally, it allows specifying a time zone through the template's default value properties with the key
+ * {@code tz}. If no time zone is specified, the system default time zone is used.
+ *
+ * @param template the template that is currently being rendered
+ * @param valueId the id of the value to be rendered
+ * @param differentiator a differentiator that may be used to differentiate the rendering of this value renderer
+ * @return the current date and time in ISO 8601 format
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/DateTimeRfc2822.java b/src/main/java/rife/render/DateTimeRfc2822.java
index 3a33842..2bdbd54 100644
--- a/src/main/java/rife/render/DateTimeRfc2822.java
+++ b/src/main/java/rife/render/DateTimeRfc2822.java
@@ -23,7 +23,7 @@ import rife.template.ValueRenderer;
import java.time.ZonedDateTime;
/**
- * Return the current date and time in RFC 2822 format.
+ * Renders the current date and time in RFC 2822 format.
*
* Usage:
*
@@ -38,7 +38,12 @@ import java.time.ZonedDateTime;
*/
public class DateTimeRfc2822 implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the current date and time in RFC 2822 format.
+ *
+ * @param template the template instance
+ * @param valueId the value id
+ * @param differentiator the differentiator
+ * @return the current date and time in RFC 2822 format
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/EncodeBase64.java b/src/main/java/rife/render/EncodeBase64.java
index 95d1e30..e00b24c 100644
--- a/src/main/java/rife/render/EncodeBase64.java
+++ b/src/main/java/rife/render/EncodeBase64.java
@@ -40,7 +40,12 @@ import java.nio.charset.StandardCharsets;
*/
public class EncodeBase64 implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value encoded to Base64.
+ *
+ * @param template the template that contains the value
+ * @param valueId the id of the value
+ * @param differentiator the differentiator to use
+ * @return the Base64-encoded value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/EncodeHtml.java b/src/main/java/rife/render/EncodeHtml.java
index ee14bdd..b67959d 100644
--- a/src/main/java/rife/render/EncodeHtml.java
+++ b/src/main/java/rife/render/EncodeHtml.java
@@ -38,7 +38,12 @@ import rife.tools.StringUtils;
*/
public class EncodeHtml implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value encoded to HTML.
+ *
+ * @param template the template containing the value to be rendered
+ * @param valueId the identifier of the value to render
+ * @param differentiator a string used to differentiate the rendering
+ * @return the HTML-encoded value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/EncodeHtmlEntities.java b/src/main/java/rife/render/EncodeHtmlEntities.java
index bbf6043..cee3e8b 100644
--- a/src/main/java/rife/render/EncodeHtmlEntities.java
+++ b/src/main/java/rife/render/EncodeHtmlEntities.java
@@ -36,7 +36,12 @@ import rife.template.ValueRenderer;
*/
public class EncodeHtmlEntities implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value encoded to HTML decimal entities.
+ *
+ * @param template the template instance
+ * @param valueId the value id
+ * @param differentiator the differentiator
+ * @return the encoded value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/EncodeJs.java b/src/main/java/rife/render/EncodeJs.java
index 52c757d..27de902 100644
--- a/src/main/java/rife/render/EncodeJs.java
+++ b/src/main/java/rife/render/EncodeJs.java
@@ -38,7 +38,12 @@ import rife.tools.StringUtils;
*/
public class EncodeJs implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value encoded to JavaScript/ECMAScript.
+ *
+ * @param template the template that contains the value
+ * @param valueId the id of the value
+ * @param differentiator the differentiator to use
+ * @return the JavaScript/ECMAScript-encoded value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/EncodeJson.java b/src/main/java/rife/render/EncodeJson.java
index 95fbf34..8e17b29 100644
--- a/src/main/java/rife/render/EncodeJson.java
+++ b/src/main/java/rife/render/EncodeJson.java
@@ -38,7 +38,12 @@ import rife.tools.StringUtils;
*/
public class EncodeJson implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value encoded to JSON.
+ *
+ * @param template the template that contains the value
+ * @param valueId the id of the value
+ * @param differentiator the differentiator to use
+ * @return the JSON-encoded value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/EncodeUnicode.java b/src/main/java/rife/render/EncodeUnicode.java
index 061da96..afd2a48 100644
--- a/src/main/java/rife/render/EncodeUnicode.java
+++ b/src/main/java/rife/render/EncodeUnicode.java
@@ -38,7 +38,12 @@ import rife.tools.StringUtils;
*/
public class EncodeUnicode implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value encoded to Unicode escape codes.
+ *
+ * @param template the template that contains the value
+ * @param valueId the id of the value
+ * @param differentiator the differentiator to use
+ * @return the Unicode escape codes-encoded value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/EncodeUrl.java b/src/main/java/rife/render/EncodeUrl.java
index a6c554f..b977353 100644
--- a/src/main/java/rife/render/EncodeUrl.java
+++ b/src/main/java/rife/render/EncodeUrl.java
@@ -38,7 +38,12 @@ import rife.tools.StringUtils;
*/
public class EncodeUrl implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value encoded to URL.
+ *
+ * @param template the template that contains the value
+ * @param valueId the id of the value
+ * @param differentiator the differentiator to use
+ * @return the URL-encoded value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/EncodeXml.java b/src/main/java/rife/render/EncodeXml.java
index b1c6eff..00b0faa 100644
--- a/src/main/java/rife/render/EncodeXml.java
+++ b/src/main/java/rife/render/EncodeXml.java
@@ -38,7 +38,12 @@ import rife.tools.StringUtils;
*/
public class EncodeXml implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value encoded to XML.
+ *
+ * @param template the template that contains the value
+ * @param valueId the id of the value
+ * @param differentiator the differentiator to use
+ * @return the XML-encoded value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/FormatCreditCard.java b/src/main/java/rife/render/FormatCreditCard.java
index f2fc815..fec124d 100644
--- a/src/main/java/rife/render/FormatCreditCard.java
+++ b/src/main/java/rife/render/FormatCreditCard.java
@@ -36,7 +36,12 @@ import rife.template.ValueRenderer;
*/
public class FormatCreditCard implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the last 4 digits of the template credit number value.
+ *
+ * @param template the {@link Template}
+ * @param valueId the value id
+ * @param differentiator the differentiator
+ * @return the formatted value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/Lowercase.java b/src/main/java/rife/render/Lowercase.java
index 8513222..6f9f2ec 100644
--- a/src/main/java/rife/render/Lowercase.java
+++ b/src/main/java/rife/render/Lowercase.java
@@ -37,7 +37,12 @@ import rife.tools.Localization;
*/
public class Lowercase implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value converted to lowercase.
+ *
+ * @param template the template that contains the value
+ * @param valueId the id of the value
+ * @param differentiator the differentiator to use
+ * @return the lowercase value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/Mask.java b/src/main/java/rife/render/Mask.java
index eb96702..fe0a709 100644
--- a/src/main/java/rife/render/Mask.java
+++ b/src/main/java/rife/render/Mask.java
@@ -35,8 +35,30 @@ import rife.template.ValueRenderer;
* @since 1.0
*/
public class Mask implements ValueRenderer {
+
/**
- * {@inheritDoc}
+ * Renders a template value with characters of the value masked using the specified mask.
+ *
+ * The mask is specified as a template default value with the following syntax:
+ *
+ *
+ * mask=<mask>[,unmasked=<unmasked>][,fromStart=<fromStart>]
+ *
+ *
+ * Where:
+ *
+ *
+ * - mask is the character to use for masking, defaulting to
*
+ * - unmasked is the number of characters at the beginning of the value that should be left unmasked,
+ * defaulting to
0
+ * - fromStart is a boolean indicating whether the unmasked value should be counted from
+ * the start of the value, defaulting to
false
+ *
+ *
+ * @param template the template to render the value in
+ * @param valueId the ID of the value to render
+ * @param differentiator the differentiator of the value to render
+ * @return the rendered value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/Normalize.java b/src/main/java/rife/render/Normalize.java
index a07fb9b..b6cb9d1 100644
--- a/src/main/java/rife/render/Normalize.java
+++ b/src/main/java/rife/render/Normalize.java
@@ -36,7 +36,12 @@ import rife.template.ValueRenderer;
*/
public class Normalize implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value normalized for inclusion in a URL path.
+ *
+ * @param template the template that contains the value
+ * @param valueId the id of the value
+ * @param differentiator the differentiator to use
+ * @return the normalized value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/QrCode.java b/src/main/java/rife/render/QrCode.java
index ddf8091..47f74c0 100644
--- a/src/main/java/rife/render/QrCode.java
+++ b/src/main/java/rife/render/QrCode.java
@@ -36,7 +36,12 @@ import rife.template.ValueRenderer;
*/
public class QrCode implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value encoded as an SVG QR Code.
+ *
+ * @param template the template that contains the value
+ * @param valueId the id of the value
+ * @param differentiator the differentiator to use
+ * @return the SVG QR Code
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/RenderUtils.java b/src/main/java/rife/render/RenderUtils.java
index 43c92c1..c05f5b9 100644
--- a/src/main/java/rife/render/RenderUtils.java
+++ b/src/main/java/rife/render/RenderUtils.java
@@ -83,7 +83,7 @@ public final class RenderUtils {
DateTimeFormatter.ofPattern("EEE, d MMM yyyy HH:mm:ss zzz").withLocale(Localization.getLocale());
private static final String DEFAULT_USER_AGENT =
"Mozilla/5.0 (X11; Linux x86_64; rv:109.0) Gecko/20100101 Firefox/111.0";
- private final static Logger LOGGER = Logger.getLogger(RenderUtils.class.getName());
+ private static final Logger LOGGER = Logger.getLogger(RenderUtils.class.getName());
private RenderUtils() {
// no-op
@@ -124,6 +124,38 @@ public final class RenderUtils {
return String.format("@%03d", beats);
}
+ /**
+ * Returns a {@code String} with the first letter of each word capitalized.
+ *
+ * @param src the source {@code String}
+ * @return the capitalized {@code String}
+ */
+ public static String capitalizeWords(String src) {
+ if (src == null || src.isBlank()) {
+ return src;
+ }
+
+ var result = new StringBuilder();
+ var capitalizeNext = true;
+
+ for (var i = 0; i < src.length(); i++) {
+ var c = src.charAt(i);
+ if (Character.isWhitespace(c)) {
+ capitalizeNext = true;
+ result.append(c);
+ } else {
+ if (capitalizeNext) {
+ result.append(Character.toUpperCase(c));
+ } else {
+ result.append(Character.toLowerCase(c));
+ }
+ capitalizeNext = false;
+ }
+ }
+
+ return result.toString();
+ }
+
/**
* Encodes the source {@code String} to the specified encoding.
*
@@ -216,8 +248,9 @@ public final class RenderUtils {
public static String fetchUrl(String url, String defaultContent) {
try {
var fetchUrl = new URL(url);
+ HttpURLConnection connection = null;
try {
- var connection = (HttpURLConnection) fetchUrl.openConnection();
+ connection = (HttpURLConnection) fetchUrl.openConnection();
connection.setRequestProperty("User-Agent", DEFAULT_USER_AGENT);
var code = connection.getResponseCode();
if (code >= 200 && code <= 399) {
@@ -233,10 +266,15 @@ public final class RenderUtils {
if (LOGGER.isLoggable(Level.WARNING)) {
LOGGER.log(Level.WARNING, "An IO error occurred while connecting to " + fetchUrl.getHost(), ioe);
}
+ } finally {
+ if (connection != null) {
+ connection.disconnect();
+ }
}
} catch (MalformedURLException ignored) {
// do nothing
}
+
return defaultContent;
}
@@ -334,21 +372,20 @@ public final class RenderUtils {
return src;
}
- var normalized = Normalizer.normalize(src.trim(), Normalizer.Form.NFD);
- var sb = new StringBuilder(normalized.length());
- boolean space = false;
- for (var c : normalized.toCharArray()) {
- if (c <= '\u007F') { // ascii only
- if (!space && c == ' ') {
- space = true;
- sb.append('-');
- } else {
- space = false;
- if (c >= '0' && c <= '9' || c >= 'a' && c <= 'z') {
- sb.append(c);
- } else if (c >= 'A' && c <= 'Z') {
- sb.append((char) (c + 32)); // lowercase
+ var normalized = Normalizer.normalize(src.trim(), Normalizer.Form.NFD).toCharArray();
+
+ var sb = new StringBuilder(normalized.length);
+ for (var i = 0; i < normalized.length; i++) {
+ var c = normalized[i];
+ if (c <= '\u007F') { // ASCII only
+ if (" &()-_=[{]}\\|;:,<.>/".indexOf(c) != -1) { // common separators
+ if (!sb.isEmpty() && i != normalized.length - 1 && sb.charAt(sb.length() - 1) != '-') {
+ sb.append('-');
}
+ } else if (c >= '0' && c <= '9' || c >= 'a' && c <= 'z') { // letters & digits
+ sb.append(c);
+ } else if (c >= 'A' && c <= 'Z') { // uppercase letters
+ sb.append((char) (c + 32)); // make lowercase
}
}
}
diff --git a/src/main/java/rife/render/Rot13.java b/src/main/java/rife/render/Rot13.java
index d9e5326..75e3dd7 100644
--- a/src/main/java/rife/render/Rot13.java
+++ b/src/main/java/rife/render/Rot13.java
@@ -36,7 +36,12 @@ import rife.template.ValueRenderer;
*/
public class Rot13 implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value translated to/from ROT13.
+ *
+ * @param template the template that contains the value
+ * @param valueId the id of the value
+ * @param differentiator the differentiator to use
+ * @return the ROT13 value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/ShortenUrl.java b/src/main/java/rife/render/ShortenUrl.java
index 1ceeec9..204d7c6 100644
--- a/src/main/java/rife/render/ShortenUrl.java
+++ b/src/main/java/rife/render/ShortenUrl.java
@@ -38,7 +38,12 @@ import rife.template.ValueRenderer;
*/
public class ShortenUrl implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value shortened using is.gid.
+ *
+ * @param template the template that contains the value
+ * @param valueId the id of the value
+ * @param differentiator the differentiator to use
+ * @return the template shortened value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/SwapCase.java b/src/main/java/rife/render/SwapCase.java
index 4278768..1fd996a 100644
--- a/src/main/java/rife/render/SwapCase.java
+++ b/src/main/java/rife/render/SwapCase.java
@@ -21,7 +21,7 @@ import rife.template.Template;
import rife.template.ValueRenderer;
/**
- * Swap case of a template value.
+ * Swaps case of a template value.
*
* Usage:
*
@@ -35,9 +35,13 @@ import rife.template.ValueRenderer;
* @since 1.0
*/
public class SwapCase implements ValueRenderer {
-
/**
- * {@inheritDoc}
+ * Returns the template value with swapped case.
+ *
+ * @param template the template that contains the value
+ * @param valueId the id of the value
+ * @param differentiator the differentiator to use
+ * @return the swapped case value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/TimeIso.java b/src/main/java/rife/render/TimeIso.java
index a62c44b..01bf5b2 100644
--- a/src/main/java/rife/render/TimeIso.java
+++ b/src/main/java/rife/render/TimeIso.java
@@ -23,7 +23,7 @@ import rife.template.ValueRenderer;
import java.time.ZonedDateTime;
/**
- * Return the current time in ISO 8601 format.
+ * Renders the current time in ISO 8601 format.
*
* Usage:
*
@@ -38,7 +38,12 @@ import java.time.ZonedDateTime;
*/
public class TimeIso implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the current time in ISO 8601 format.
+ *
+ * @param template the template that is currently being rendered
+ * @param valueId the id of the value to be rendered
+ * @param differentiator a differentiator that may be used to differentiate the rendering of this value renderer
+ * @return the current time in ISO 8601 format
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/Trim.java b/src/main/java/rife/render/Trim.java
index f3b2980..a0951b4 100644
--- a/src/main/java/rife/render/Trim.java
+++ b/src/main/java/rife/render/Trim.java
@@ -36,7 +36,12 @@ import rife.template.ValueRenderer;
*/
public class Trim implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Renders the template value by removing leading and trailing whitespace.
+ *
+ * @param template the template instance
+ * @param valueId the id of the value to render
+ * @param differentiator an optional differentiator to use for cache invalidation
+ * @return the trimmed value, or the original value if it is {@code null} or empty
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/Uncapitalize.java b/src/main/java/rife/render/Uncapitalize.java
index 53b8a45..20b0aad 100644
--- a/src/main/java/rife/render/Uncapitalize.java
+++ b/src/main/java/rife/render/Uncapitalize.java
@@ -37,7 +37,12 @@ import rife.tools.StringUtils;
*/
public class Uncapitalize implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the un-capitalized template value.
+ *
+ * @param template the template to render
+ * @param valueId the id of the value to render
+ * @param differentiator the differentiator to use for the value lookup
+ * @return the un-capitalized value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/Uppercase.java b/src/main/java/rife/render/Uppercase.java
index 31ecd9a..92e57a5 100644
--- a/src/main/java/rife/render/Uppercase.java
+++ b/src/main/java/rife/render/Uppercase.java
@@ -22,7 +22,7 @@ import rife.template.ValueRenderer;
import rife.tools.Localization;
/**
- * Convert a template value to uppercase.
+ * Converts a template value to uppercase.
*
* Usage:
*
@@ -37,7 +37,12 @@ import rife.tools.Localization;
*/
public class Uppercase implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Returns the template value converted to uppercase.
+ *
+ * @param template the template that contains the value
+ * @param valueId the id of the value
+ * @param differentiator the differentiator to use
+ * @return the uppercased value
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/Uptime.java b/src/main/java/rife/render/Uptime.java
index 2fe1a5d..14bb2de 100644
--- a/src/main/java/rife/render/Uptime.java
+++ b/src/main/java/rife/render/Uptime.java
@@ -38,7 +38,12 @@ import java.lang.management.ManagementFactory;
*/
public class Uptime implements ValueRenderer {
/**
- * {@inheritDoc}
+ * Renders the server uptime.
+ *
+ * @param template the template that is currently being rendered
+ * @param valueId the id of the value to render
+ * @param differentiator a differentiator that may be used to differentiate the rendering of this value renderer
+ * @return the server uptime
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/main/java/rife/render/Year.java b/src/main/java/rife/render/Year.java
index b79911a..cb8c8f5 100644
--- a/src/main/java/rife/render/Year.java
+++ b/src/main/java/rife/render/Year.java
@@ -37,9 +37,13 @@ import java.time.ZonedDateTime;
* @since 1.0
*/
public class Year implements ValueRenderer {
-
/**
- * {@inheritDoc}
+ * Renders the current year.
+ *
+ * @param template the template that is currently being rendered
+ * @param valueId the id of the value to render
+ * @param differentiator a differentiator that may be used to differentiate the rendering of this value renderer
+ * @return the current year
*/
@Override
public String render(Template template, String valueId, String differentiator) {
diff --git a/src/test/java/rife/render/DisabledOnCi.java b/src/test/java/rife/render/DisabledOnCi.java
index 2fab8c9..8c369d6 100644
--- a/src/test/java/rife/render/DisabledOnCi.java
+++ b/src/test/java/rife/render/DisabledOnCi.java
@@ -30,7 +30,7 @@ import java.lang.annotation.Target;
* @author Erik C. Thauvin
* @since 1.0
*/
-@Target({ ElementType.TYPE, ElementType.METHOD })
+@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@ExtendWith(DisableOnCiCondition.class)
public @interface DisabledOnCi {
diff --git a/src/test/java/rife/render/TestEncode.java b/src/test/java/rife/render/TestEncode.java
index d02571f..bc390d4 100644
--- a/src/test/java/rife/render/TestEncode.java
+++ b/src/test/java/rife/render/TestEncode.java
@@ -56,7 +56,7 @@ class TestEncode {
assertThat(t.getContent()).isEqualTo("\\'\\\"\\\\\\/");
t = TemplateFactory.TXT.get("encodeJs");
- t.setAttribute(TestCase.FOO, "This is\f\b a\r\n\ttest");
+ t.setAttribute(TestCase.FOO, "This is\f\b a\r\n\ttest");
assertThat(t.getContent()).isEqualTo("This is\\f\\b a\\r\\n\\ttest");
t = TemplateFactory.HTML.get("encodeJs");
diff --git a/src/test/java/rife/render/TestRenderUtils.java b/src/test/java/rife/render/TestRenderUtils.java
index 6ab1a22..f1f8c46 100644
--- a/src/test/java/rife/render/TestRenderUtils.java
+++ b/src/test/java/rife/render/TestRenderUtils.java
@@ -17,6 +17,7 @@
package rife.render;
+import org.assertj.core.api.AutoCloseableSoftAssertions;
import org.junit.jupiter.api.Test;
import java.util.Properties;
@@ -39,6 +40,17 @@ class TestRenderUtils {
assertThat(RenderUtils.abbreviate("", 10, "")).as("").isEmpty();
}
+ @Test
+ void testCapitalizeWords() {
+ assertThat(RenderUtils.capitalizeWords("hello world")).isEqualTo("Hello World");
+ assertThat(RenderUtils.capitalizeWords("java programming")).isEqualTo("Java Programming");
+ assertThat(RenderUtils.capitalizeWords("TEST")).isEqualTo("Test");
+ assertThat(RenderUtils.capitalizeWords("multiple spaces")).isEqualTo("Multiple Spaces");
+ assertThat(RenderUtils.capitalizeWords("white\t\fspaces")).isEqualTo("White\t\fSpaces");
+ assertThat(RenderUtils.capitalizeWords("")).isEmpty();
+ assertThat(RenderUtils.capitalizeWords(null)).isNull();
+ }
+
@Test
void testEncode() {
var p = new Properties();
@@ -96,8 +108,14 @@ class TestRenderUtils {
@Test
void testNormalize() {
- assertThat(RenderUtils.normalize("")).isEmpty();
- assertThat(RenderUtils.normalize(SAMPLE_GERMAN)).isEqualTo("mochten-sie-ein-paar-apfel");
+ assertThat(RenderUtils.normalize("")).as("empty").isEmpty();
+ assertThat(RenderUtils.normalize(" &()-_=[{]}\\|;:,<.>/")).as("blank").isEmpty();
+ assertThat(RenderUtils.normalize(SAMPLE_GERMAN)).as("greman").isEqualTo("mochten-sie-ein-paar-apfel");
+ assertThat(RenderUtils.normalize("foo bar, ,foo:bar,foo;(bar), {foo} & bar=foo.bar[foo|bar]"))
+ .as("foo-bar")
+ .isEqualTo("foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar");
+ assertThat(RenderUtils.normalize("News for January 6, 2023 (Paris)")).as("docs example")
+ .isEqualTo("news-for-january-6-2023-paris");
}
@Test
@@ -121,10 +139,12 @@ class TestRenderUtils {
@Test
void testValidateCreditCard() {
- assertThat(RenderUtils.validateCreditCard("4505 4672 3366 6430")).as("visa").isTrue();
- assertThat(RenderUtils.validateCreditCard("5189-5923-3915-0425")).as("mastercard").isTrue();
- assertThat(RenderUtils.validateCreditCard("3433634926643302")).as("amex").isTrue();
- assertThat(RenderUtils.validateCreditCard("6011 1076-8252 0629")).as("discover").isTrue();
- assertThat(RenderUtils.validateCreditCard("0123456789012345")).as("invalid").isFalse();
+ try (var softly = new AutoCloseableSoftAssertions()) {
+ softly.assertThat(RenderUtils.validateCreditCard("4505 4672 3366 6430")).as("visa").isTrue();
+ softly.assertThat(RenderUtils.validateCreditCard("5189-5923-3915-0425")).as("mastercard").isTrue();
+ softly.assertThat(RenderUtils.validateCreditCard("3433634926643302")).as("amex").isTrue();
+ softly.assertThat(RenderUtils.validateCreditCard("6011 1076-8252 0629")).as("discover").isTrue();
+ softly.assertThat(RenderUtils.validateCreditCard("0123456789012345")).as("invalid").isFalse();
+ }
}
}