From b21cdbeddb97c2211393d5a51398d5836d31cc86 Mon Sep 17 00:00:00 2001
From: "Matteo Franci a.k.a. Fugerit" <m@fugerit.org>
Date: Thu, 8 Aug 2024 20:15:44 +0200
Subject: [PATCH] text wrap function (using zero with space)

---
 CHANGELOG.md                                  |  1 +
 .../java/doc/base/helper/TextWrapHelper.java  | 22 +++++++++++++++++++
 .../doc/base/helper/TestTextWrapHelper.java   | 17 ++++++++++++++
 .../java/doc/freemarker/fun/FMFunHelper.java  | 21 ++++++++++++++++++
 .../doc/freemarker/fun/SimpleMessageFun.java  |  4 +---
 .../java/doc/freemarker/fun/TextWrapFun.java  | 21 ++++++++++++++++++
 .../fj_doc_test/freemarker-doc-process.xml    |  1 +
 .../fj_doc_test/template/test_01.ftl          |  3 +++
 8 files changed, 87 insertions(+), 3 deletions(-)
 create mode 100644 fj-doc-base/src/main/java/org/fugerit/java/doc/base/helper/TextWrapHelper.java
 create mode 100644 fj-doc-base/src/test/java/test/org/fugerit/java/doc/base/helper/TestTextWrapHelper.java
 create mode 100644 fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/fun/FMFunHelper.java
 create mode 100644 fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/fun/TextWrapFun.java

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d50825d34..17f57aad3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - [playground-quarkus] Config conversion user interface
+- [freemarker] text wrap function (using zero with space `&#8203;`)
 
 ### Changed
 
