v1.3.2, add some new API points using more modern types and deprecate

the old ones

Author: uhoefel

README.md

@@ -59,7 +59,7 @@ The artifact can be found at maven central:
 <dependency>
     <groupId>eu.hoefel</groupId>
     <artifactId>jatex</artifactId>
-    <version>1.3.0</version>
+    <version>1.3.2</version>
 </dependency>
 ```
 

pom.xml

@@ -5,7 +5,7 @@
 
     <groupId>eu.hoefel</groupId>
     <artifactId>jatex</artifactId>
-    <version>1.3.1</version>
+    <version>1.3.2</version>
     <packaging>jar</packaging>
 
     <name>jatex</name>
@@ -15,8 +15,8 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <uhoefel.git.url>https://github.com/uhoefel/</uhoefel.git.url>
         <uhoefel.git.root>scm:git:ssh://git@github.com/uhoefel/</uhoefel.git.root>
-        <junit.jupiter.version>5.9.3</junit.jupiter.version>
-        <junit.platform.version>1.9.3</junit.platform.version>
+        <junit.jupiter.version>5.10.0</junit.jupiter.version>
+        <junit.platform.version>1.10.0</junit.platform.version>
         <jdk.version>17</jdk.version>
         <jvm.extraArgs></jvm.extraArgs>
     </properties>
@@ -78,6 +78,26 @@
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-enforcer-plugin</artifactId>
+                <version>3.4.0</version>
+                <executions>
+                    <execution>
+                        <id>enforce-maven-version</id>
+                        <goals>
+                            <goal>enforce</goal>
+                        </goals>
+                        <configuration>
+                            <rules>
+                                <requireMavenVersion>
+                                    <version>[3.5.4,)</version> <!-- This requires Maven 3.5.4 or above -->
+                                </requireMavenVersion>
+                            </rules>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
@@ -144,7 +164,7 @@
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>buildnumber-maven-plugin</artifactId>
-                <version>3.1.0</version>
+                <version>3.2.0</version>
                 <executions>
                     <execution>
                         <phase>validate</phase>
@@ -180,7 +200,7 @@
 
             <plugin>
                 <artifactId>maven-surefire-plugin</artifactId>
-                <version>3.1.0</version>
+                <version>3.1.2</version>
             </plugin>
 
             <plugin>

src/main/java/eu/hoefel/jatex/Latex.java

@@ -621,7 +621,12 @@ public int exec() {
      * @return the LaTeX object
      */
     public Latex filename(String name) {
-        this.name = name;
+        var path = Paths.get(name);
+        var folder = path.getParent();
+        if (folder != null) {
+            folder(Paths.get(this.folder).resolve(folder).toString());
+        }
+        this.name = path.getFileName().toString();
         nameSet = true;
         return this;
     }

src/main/java/eu/hoefel/jatex/letter/KomaLetter.java

@@ -1,6 +1,9 @@
 package eu.hoefel.jatex.letter;
 
 import java.io.File;
+import java.nio.file.Path;
+import java.time.LocalDate;
+import java.time.ZoneId;
 import java.util.Calendar;
 import java.util.Map;
 
@@ -31,7 +34,7 @@ public final class KomaLetter {
     private String yourMail;
     private String customer;
     private String invoice;
-    private Calendar date;
+    private LocalDate date;
     private String opening;
     private String closing;
     private String ps;
@@ -40,7 +43,7 @@ public final class KomaLetter {
 
     private String[] body;
 
-    private File file;
+    private Path file;
 
     /** Hiding any public constructor. */
     private KomaLetter() {
@@ -133,11 +136,23 @@ private static Latex setup() {
      * 
      * @param file the file to save to
      * @return the new KomaLetter
+     * @deprecated Use {@link #as(Path)}
      */
+    @Deprecated(forRemoval = true, since = "1.3.2")
     public static KomaLetter as(File file) {
         return new KomaLetter().file(file);
     }
 
+    /**
+     * Creates a new KomaLetter bound to file.
+     * 
+     * @param file the file to save to
+     * @return the new KomaLetter
+     */
+    public static KomaLetter as(Path file) {
+        return new KomaLetter().file(file);
+    }
+
     /**
      * Creates a new KomaLetter bound to file.
      * 
@@ -153,8 +168,21 @@ public static KomaLetter as(String file) {
      * 
      * @param file the file to save to
      * @return the new KomaLetter
+     * @deprecated Use {@link #file(Path)}
      */
+    @Deprecated(forRemoval = true, since = "1.3.2")
     public KomaLetter file(File file) {
+        this.file = file == null ? null : file.toPath();
+        return this;
+    }
+
+    /**
+     * Creates a new KomaLetter bound to file.
+     * 
+     * @param file the file to save to
+     * @return the new KomaLetter
+     */
+    public KomaLetter file(Path file) {
         this.file = file;
         return this;
     }
@@ -330,8 +358,21 @@ public KomaLetter invoice(String invoice) {
      * 
      * @param date the letter date
      * @return the current KOMA letter instance
+     * @deprecated Use {@link #date(LocalDate)}
      */
+    @Deprecated(forRemoval = true, since = "1.3.2")
     public KomaLetter date(Calendar date) {
+        this.date = date == null ? null : LocalDate.ofInstant(date.toInstant(), ZoneId.systemDefault());
+        return this;
+    }
+
+    /**
+     * Sets the date of the letter. Not necessary if the date of today should be used.
+     * 
+     * @param date the letter date
+     * @return the current KOMA letter instance
+     */
+    public KomaLetter date(LocalDate date) {
         this.date = date;
         return this;
     }
@@ -399,7 +440,7 @@ public KomaLetter cc(String... cc) {
      *         if an error occurred
      */
     public int exec() {
-        if (date == null) date = Calendar.getInstance();
+        if (date == null) date = LocalDate.now();
 
         String address = (toStreet == null ? "" : toStreet + "\\\\")
                 + (toCity == null ? "" : toCity + "\\\\")
@@ -415,8 +456,8 @@ public int exec() {
             locale = language;
         }
 
-        Latex tex = setup().folder(file.getParent())
-                            .filename(file.getName());
+        Latex tex = setup().folder(file.getParent().toString())
+                           .filename(file.getFileName().toString());
 
         if (user != null) tex.add(user);
 
@@ -437,8 +478,7 @@ public int exec() {
            .addToPreamble("\\setkomavar{myref}{" + (myRef == null ? "" : myRef) + "}")
            .addToPreamble("\\setkomavar{customer}{" + (customer == null ? "" : customer) + "}")
            .addToPreamble("\\setkomavar{invoice}{" + (invoice == null ? "" : invoice) + "}")
-           .addToPreamble("\\setkomavar{date}{\\DTMdisplaydate{" + date.get(Calendar.YEAR) + "}{"
-                   + (date.get(Calendar.MONTH) + 1) + "}{" + date.get(Calendar.DAY_OF_MONTH) + "}{-1}}")
+           .addToPreamble("\\setkomavar{date}{\\DTMdisplaydate{"+date.getYear()+"}{"+(date.getMonthValue())+"}{"+date.getDayOfMonth()+"}{-1}}")
            .addToPreamble(Latex.MINOR_SEPARATOR)
            .addToPreamble(Latex.EMPTY_LINE)
            .addToPreamble("\\layout")

src/test/java/eu/hoefel/jatex/LatexExecutableCondition.java

@@ -20,7 +20,7 @@ public ConditionEvaluationResult evaluateExecutionCondition(ExtensionContext con
         AnnotatedElement element = context.getElement().orElseThrow(IllegalStateException::new);
         return findAnnotation(element, EnabledIfLatexExecutable.class)
                 .map(annotation -> disableIfUnreachable(annotation, element))
-                .orElse(ConditionEvaluationResult.disabled("@EnabledIfReachable not used"));
+                .orElse(ConditionEvaluationResult.disabled("@EnabledIfLatexExecutable not used"));
     }
 
     /**

src/test/java/eu/hoefel/jatex/LatexTests.java

@@ -10,6 +10,7 @@
 
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.CleanupMode;
 import org.junit.jupiter.api.io.TempDir;
 
 
@@ -43,7 +44,7 @@ void executable() {
      * @param n  the number of steps
      * @return n steps from x0 to x1
      */
-    private static final double[] linSpace(double x0, double x1, int n) {
+    private static final double[] linspace(double x0, double x1, int n) {
         if (n == 1) return new double[] { (x0 + x1) / 2 };
 
         double[] f = new double[n];
@@ -61,9 +62,9 @@ private static final double[] linSpace(double x0, double x1, int n) {
      */
     @Test
     @EnabledIfLatexExecutable(compiler = TexCompiler.LUALATEX)
-    void plotExample1(@TempDir Path folder) {
-        double[][] data1 = { linSpace(0, 1, 10), linSpace(-5,  5, 10) };
-        double[][] data2 = { linSpace(0, 1, 10), linSpace( 5, -5, 10) };
+    void plotExample1(@TempDir(cleanup = CleanupMode.ON_SUCCESS) Path folder) {
+        double[][] data1 = { linspace(0, 1, 10), linspace(-5,  5, 10) };
+        double[][] data2 = { linspace(0, 1, 10), linspace( 5, -5, 10) };
 
         Latex tex = Latex.standard();
         tex.folder(folder.toString());
@@ -77,7 +78,12 @@ void plotExample1(@TempDir Path folder) {
 
     @Test
     @EnabledIfLatexExecutable(compiler = TexCompiler.PDFLATEX)
-    void testMinimal() {
-        Latex.minimal().add("$a=\\alpha_2\\times\\beta$").run("abc.tex");
+    void testMinimal(@TempDir(cleanup = CleanupMode.ON_SUCCESS) Path folder) {
+        var file = folder.resolve("abc.tex");
+        assertDoesNotThrow(() -> {
+            Latex.minimal()
+                 .add("$a=\\alpha_2\\times\\beta$")
+                 .run(file.toString());
+        });
     }
 }

src/test/java/eu/hoefel/jatex/letter/KomaLetterTests.java

@@ -31,7 +31,7 @@ class KomaLetterTests {
     @EnabledIfLatexExecutable(compiler = TexCompiler.LUALATEX)
     void testLetter(@TempDir Path folder) {
         Path file = Paths.get(folder.toString(), "letter.tex");
-        KomaLetter letter = KomaLetter.as(file.toString())
+        KomaLetter letter = KomaLetter.as(file)
                                 .language("ngerman")
                                 .user(JohnDoe.defaults()) // fill in specifics for yourself
                                 .toName("Mr. Bob Doe")
@@ -48,7 +48,7 @@ void testLetter(@TempDir Path folder) {
                                 .subject("subject")
                                 .opening("Dear Testreader,")
                                 .write("This letter is not really a letter. I just test for example if the paragraph building works.",
-                                        "Let's see\\ldots")
+                                       "Let's see\\ldots")
                                 .closing("Mit freundlichen Grüßen,")
                                 .ps("Here some postscriptum text")
                                 .encl("Document1.pdf", "Document2.pdf");