java modules: modularize handlebars modules

edgar-espina-wpp · edgar-espina-wpp · commit d09b3c873850 · 2024-03-04T07:26:28.000-03:00
- fix #1018
diff --git a/handlebars-caffeine/src/main/java/com/github/jknack/handlebars/caffeine/CaffeineTemplateCache.java b/handlebars-caffeine/src/main/java/com/github/jknack/handlebars/caffeine/CaffeineTemplateCache.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.cache;
+package com.github.jknack.handlebars.caffeine;
 
 import static java.util.Objects.requireNonNull;
 
@@ -14,6 +14,7 @@
 import com.github.jknack.handlebars.Handlebars;
 import com.github.jknack.handlebars.Parser;
 import com.github.jknack.handlebars.Template;
+import com.github.jknack.handlebars.cache.TemplateCache;
 import com.github.jknack.handlebars.io.TemplateSource;
 
 /**
diff --git a/handlebars-caffeine/src/main/java/com/github/jknack/handlebars/caffeine/CaffeineTemplateLoader.java b/handlebars-caffeine/src/main/java/com/github/jknack/handlebars/caffeine/CaffeineTemplateLoader.java
@@ -3,14 +3,16 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.io;
+package com.github.jknack.handlebars.caffeine;
 
 import java.io.IOException;
 import java.nio.charset.Charset;
 import java.util.function.Function;
 
 import com.github.benmanes.caffeine.cache.Cache;
 import com.github.jknack.handlebars.Handlebars;
+import com.github.jknack.handlebars.io.TemplateLoader;
+import com.github.jknack.handlebars.io.TemplateSource;
 
 /**
  * Decorates an existing TemplateLoader with a GuavaCache. This is useful to avoid constantly
diff --git a/handlebars-caffeine/src/main/java/module-info.java b/handlebars-caffeine/src/main/java/module-info.java
@@ -0,0 +1,7 @@
+module com.github.jknack.handlebars.caffeine {
+  exports com.github.jknack.handlebars.caffeine;
+
+  requires org.slf4j;
+  requires com.github.jknack.handlebars;
+  requires com.github.benmanes.caffeine;
+}
diff --git a/handlebars-caffeine/src/test/java/com/github/jknack/handlebars/caffeine/cache/CaffeineTemplateCacheTest.java b/handlebars-caffeine/src/test/java/com/github/jknack/handlebars/caffeine/cache/CaffeineTemplateCacheTest.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.cache;
+package com.github.jknack.handlebars.caffeine.cache;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.fail;
@@ -23,6 +23,7 @@
 import com.github.jknack.handlebars.HandlebarsException;
 import com.github.jknack.handlebars.Parser;
 import com.github.jknack.handlebars.Template;
+import com.github.jknack.handlebars.caffeine.CaffeineTemplateCache;
 import com.github.jknack.handlebars.io.TemplateSource;
 
 public class CaffeineTemplateCacheTest {
diff --git a/handlebars-guava-cache/pom.xml b/handlebars-guava-cache/pom.xml
@@ -55,4 +55,26 @@
     </dependency>
   </dependencies>
 
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>3.2.5</version>
+        <configuration>
+          <!-- set default locale of the test JVM to en_US because some tests expect e.g. the dollar sign as currency symbol -->
+          <argLine>-Duser.language=en -Duser.country=US</argLine>
+          <useModulePath>false</useModulePath>
+          <includes>
+            <include>**/*Test.java</include>
+            <include>**/Issue*.java</include>
+            <include>**/Hbs*.java</include>
+          </includes>
+          <excludes>
+            <exclude>**/*BenchTest.java</exclude>
+          </excludes>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
 </project>
diff --git a/handlebars-guava-cache/src/main/java/com/github/jknack/handlebars/guava/GuavaCachedTemplateLoader.java b/handlebars-guava-cache/src/main/java/com/github/jknack/handlebars/guava/GuavaCachedTemplateLoader.java
@@ -3,14 +3,16 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.io;
+package com.github.jknack.handlebars.guava;
 
 import java.io.IOException;
 import java.nio.charset.Charset;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
 
 import com.github.jknack.handlebars.Handlebars;
+import com.github.jknack.handlebars.io.TemplateLoader;
+import com.github.jknack.handlebars.io.TemplateSource;
 import com.google.common.cache.Cache;
 import com.google.common.cache.CacheBuilder;
 
diff --git a/handlebars-guava-cache/src/main/java/com/github/jknack/handlebars/guava/GuavaTemplateCache.java b/handlebars-guava-cache/src/main/java/com/github/jknack/handlebars/guava/GuavaTemplateCache.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.cache;
+package com.github.jknack.handlebars.guava;
 
 import static java.util.Objects.requireNonNull;
 
@@ -13,6 +13,7 @@
 import com.github.jknack.handlebars.HandlebarsException;
 import com.github.jknack.handlebars.Parser;
 import com.github.jknack.handlebars.Template;
+import com.github.jknack.handlebars.cache.TemplateCache;
 import com.github.jknack.handlebars.io.ReloadableTemplateSource;
 import com.github.jknack.handlebars.io.TemplateSource;
 import com.google.common.cache.Cache;
diff --git a/handlebars-guava-cache/src/main/java/module-info.java b/handlebars-guava-cache/src/main/java/module-info.java
@@ -0,0 +1,7 @@
+module com.github.jknack.handlebars.guava {
+  exports com.github.jknack.handlebars.guava;
+
+  requires org.slf4j;
+  requires com.github.jknack.handlebars;
+  requires com.google.common;
+}
diff --git a/handlebars-guava-cache/src/test/java/com/github/jknack/handlebars/guava/GuavaCachedTemplateLoaderTest.java b/handlebars-guava-cache/src/test/java/com/github/jknack/handlebars/guava/GuavaCachedTemplateLoaderTest.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.io;
+package com.github.jknack.handlebars.guava;
 
 import static java.lang.System.out;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
@@ -13,6 +13,8 @@
 
 import org.junit.jupiter.api.Test;
 
+import com.github.jknack.handlebars.io.FileTemplateLoader;
+import com.github.jknack.handlebars.io.TemplateLoader;
 import com.google.common.base.Stopwatch;
 
 public class GuavaCachedTemplateLoaderTest {
diff --git a/handlebars-guava-cache/src/test/java/com/github/jknack/handlebars/guava/GuavaTemplateCacheTest.java b/handlebars-guava-cache/src/test/java/com/github/jknack/handlebars/guava/GuavaTemplateCacheTest.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.cache;
+package com.github.jknack.handlebars.guava;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.mockito.ArgumentMatchers.any;
diff --git a/handlebars-helpers/src/main/java/com/github/jknack/handlebars/helper/ext/AssignHelper.java b/handlebars-helpers/src/main/java/com/github/jknack/handlebars/helper/ext/AssignHelper.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.helper;
+package com.github.jknack.handlebars.helper.ext;
 
 import java.io.IOException;
 
diff --git a/handlebars-helpers/src/main/java/com/github/jknack/handlebars/helper/ext/IncludeHelper.java b/handlebars-helpers/src/main/java/com/github/jknack/handlebars/helper/ext/IncludeHelper.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.helper;
+package com.github.jknack.handlebars.helper.ext;
 
 import java.io.IOException;
 
diff --git a/handlebars-helpers/src/main/java/com/github/jknack/handlebars/helper/ext/JodaHelper.java b/handlebars-helpers/src/main/java/com/github/jknack/handlebars/helper/ext/JodaHelper.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.helper;
+package com.github.jknack.handlebars.helper.ext;
 
 import java.io.IOException;
 
diff --git a/handlebars-helpers/src/main/java/com/github/jknack/handlebars/helper/ext/NumberHelper.java b/handlebars-helpers/src/main/java/com/github/jknack/handlebars/helper/ext/NumberHelper.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.helper;
+package com.github.jknack.handlebars.helper.ext;
 
 import static org.apache.commons.lang3.Validate.notNull;
 
diff --git a/handlebars-helpers/src/main/java/module-info.java b/handlebars-helpers/src/main/java/module-info.java
@@ -0,0 +1,8 @@
+module com.github.jknack.handlebars.helper.ext {
+  exports com.github.jknack.handlebars.helper.ext;
+
+  requires org.slf4j;
+  requires com.github.jknack.handlebars;
+  requires org.apache.commons.lang3;
+  requires static org.joda.time;
+}
diff --git a/handlebars-springmvc/src/main/java/module-info.java b/handlebars-springmvc/src/main/java/module-info.java
@@ -0,0 +1,11 @@
+module com.github.jknack.handlebars.springmvc {
+  exports com.github.jknack.handlebars.springmvc;
+
+  requires com.github.jknack.handlebars;
+  requires jakarta.servlet;
+  requires spring.core;
+  requires spring.beans;
+  requires spring.context;
+  requires spring.jcl;
+  requires spring.webmvc;
+}
diff --git a/handlebars-tests/pom.xml b/handlebars-tests/pom.xml
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+
+  <parent>
+    <groupId>com.github.jknack</groupId>
+    <artifactId>handlebars.java</artifactId>
+    <version>5.0.0-SNAPSHOT</version>
+  </parent>
+
+  <modelVersion>4.0.0</modelVersion>
+  <artifactId>handlebars-tests</artifactId>
+
+  <dependencies>
+    <dependency>
+      <groupId>com.github.jknack</groupId>
+      <artifactId>handlebars-guava-cache</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>com.github.jknack</groupId>
+      <artifactId>handlebars-helpers</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>joda-time</groupId>
+      <artifactId>joda-time</artifactId>
+      <version>2.12.7</version>
+    </dependency>
+
+    <!-- Test dependencies -->
+    <dependency>
+      <groupId>com.github.jknack</groupId>
+      <artifactId>handlebars</artifactId>
+      <version>${project.version}</version>
+      <scope>test</scope>
+      <classifier>tests</classifier>
+    </dependency>
+
+    <dependency>
+      <groupId>ch.qos.logback</groupId>
+      <artifactId>logback-classic</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-engine</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-core</artifactId>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>3.2.5</version>
+        <configuration>
+          <!-- set default locale of the test JVM to en_US because some tests expect e.g. the dollar sign as currency symbol -->
+          <argLine>-Duser.language=en -Duser.country=US</argLine>
+          <useModulePath>false</useModulePath>
+          <includes>
+            <include>**/*Test.java</include>
+            <include>**/Issue*.java</include>
+            <include>**/Hbs*.java</include>
+          </includes>
+          <excludes>
+            <exclude>**/*BenchTest.java</exclude>
+          </excludes>
+        </configuration>
+      </plugin>
+
+      <!-- Deploy plugin -->
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-deploy-plugin</artifactId>
+        <version>3.1.1</version>
+        <configuration>
+          <skip>true</skip>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>
diff --git a/handlebars-tests/src/main/java/Dummy.java b/handlebars-tests/src/main/java/Dummy.java
@@ -0,0 +1,6 @@
+/*
+ * Handlebars.java: https://github.com/jknack/handlebars.java
+ * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
+ * Copyright (c) 2012 Edgar Espina
+ */
+public class Dummy {}
diff --git a/handlebars-tests/src/test/java/com/github/jknack/handlebars/helper/ext/AssignHelperTest.java b/handlebars-tests/src/test/java/com/github/jknack/handlebars/helper/ext/AssignHelperTest.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.helper;
+package com.github.jknack.handlebars.helper.ext;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
diff --git a/handlebars-tests/src/test/java/com/github/jknack/handlebars/helper/ext/IncludeTest.java b/handlebars-tests/src/test/java/com/github/jknack/handlebars/helper/ext/IncludeTest.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.helper;
+package com.github.jknack.handlebars.helper.ext;
 
 import java.io.IOException;
 
