build: thymeleaf unit tests

Author: jknack

modules/jooby-thymeleaf/pom.xml

@@ -43,5 +43,15 @@
       <artifactId>jooby-test</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-core</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-junit-jupiter</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 </project>

modules/jooby-thymeleaf/src/main/java/io/jooby/thymeleaf/package-info.java

@@ -1,2 +1,54 @@
+/**
+ * Thymeleaf module: https://jooby.io/modules/thymeleaf.
+ *
+ * <p>Usage:
+ *
+ * <pre>{@code
+ * {
+ *
+ *   install(new ThymeleafModule());
+ *
+ *   get("/", ctx -> {
+ *     User user = ...;
+ *     return new ModelAndView("index.html")
+ *         .put("user", user);
+ *   });
+ * }
+ * }</pre>
+ *
+ * The template engine looks for a file-system directory: <code>views</code> in the current user
+ * directory. If the directory doesn't exist, it looks for the same directory in the project
+ * classpath.
+ *
+ * <p>Template engine supports the following file extensions: <code>.thl</code>, <code>.thl.html
+ * </code> and <code>.html</code>.
+ *
+ * <p>You can specify a different template location:
+ *
+ * <pre>{@code
+ * {
+ *
+ *    install(new ThymeleafModule("mypath"));
+ *
+ * }
+ * }</pre>
+ *
+ * The <code>mypath</code> location works in the same way: file-system or fallback to classpath.
+ *
+ * <p>Direct access to {@link org.thymeleaf.TemplateEngine} is available via require call:
+ *
+ * <pre>{@code
+ * {
+ *
+ *   TemplateEngine engine = require(TemplateEngine.class);
+ *
+ * }
+ * }</pre>
+ *
+ * Complete documentation is available at: https://jooby.io/modules/thymeleaf.
+ *
+ * @author edgar
+ * @since 2.0.0
+ */
 @org.jspecify.annotations.NullMarked
 package io.jooby.thymeleaf;

modules/jooby-thymeleaf/src/main/java/module-info.java

@@ -4,7 +4,60 @@
  * Copyright 2014 Edgar Espina
  */
 
