Improving the behaviour (#16)

* Improving the behaviour
* Adding Dependabot

Author: jabrena

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: "maven"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "05:00"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "05:00"

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.0] 2025/06/05
+
+### Changed
+
+- Improved the behavior to update the png file if the app detect recent changes in the puml .file although exist a png file. This behaviour is perfect if the user are updating the .puml file in an interactive way.
+
 ## [0.3.0] 2025/06/03
 
 ### Changed

README.md

@@ -32,9 +32,9 @@ jwebserver -p 8001 -d "$(pwd)/target/site/jacoco"
 
 ```bash
 ./mvnw clean package
-java -jar target/puml-to-png-0.3.0.jar --help
-java -jar target/puml-to-png-0.3.0.jar --file ./docs/sample-diagram.puml
-java -jar target/puml-to-png-0.3.0.jar --watch docs
+java -jar target/puml-to-png-0.4.0.jar --help
+java -jar target/puml-to-png-0.4.0.jar --file ./docs/sample-diagram.puml
+java -jar target/puml-to-png-0.4.0.jar --watch docs
 
 jbang cache clear
 jbang catalog list

docs/sample-diagram.png

@@ -5,7 +5,7 @@
 
   <groupId>info.jab.cli</groupId>
   <artifactId>puml-to-png</artifactId>
-  <version>0.3.0</version>
+  <version>0.4.0</version>
 
   <properties>
     <java.version>24</java.version>
@@ -15,6 +15,8 @@
 
     <!-- Dependencies -->
     <jspecify.version>1.0.0</jspecify.version>
+    <slf4j.version>2.0.17</slf4j.version>
+    <logback.version>1.5.18</logback.version>
     <picocli.version>4.7.7</picocli.version>
     <jcolor.version>5.5.1</jcolor.version>
     <jfiglet.version>0.0.9</jfiglet.version>
@@ -73,6 +75,16 @@
         <artifactId>jspecify</artifactId>
         <version>${jspecify.version}</version>
     </dependency>
+    <dependency>
+        <groupId>org.slf4j</groupId>
+        <artifactId>slf4j-api</artifactId>
+        <version>${slf4j.version}</version>
+    </dependency>
+    <dependency>
+        <groupId>ch.qos.logback</groupId>
+        <artifactId>logback-classic</artifactId>
+        <version>${logback.version}</version>
+    </dependency>
     <dependency>
       <groupId>info.picocli</groupId>
       <artifactId>picocli</artifactId>
@@ -147,11 +159,6 @@
             <artifactId>maven-timeline</artifactId>
             <version>${maven-extensions-timeline.version}</version>
         </extension>
-        <extension>
-            <groupId>org.apache.maven.extensions</groupId>
-            <artifactId>maven-build-cache-extension</artifactId>
-            <version>${maven-extensions-build-cache.version}</version>
-        </extension>
     </extensions>
 
     <plugins>
@@ -354,7 +361,7 @@
               </filters>
               <transformers>
                 <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
-                  <mainClass>info.jab.core.PlantUMLToPng</mainClass>
+                  <mainClass>info.jab.core.MainApplication</mainClass>
                 </transformer>
                 <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
                 <transformer implementation="org.apache.maven.plugins.shade.resource.ApacheLicenseResourceTransformer"/>

pom.xml

@@ -9,6 +9,8 @@
 import java.util.concurrent.Callable;
 
 import org.jspecify.annotations.Nullable;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.util.Objects;
 import java.util.Optional;
@@ -31,7 +33,9 @@
     mixinStandardHelpOptions = true,
     usageHelpAutoWidth = true
 )
-public class PlantUMLToPng implements Callable<Integer> {
+public class MainApplication implements Callable<Integer> {
+
+    private static final Logger logger = LoggerFactory.getLogger(MainApplication.class);
 
     @Option(
         names = {"-f", "--file"},
@@ -54,7 +58,7 @@ public class PlantUMLToPng implements Callable<Integer> {
     /**
      * Default constructor for CLI usage.
      */
-    public PlantUMLToPng() {
+    public MainApplication() {
         this.fileValidator = new PlantUMLFileValidator();
         this.fileService = new PlantUMLFileService();
         this.watchService = new PlantUMLWatchService(fileService);
@@ -67,7 +71,7 @@ public PlantUMLToPng() {
      * @param fileService The PlantUML file service to use
      * @param watchService The watch service to use
      */
-    public PlantUMLToPng(PlantUMLFileValidator fileValidator, PlantUMLFileService fileService, PlantUMLWatchService watchService) {
+    public MainApplication(PlantUMLFileValidator fileValidator, PlantUMLFileService fileService, PlantUMLWatchService watchService) {
         this.fileValidator = fileValidator;
         this.fileService = fileService;
         this.watchService = watchService;
@@ -94,20 +98,20 @@ public CliResult execute() {
             return handleSingleFileConversion(inputFile);
         }
 
-        System.out.println("Use --help to see available options.");
+        logger.info("Use --help to see available options.");
         return CliResult.KO;
     }
 
     private CliResult handleSingleFileConversion(String inputFile) {
         if (Objects.isNull(inputFile)) {
-            System.err.println("Error: No input file specified. Use -f or --file option.");
+            logger.error("Error: No input file specified. Use -f or --file option.");
             return CliResult.KO;
         }
 
         // Validate input file using PlantUMLFileValidator
         Optional<Path> validatedPath = fileValidator.validatePlantUMLFile(inputFile);
         if (validatedPath.isEmpty()) {
-            System.err.println("Invalid PlantUML file: " + inputFile);
+            logger.error("Invalid PlantUML file: {}", inputFile);
             return CliResult.KO;
         }
 
@@ -125,19 +129,19 @@ private CliResult handleWatchMode(String parameter) {
         if (Objects.isNull(parameter) || parameter.trim().isEmpty()) {
             // Use current directory as default
             watchDirectory = Path.of(System.getProperty("user.dir"));
-            System.out.println("Using current directory for watching: " + parameter);
+            logger.info("Using current directory for watching: {}", parameter);
         } else {
             // Validate the provided directory
             watchDirectory = Path.of(parameter);
             if (!Files.exists(watchDirectory)) {
-                System.err.println("Error: Directory does not exist: " + parameter);
+                logger.error("Error: Directory does not exist: {}", parameter);
                 return CliResult.KO;
             }
             if (!Files.isDirectory(watchDirectory)) {
-                System.err.println("Error: Path is not a directory: " + parameter);
+                logger.error("Error: Path is not a directory: {}", parameter);
                 return CliResult.KO;
             }
-            System.out.println("Using specified directory for watching: " + parameter);
+            logger.info("Using specified directory for watching: {}", parameter);
         }
 
         int watchResult = watchService.startWatching(watchDirectory);
@@ -147,10 +151,10 @@ private CliResult handleWatchMode(String parameter) {
     private static void printBanner() {
         try {
             System.out.println();
-            String asciiArt = FigletFont.convertOneLine("PlantUML to PNG CLI");
+            String asciiArt = FigletFont.convertOneLine("Puml to Png CLI");
             System.out.println(colorize(asciiArt, Attribute.GREEN_TEXT()));
         } catch (IOException e) {
-            System.out.println("Error printing banner: " + e.getMessage());
+            logger.error("Error printing banner: {}", e.getMessage());
         }
     }
 
@@ -161,7 +165,7 @@ private static void printBanner() {
      */
     public static void main(String[] args) {
         printBanner();
-        PlantUMLToPng cli = new PlantUMLToPng();
+        MainApplication cli = new MainApplication();
         int exitCode = new CommandLine(cli).execute(args);
         System.exit(exitCode);
     }

…in/java/info/jab/core/PlantUMLToPng.java …/java/info/jab/core/MainApplication.javasrc/main/java/info/jab/core/PlantUMLToPng.java renamed to src/main/java/info/jab/core/MainApplication.java src/main/java/info/jab/core/PlantUMLToPng.java renamed to src/main/java/info/jab/core/MainApplication.java

@@ -7,6 +7,9 @@
 import java.util.Objects;
 import java.util.Optional;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 /**
  * Service class for handling PlantUML file processing operations.
  *
@@ -17,6 +20,8 @@
  */
 public class PlantUMLFileService {
 
+    private static final Logger logger = LoggerFactory.getLogger(PlantUMLFileService.class);
+
     private static final String DEFAULT_PLANTUML_SERVER = "http://www.plantuml.com/plantuml";
 
     private final PlantUMLHttpClient httpClient;
@@ -56,10 +61,10 @@ public PlantUMLFileService(String plantUmlServerUrl) {
     public boolean processFile(Path inputPath) {
         Optional<Path> result = convertToPng(inputPath);
         if (result.isPresent()) {
-            System.out.println("Successfully converted: " + inputPath + " -> " + result.get());
+            logger.info("Successfully converted: {} -> {}", inputPath, result.get());
             return true;
         } else {
-            System.err.println("Failed to convert file: " + inputPath);
+            logger.error("Failed to convert file: {}", inputPath);
             return false;
         }
     }
@@ -71,7 +76,7 @@ public boolean processFile(Path inputPath) {
      * @return Optional containing the PNG output file path, or empty if conversion fails
      */
     public Optional<Path> convertToPng(Path inputPath) {
-        System.out.println("Converting PlantUML file to PNG: " + inputPath);
+        logger.info("Converting PlantUML file to PNG: {}", inputPath);
         try {
             // Read file content
             String content = Files.readString(inputPath, StandardCharsets.UTF_8);
@@ -94,9 +99,7 @@ public Optional<Path> convertToPng(Path inputPath) {
             Files.write(outputPath, pngData.get());
 
             return Optional.of(outputPath);
-
-        } catch (IOException | SecurityException e) {
-            // Handle file I/O errors gracefully
+        } catch (IOException e) {
             return Optional.empty();
         }
     }

src/main/java/info/jab/core/PlantUMLFileService.java

@@ -11,6 +11,9 @@
 import java.util.Optional;
 import java.util.zip.Deflater;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 /**
  * HTTP client for PlantUML server operations.
  *
@@ -20,6 +23,8 @@
  */
 public class PlantUMLHttpClient {
 
+    private static final Logger logger = LoggerFactory.getLogger(PlantUMLHttpClient.class);
+
     private static final Duration HTTP_TIMEOUT = Duration.ofSeconds(10);
 
     private final String serverUrl;
@@ -60,11 +65,16 @@ public Optional<byte[]> generatePngData(String plantUMLContent) {
             if (response.statusCode() == 200) {
                 byte[] pngData = response.body();
                 return pngData.length > 0 ? Optional.of(pngData) : Optional.empty();
+            } else if (response.statusCode() == 400) {
+                logger.error("Status code: {}", response.statusCode());
+                byte[] pngData = response.body();
+                return pngData.length > 0 ? Optional.of(pngData) : Optional.empty();
+            } else {
+                logger.error("Status code: {}", response.statusCode());
             }
-
             return Optional.empty();
-
         } catch (Exception e) {
+            logger.error("Failed to generate PNG data. {}", e.getMessage());
             return Optional.empty();
         }
     }

src/main/java/info/jab/core/PlantUMLHttpClient.java

@@ -3,11 +3,17 @@
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.attribute.FileTime;
+import java.time.Instant;
+import java.time.temporal.ChronoUnit;
 import java.util.List;
 import java.util.Locale;
 import java.util.Objects;
 import java.util.function.BooleanSupplier;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 /**
  * Service responsible for watching directory changes and automatically converting PlantUML files.
  *
@@ -16,6 +22,8 @@
  */
 public class PlantUMLWatchService {
 
+    private static final Logger logger = LoggerFactory.getLogger(PlantUMLWatchService.class);
+
     private static final long DEFAULT_POLLING_INTERVAL_MS = 5000L;
     private static final String PUML_EXTENSION = ".puml";
     private static final String PNG_EXTENSION = ".png";
@@ -84,7 +92,7 @@ public void stopWatching() {
      * @return Exit code (0 for success, 1 for error)
      */
     Integer startWatching(Path watchDirectory, BooleanSupplier shouldContinue) {
-        System.out.println("Starting watch mode in directory: " + watchDirectory);
+        logger.info("Starting watch mode in directory: {}", watchDirectory);
 
         try {
             while (shouldContinue.getAsBoolean()) {
@@ -96,11 +104,11 @@ Integer startWatching(Path watchDirectory, BooleanSupplier shouldContinue) {
             return 0;
 
         } catch (InterruptedException e) {
-            System.out.println("Watch mode interrupted. Exiting...");
+            logger.error("Watch mode interrupted. Exiting...");
             Thread.currentThread().interrupt();
             return 1;
         } catch (IOException e) {
-            System.err.println("Error scanning directory for .puml files: " + e.getMessage());
+            logger.error("Error scanning directory for .puml files: {}", e.getMessage());
             return 1;
         }
     }
@@ -120,10 +128,17 @@ void processPlantUMLFiles(Path directory) throws IOException {
                 Path relativePath = directory.relativize(file);
                 Path pngFile = getPngPath(file);
                 boolean pngExists = Files.exists(pngFile);
+                boolean isRecentlyModified = isFileModifiedInLastSeconds(file);
+
+                // Convert if PNG doesn't exist OR if PUML was modified in the last minute
+                // OR if both files were modified in the same minute (to ensure synchronization)
+                boolean bothFilesModifiedInSameMinute = pngExists && isRecentlyModified && !isFileModifiedInLastSeconds(pngFile);
 
-                // Only print and convert if the PNG file does not exist
-                if (!pngExists) {
-                    System.out.println("Found: " + relativePath);
+                // TODO: Technical debt.
+                if (!pngExists || isRecentlyModified || bothFilesModifiedInSameMinute) {
+                    String reason = !pngExists ? "no .png exists" :
+                                   bothFilesModifiedInSameMinute ? "recently modified .puml file" : "both files recently modified";
+                    logger.info("Found: {} ({})", relativePath, reason);
                     convertToPng(file);
                 }
             });
@@ -159,6 +174,24 @@ private Path getPngPath(Path pumlFile) {
         return Path.of(pngFileName);
     }
 
+    /**
+     * Checks if a file was modified in the last minute.
+     * Package-private to allow overriding in tests.
+     *
+     * @param filePath The path to the file to check
+     * @return true if the file was modified in the last minute, false otherwise
+     */
+    boolean isFileModifiedInLastSeconds(Path filePath) {
+        try {
+            FileTime lastModified = Files.getLastModifiedTime(filePath);
+            Instant tenSecondsAgo = Instant.now().minus(10, ChronoUnit.SECONDS);
+            return lastModified.toInstant().isAfter(tenSecondsAgo);
+        } catch (IOException e) {
+            logger.warn("Could not check modification time for file: {}", filePath, e);
+            return false;
+        }
+    }
+
     /**
      * Converts a PlantUML file to PNG format.
      *