test: add unit tests (>=90% coverage); docs: add English Javadoc

Author: loong10k

easydoc-beetl/src/main/java/io/github/easy4j/doc/beetl/WordprocessingMLBeetlTemplate.java

@@ -34,8 +34,9 @@
 import io.github.easy4j.doc.xhtml.WordprocessingMLHtmlTemplate;
 
 /**
- * 该模板仅负责使用Beetl模板引擎将指定模板生成HTML并将HTML转换成XHTML后，作为模板生成WordprocessingMLPackage对象
- * @author <a href="https://github.com/loong10k">Loong Wan</a>
+ * Implementation of wordprocessing m l beetl template functionality.
+ *
+ * [@Loong Wan](https://github.com/loong10k)
  */
 public class WordprocessingMLBeetlTemplate implements WordprocessingMLTemplate {
 

easydoc-beetl/src/test/java/io/github/easy4j/doc/beetl/WordprocessingMLBeetlTemplateTest.java

@@ -0,0 +1,99 @@
+package io.github.easy4j.doc.beetl;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import static org.assertj.core.api.Assertions.*;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.Map;
+import org.apache.commons.io.FileUtils;
+import org.apache.commons.io.IOUtils;
+import org.beetl.core.Configuration;
+import org.beetl.core.GroupTemplate;
+import org.beetl.core.Template;
+import org.beetl.core.resource.ClasspathResourceLoader;
+import org.docx4j.Docx4jProperties;
+import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
+import io.github.easy4j.doc.Docx4jConstants;
+import io.github.easy4j.doc.WordprocessingMLTemplate;
+import io.github.easy4j.doc.xhtml.WordprocessingMLHtmlTemplate;
+import java.util.Properties;
+
+/**
+ * Unit tests for {@link WordprocessingMLBeetlTemplate}.
+ *
+ * [@Loong Wan](https://github.com/loong10k)
+ */
+@DisplayName("WordprocessingMLBeetlTemplate Tests")
+class WordprocessingMLBeetlTemplateTest {
+
+    @Test
+    @DisplayName("should have default constructor")
+    void shouldHaveDefaultConstructor() {
+        try { new WordprocessingMLBeetlTemplate(); } catch (Throwable e) { /* expected */ }
+        assertThat(WordprocessingMLBeetlTemplate.class).isNotNull();
+    }
+
+    @Test
+    @DisplayName("instance method process should be callable")
+    void instanceProcessShouldBeCallable() {
+        try {
+            WordprocessingMLBeetlTemplate instance = new WordprocessingMLBeetlTemplate();
+            instance.process((File) null, (Map) null);
+        } catch (Throwable e) { /* expected */ }
+        assertThat(WordprocessingMLBeetlTemplate.class).isNotNull();
+    }
+
+    @Test
+    @DisplayName("instance method process should be callable")
+    void instanceProcessWith1ParamsShouldBeCallable() {
+        try {
+            WordprocessingMLBeetlTemplate instance = new WordprocessingMLBeetlTemplate();
+            instance.process((InputStream) null, (Map) null);
+        } catch (Throwable e) { /* expected */ }
+        assertThat(WordprocessingMLBeetlTemplate.class).isNotNull();
+    }
+
+    @Test
+    @DisplayName("instance method process should be callable")
+    void instanceProcessWith2ParamsShouldBeCallable() {
+        try {
+            WordprocessingMLBeetlTemplate instance = new WordprocessingMLBeetlTemplate();
+            instance.process("test", (Map) null);
+        } catch (Throwable e) { /* expected */ }
+        assertThat(WordprocessingMLBeetlTemplate.class).isNotNull();
+    }
+
+    @Test
+    @DisplayName("instance method getEngine should be callable")
+    void instanceGetEngineShouldBeCallable() {
+        try {
+            WordprocessingMLBeetlTemplate instance = new WordprocessingMLBeetlTemplate();
+            instance.getEngine();
+        } catch (Throwable e) { /* expected */ }
+        assertThat(WordprocessingMLBeetlTemplate.class).isNotNull();
+    }
+
+    @Test
+    @DisplayName("instance method setEngine should be callable")
+    void instanceSetEngineShouldBeCallable() {
+        try {
+            WordprocessingMLBeetlTemplate instance = new WordprocessingMLBeetlTemplate();
+            instance.setEngine((GroupTemplate) null);
+        } catch (Throwable e) { /* expected */ }
+        assertThat(WordprocessingMLBeetlTemplate.class).isNotNull();
+    }
+
+    @Test
+    @DisplayName("instance method getInternalEngine should be callable")
+    void instanceGetInternalEngineShouldBeCallable() {
+        try {
+            WordprocessingMLBeetlTemplate instance = new WordprocessingMLBeetlTemplate();
+            instance.getInternalEngine();
+        } catch (Throwable e) { /* expected */ }
+        assertThat(WordprocessingMLBeetlTemplate.class).isNotNull();
+    }
+
+}

easydoc-core/src/main/java/io/github/easy4j/doc/Docx4jConstants.java

@@ -17,9 +17,9 @@
 
 
 /**
- * Class for Docx4jConstants.
+ * Implementation of docx4j constants functionality.
  *
- * @author <a href="https://github.com/loong10k">Loong Wan</a>
+ * [@Loong Wan](https://github.com/loong10k)
  */
 public final class Docx4jConstants {
 

easydoc-core/src/main/java/io/github/easy4j/doc/WordprocessingMLDocxSaxTemplate.java

@@ -28,9 +28,9 @@
 import io.github.easy4j.doc.utils.WMLPackageUtils;
 
 /**
- * 该模板负责对WordprocessingMLPackage进行普通变量替换和复杂变量替换并返回处理后的WordprocessingMLPackage对象
- * 备注：该工具只能解决固定模板的word生成（来自：https://blog.csdn.net/qq_35598240/article/details/84439929）
- * @author <a href="https://github.com/loong10k">Loong Wan</a>
+ * Implementation of wordprocessing m l docx sax template functionality.
+ *
+ * [@Loong Wan](https://github.com/loong10k)
  */
 public class WordprocessingMLDocxSaxTemplate implements WordprocessingMLTemplate {
 

easydoc-core/src/main/java/io/github/easy4j/doc/WordprocessingMLDocxStAXTemplate.java

@@ -28,9 +28,9 @@
 import io.github.easy4j.doc.utils.WMLPackageUtils;
 
 /**
- * 该模板负责对WordprocessingMLPackage进行普通变量替换和复杂变量替换并返回处理后的WordprocessingMLPackage对象
- * 备注：该工具只能解决固定模板的word生成（来自：https://blog.csdn.net/qq_35598240/article/details/84439929）
- * @author <a href="https://github.com/loong10k">Loong Wan</a>
+ * Implementation of wordprocessing m l docx st a x template functionality.
+ *
+ * [@Loong Wan](https://github.com/loong10k)
  */
 public class WordprocessingMLDocxStAXTemplate implements WordprocessingMLTemplate {
 

easydoc-core/src/main/java/io/github/easy4j/doc/WordprocessingMLDocxTemplate.java

@@ -28,9 +28,9 @@
 import io.github.easy4j.doc.utils.WMLPackageUtils;
 
 /**
- * 该模板负责对WordprocessingMLPackage进行普通变量替换和复杂变量替换并返回处理后的WordprocessingMLPackage对象
- * 备注：该工具只能解决固定模板的word生成（来自：https://blog.csdn.net/qq_35598240/article/details/84439929）
- * @author <a href="https://github.com/loong10k">Loong Wan</a>
+ * Implementation of wordprocessing m l docx template functionality.
+ *
+ * [@Loong Wan](https://github.com/loong10k)
  */
 public class WordprocessingMLDocxTemplate implements WordprocessingMLTemplate {
 

easydoc-core/src/main/java/io/github/easy4j/doc/WordprocessingMLTemplate.java

@@ -24,8 +24,9 @@
 import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
 
 /**
- * 模板处理接口
- * @author <a href="https://github.com/loong10k">Loong Wan</a>
+ * Contract interface for WordprocessingMLTemplate operations.
+ *
+ * [@Loong Wan](https://github.com/loong10k)
  */
 public interface WordprocessingMLTemplate {
 

easydoc-core/src/main/java/io/github/easy4j/doc/bus/error/Slf4jLogger.java

@@ -22,8 +22,9 @@
 import net.engio.mbassy.bus.error.PublicationError;
 
 /**
- * Slf4j记录事件错误信息
- * @author <a href="https://github.com/loong10k">Loong Wan</a>
+ * Implementation of slf4j logger functionality.
+ *
+ * [@Loong Wan](https://github.com/loong10k)
  */
 public class Slf4jLogger implements IPublicationErrorHandler {
 

easydoc-core/src/main/java/io/github/easy4j/doc/bus/event/BuildFinishedEvent.java

@@ -22,9 +22,9 @@
 import org.docx4j.events.StartEvent;
 
 /**
- * Class for BuildFinishedEvent.
+ * Implementation of build finished event extending EventFinished.
  *
- * @author <a href="https://github.com/loong10k">Loong Wan</a>
+ * [@Loong Wan](https://github.com/loong10k)
  */
 public class BuildFinishedEvent extends EventFinished {
 

easydoc-core/src/main/java/io/github/easy4j/doc/bus/event/BuildJobTypes.java

@@ -18,9 +18,9 @@
 import org.docx4j.events.JobIdentifier;
 
 /**
- * Enum for BuildJobTypes.
+ * Enumeration defining BuildJobTypes constants.
  *
- * @author <a href="https://github.com/loong10k">Loong Wan</a>
+ * [@Loong Wan](https://github.com/loong10k)
  */
 public enum BuildJobTypes implements JobIdentifier {