diff --git a/fj-doc-base/src/main/java/org/fugerit/java/doc/base/helper/TextWrapHelper.java b/fj-doc-base/src/main/java/org/fugerit/java/doc/base/helper/TextWrapHelper.java
new file mode 100644
index 000000000..2d07e39e2
--- /dev/null
+++ b/fj-doc-base/src/main/java/org/fugerit/java/doc/base/helper/TextWrapHelper.java
@@ -0,0 +1,22 @@
+package org.fugerit.java.doc.base.helper;
+
+import org.fugerit.java.core.function.SafeFunction;
+
+public class TextWrapHelper {
+
+    private TextWrapHelper() {}
+
+    public static final String ZERO_WITH_SPACE = "&#8203;";
+
+    public static String padZeroWithSpace( String input ) {
+        return SafeFunction.getIfNotNull( input, () -> {
+            StringBuilder builder = new StringBuilder();
+            for( int i=0; i<input.length(); i++ ) {
+                builder.append( input.charAt( i ) );
+                builder.append( ZERO_WITH_SPACE );
+            }
+            return builder.toString();
+        } );
+    }
+
+}
diff --git a/fj-doc-base/src/test/java/test/org/fugerit/java/doc/base/helper/TestTextWrapHelper.java b/fj-doc-base/src/test/java/test/org/fugerit/java/doc/base/helper/TestTextWrapHelper.java
new file mode 100644
index 000000000..f7ab613a8
--- /dev/null
+++ b/fj-doc-base/src/test/java/test/org/fugerit/java/doc/base/helper/TestTextWrapHelper.java
@@ -0,0 +1,17 @@
+package test.org.fugerit.java.doc.base.helper;
+
+import org.fugerit.java.doc.base.helper.TextWrapHelper;
+import org.junit.Assert;
+import org.junit.Test;
+
+public class TestTextWrapHelper {
+
+    @Test
+    public void testWrap() {
+        String input = "123";
+        String test = "1"+TextWrapHelper.ZERO_WITH_SPACE+"2"+TextWrapHelper.ZERO_WITH_SPACE+"3"+TextWrapHelper.ZERO_WITH_SPACE;
+        String out = TextWrapHelper.padZeroWithSpace( input );
+        Assert.assertEquals( test, out );
+    }
+
+}
diff --git a/fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/fun/FMFunHelper.java b/fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/fun/FMFunHelper.java
new file mode 100644
index 000000000..285c4db94
--- /dev/null
+++ b/fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/fun/FMFunHelper.java
@@ -0,0 +1,21 @@
+package org.fugerit.java.doc.freemarker.fun;
+
+import freemarker.template.TemplateModelException;
+
+import java.util.List;
+
+public class FMFunHelper {
+
+    private FMFunHelper() {}
+
+    public static void checkFirstRequredWithMessage( List<Object> arguments, String message ) throws TemplateModelException {
+        if ( arguments.isEmpty() ) {
+            throw new TemplateModelException( message );
+        }
+    }
+
+    public static void checkFirstRequred( List<Object> arguments ) throws TemplateModelException {
+        checkFirstRequredWithMessage( arguments, "At least one parameter is needed" );
+    }
+
+}
diff --git a/fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/fun/SimpleMessageFun.java b/fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/fun/SimpleMessageFun.java
index 828883620..315e4563b 100644
--- a/fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/fun/SimpleMessageFun.java
+++ b/fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/fun/SimpleMessageFun.java
@@ -12,9 +12,7 @@ public class SimpleMessageFun implements TemplateMethodModelEx {
 
 	@Override
 	public Object exec(@SuppressWarnings("rawtypes") List arguments) throws TemplateModelException {
-		if ( arguments.isEmpty() ) {
-			throw new TemplateModelException( "At least one parameter is needed" );
-		}
+		FMFunHelper.checkFirstRequred( arguments );
 		String key = ((TemplateScalarModel)arguments.get( 0 )).getAsString();
 		Object[] args = new Object[ arguments.size()-1 ];
 		for ( int k=1; k<arguments.size(); k++ ) {
diff --git a/fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/fun/TextWrapFun.java b/fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/fun/TextWrapFun.java
new file mode 100644
index 000000000..a837063ff
--- /dev/null
+++ b/fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/fun/TextWrapFun.java
@@ -0,0 +1,21 @@
+package org.fugerit.java.doc.freemarker.fun;
+
+import freemarker.template.SimpleScalar;
+import freemarker.template.TemplateMethodModelEx;
+import freemarker.template.TemplateModelException;
+import freemarker.template.TemplateScalarModel;
+import org.fugerit.java.doc.base.helper.TextWrapHelper;
+
+import java.text.MessageFormat;
+import java.util.List;
+
+public class TextWrapFun implements TemplateMethodModelEx {
+
+	@Override
+	public Object exec(@SuppressWarnings("rawtypes") List arguments) throws TemplateModelException {
+		FMFunHelper.checkFirstRequred( arguments );
+		String input = ((TemplateScalarModel)arguments.get( 0 )).getAsString();
+		return new SimpleScalar(TextWrapHelper.padZeroWithSpace( input ));
+	}
+	
+}
diff --git a/fj-doc-freemarker/src/test/resources/fj_doc_test/freemarker-doc-process.xml b/fj-doc-freemarker/src/test/resources/fj_doc_test/freemarker-doc-process.xml
index 09a3a1f83..afb30b01c 100644
--- a/fj-doc-freemarker/src/test/resources/fj_doc_test/freemarker-doc-process.xml
+++ b/fj-doc-freemarker/src/test/resources/fj_doc_test/freemarker-doc-process.xml
@@ -19,6 +19,7 @@
 		<chainStep stepType="function">
 			<function name="messageFormat" value="org.fugerit.java.doc.freemarker.fun.SimpleMessageFun"/>
 			<function name="sumLong" value="org.fugerit.java.doc.freemarker.fun.SimpleSumLongFun"/>
+			<function name="textWrap" value="org.fugerit.java.doc.freemarker.fun.TextWrapFun"/>
 		</chainStep>
 	</docChain>
 
diff --git a/fj-doc-freemarker/src/test/resources/fj_doc_test/template/test_01.ftl b/fj-doc-freemarker/src/test/resources/fj_doc_test/template/test_01.ftl
index 4e041cdee..bfa016e5d 100644
--- a/fj-doc-freemarker/src/test/resources/fj_doc_test/template/test_01.ftl
+++ b/fj-doc-freemarker/src/test/resources/fj_doc_test/template/test_01.ftl
@@ -41,6 +41,9 @@
   		<para align="right">Test right</para>
   		
   		<para align="right">${messageFormat('test format -> {0} {1}', 'param1', 'param2')}</para>
+
+		<para align="right">${textWrap('test text wrap')}</para>
+
   
   		<br/>
   		<br/>