diff --git a/handlebars-tests/src/test/java/com/github/jknack/handlebars/helper/ext/JodaHelperTest.java b/handlebars-tests/src/test/java/com/github/jknack/handlebars/helper/ext/JodaHelperTest.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.helper;
+package com.github.jknack.handlebars.helper.ext;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.fail;
diff --git a/handlebars-tests/src/test/java/com/github/jknack/handlebars/helper/ext/NumberHelperTest.java b/handlebars-tests/src/test/java/com/github/jknack/handlebars/helper/ext/NumberHelperTest.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.helper;
+package com.github.jknack.handlebars.helper.ext;
 
 import java.io.IOException;
 
diff --git a/handlebars-tests/src/test/java/i371/Issue371.java b/handlebars-tests/src/test/java/i371/Issue371.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
  * Copyright (c) 2012 Edgar Espina
  */
-package com.github.jknack.handlebars.i371;
+package i371;
 
 import java.io.IOException;
 
diff --git a/handlebars/src/etc/module-info.activator b/handlebars/src/etc/module-info.activator
@@ -0,0 +1 @@
+Remove from module-info all content after: // SHADED:
diff --git a/handlebars/src/main/java/module-info.java b/handlebars/src/main/java/module-info.java
@@ -0,0 +1,17 @@
+module com.github.jknack.handlebars {
+  exports com.github.jknack.handlebars;
+  exports com.github.jknack.handlebars.io;
+  exports com.github.jknack.handlebars.cache;
+  exports com.github.jknack.handlebars.context;
+  exports com.github.jknack.handlebars.helper;
+
+  requires java.scripting;
+  requires org.slf4j;
+  requires org.apache.commons.lang3;
+  requires org.apache.commons.text;
+  requires static jakarta.servlet;
+  requires static java.compiler;
+
+  // SHADED: All content after this line will be removed at build time
+  requires org.antlr.antlr4.runtime;
+}
diff --git a/pom.xml b/pom.xml