-/** Thymeleaf module. */
+import org.thymeleaf.TemplateEngine;
+
+/**
+ * Thymeleaf module: https://jooby.io/modules/thymeleaf.
+ *
+ * <p>Usage:
+ *
+ * <pre>{@code
+ * {
+ *
+ *   install(new ThymeleafModule());
+ *
+ *   get("/", ctx -> {
+ *     User user = ...;
+ *     return new ModelAndView("index.html")
+ *         .put("user", user);
+ *   });
+ * }
+ * }</pre>
+ *
+ * The template engine looks for a file-system directory: <code>views</code> in the current user
+ * directory. If the directory doesn't exist, it looks for the same directory in the project
+ * classpath.
+ *
+ * <p>Template engine supports the following file extensions: <code>.thl</code>, <code>.thl.html
+ * </code> and <code>.html</code>.
+ *
+ * <p>You can specify a different template location:
+ *
+ * <pre>{@code
+ * {
+ *
+ *    install(new ThymeleafModule("mypath"));
+ *
+ * }
+ * }</pre>
+ *
+ * The <code>mypath</code> location works in the same way: file-system or fallback to classpath.
+ *
+ * <p>Direct access to {@link TemplateEngine} is available via require call:
+ *
+ * <pre>{@code
+ * {
+ *
+ *   TemplateEngine engine = require(TemplateEngine.class);
+ *
+ * }
+ * }</pre>
+ *
+ * Complete documentation is available at: https://jooby.io/modules/thymeleaf.
+ *
+ * @author edgar
+ * @since 2.0.0
+ */
 module io.jooby.thymeleaf {
   exports io.jooby.thymeleaf;
 

modules/jooby-thymeleaf/src/test/java/io/jooby/internal/thymeleaf/ThymeleafTemplateEngineTest.java

@@ -0,0 +1,125 @@
+/*
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
+package io.jooby.internal.thymeleaf;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import java.io.Writer;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.thymeleaf.TemplateEngine;
+import org.thymeleaf.context.IContext;
+
+import io.jooby.Context;
+import io.jooby.MapModelAndView;
+import io.jooby.ModelAndView;
+import io.jooby.output.BufferedOutput;
+import io.jooby.output.Output;
+import io.jooby.output.OutputFactory;
+
+@ExtendWith(MockitoExtension.class)
+class ThymeleafTemplateEngineTest {
+
+  @Mock TemplateEngine templateEngine;
+  @Mock Context ctx;
+  @Mock OutputFactory outputFactory;
+  @Mock BufferedOutput outputBuffer;
+  @Mock Writer writer;
+
+  private ThymeleafTemplateEngine engine;
+
+  @BeforeEach
+  void setup() {
+    engine = new ThymeleafTemplateEngine(templateEngine, List.of(".thl", ".html"));
+  }
+
+  @Test
+  void testExtensions_AreAssignedAndUnmodifiable() {
+    assertEquals(List.of(".thl", ".html"), engine.extensions());
+    assertThrows(UnsupportedOperationException.class, () -> engine.extensions().add(".bad"));
+  }
+
+  @Test
+  void testRender_UnsupportedModelAndView() {
+    ModelAndView<?> badModel = mock(ModelAndView.class);
+
+    assertThrows(ModelAndView.UnsupportedModelAndView.class, () -> engine.render(ctx, badModel));
+  }
+
+  @Test
+  void testRender_MapModelAndView_ViewWithoutSlash_LocaleFromContext() {
+    MapModelAndView modelAndView = new MapModelAndView("index.html");
+    modelAndView.put("user", "edgar");
+
+    Map<String, Object> ctxAttributes = new HashMap<>();
+    ctxAttributes.put("flash", "success");
+
+    when(ctx.getAttributes()).thenReturn(ctxAttributes);
+    when(ctx.locale()).thenReturn(Locale.UK);
+    when(ctx.getOutputFactory()).thenReturn(outputFactory);
+    when(outputFactory.allocate()).thenReturn(outputBuffer);
+    when(outputBuffer.asWriter()).thenReturn(writer);
+
+    Output result = engine.render(ctx, modelAndView);
+
+    assertEquals(outputBuffer, result);
+
+    ArgumentCaptor<IContext> contextCaptor = ArgumentCaptor.forClass(IContext.class);
+
+    // Verifies the engine processed a sanitized path (prepended slash)
+    verify(templateEngine).process(eq("/index.html"), contextCaptor.capture(), eq(writer));
+
+    IContext thymeleafContext = contextCaptor.getValue();
+
+    // Verifies the locale fell back to the context locale
+    assertEquals(Locale.UK, thymeleafContext.getLocale());
+
+    // Verifies model attributes and context attributes were successfully merged
+    assertTrue(thymeleafContext.containsVariable("user"));
+    assertEquals("edgar", thymeleafContext.getVariable("user"));
+    assertTrue(thymeleafContext.containsVariable("flash"));
+    assertEquals("success", thymeleafContext.getVariable("flash"));
+  }
+
+  @Test
+  void testRender_MapModelAndView_ViewWithSlash_LocaleFromModel() {
+    MapModelAndView modelAndView = new MapModelAndView("/admin/dashboard.html");
+    modelAndView.setLocale(Locale.CANADA);
+
+    when(ctx.getAttributes()).thenReturn(new HashMap<>());
+    when(ctx.getOutputFactory()).thenReturn(outputFactory);
+    when(outputFactory.allocate()).thenReturn(outputBuffer);
+    when(outputBuffer.asWriter()).thenReturn(writer);
+
+    engine.render(ctx, modelAndView);
+
+    ArgumentCaptor<IContext> contextCaptor = ArgumentCaptor.forClass(IContext.class);
+
+    // Verifies the engine processed the path as-is (slash already present)
+    verify(templateEngine)
+        .process(eq("/admin/dashboard.html"), contextCaptor.capture(), eq(writer));
+
+    IContext thymeleafContext = contextCaptor.getValue();
+
+    // Verifies the explicit model locale takes precedence
+    assertEquals(Locale.CANADA, thymeleafContext.getLocale());
+  }
+}