Cache config (#734)

* Include config in the hash
* Allow to skip the cache
* Change failure log level to error and emit per warning/error

Author: delanym

src/main/java/net/revelc/code/formatter/FormatterMojo.java

@@ -60,7 +60,6 @@
 import org.eclipse.text.edits.MalformedTreeException;
 import org.xml.sax.SAXException;
 
-import com.google.common.base.Strings;
 import com.google.common.hash.Hashing;
 
 import net.revelc.code.formatter.css.CssFormatter;
@@ -262,6 +261,14 @@ public class FormatterMojo extends AbstractMojo implements ConfigurationSource {
     @Parameter(defaultValue = "formatter-maven-plugin/ph-css/css.properties", property = "configcssfile", required = true)
     private String configCssFile;
 
+    /**
+     * Whether the formatting cache is skipped.
+     *
+     * @since 2.23.0
+     */
+    @Parameter(defaultValue = "false", property = "formatter.cache.skip")
+    private boolean skipFormattingCache;
+
     /**
      * Whether the java formatting is skipped.
      */
@@ -462,9 +469,11 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                         this.formatFile(file, rc, hashCache, basedirPath);
                     } else {
                         rc.readOnlyCount++;
+                        this.getLog().warn("File " + file + " is read only");
                     }
                 } else {
                     rc.failCount++;
+                    this.getLog().error("File " + file + " does not exist");
                 }
             }
 
@@ -478,9 +487,16 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             final var elapsed = TimeUtil.printDuration(duration);
 
             final String results = String.format(
-                    "Processed %d files in %s (Formatted: %d, Unchanged: %d, Failed: %d, Readonly: %d)", numberOfFiles,
-                    elapsed, rc.successCount, rc.skippedCount, rc.failCount, rc.readOnlyCount);
-            this.getLog().info(results);
+                    "Processed %d files in %s (Formatted: %d, Skipped: %d, Unchanged: %d, Failed: %d, Readonly: %d)",
+                    numberOfFiles, elapsed, rc.successCount, rc.skippedCount, rc.unchangedCount, rc.failCount,
+                    rc.readOnlyCount);
+
+            if (rc.failCount > 0)
+                this.getLog().error(results);
+            else if (rc.readOnlyCount > 0)
+                this.getLog().warn(results);
+            else
+                this.getLog().info(results);
         }
     }
 
@@ -678,7 +694,7 @@ private void formatFile(final File file, final ResultCollector rc, final Propert
             this.doFormatFile(file, rc, hashCache, basedirPath, false);
         } catch (IOException | MalformedTreeException | BadLocationException e) {
             rc.failCount++;
-            this.getLog().warn(e);
+            this.getLog().error(e);
         }
     }
 
@@ -711,14 +727,14 @@ protected void doFormatFile(final File file, final ResultCollector rc, final Pro
         final var log = this.getLog();
         log.debug("Processing file: " + file);
         final var originalCode = this.readFileAsString(file);
-        final var originalHash = this.sha512hash(originalCode);
+        final var originalHash = this.sha512hash(originalCode + this.javaFormatter.hashCode());
 
         final var canonicalPath = file.getCanonicalPath();
         final var path = canonicalPath.substring(basedirPath.length());
         final var cachedHash = hashCache.getProperty(path);
-        if (cachedHash != null && cachedHash.equals(originalHash)) {
+        if (!skipFormattingCache && cachedHash != null && cachedHash.equals(originalHash)) {
             rc.skippedCount++;
-            log.debug("File is already formatted.");
+            log.debug("Cache hit: file is already formatted.");
             return;
         }
 
@@ -786,7 +802,7 @@ protected void doFormatFile(final File file, final ResultCollector rc, final Pro
 
         // Process the result type
         if (Result.SKIPPED.equals(result)) {
-            rc.skippedCount++;
+            rc.unchangedCount++;
         } else if (Result.SUCCESS.equals(result)) {
             rc.successCount++;
         } else if (Result.FAIL.equals(result)) {
@@ -799,14 +815,14 @@ protected void doFormatFile(final File file, final ResultCollector rc, final Pro
         if (Result.SKIPPED.equals(result)) {
             formattedHash = originalHash;
         } else {
-            formattedHash = this.sha512hash(Strings.nullToEmpty(formattedCode));
+            formattedHash = this.sha512hash(formattedCode + this.javaFormatter.hashCode());
         }
         hashCache.setProperty(path, formattedHash);
         this.hashCacheWritten = true;
 
         // If we had determined to skip write, do so now after cache was written
         if (Result.SKIPPED.equals(result)) {
-            log.debug("File is already formatted.  Writing to cache only.");
+            log.debug("File is already formatted. Writing to cache only.");
             return;
         }
 
@@ -1071,9 +1087,12 @@ static class ResultCollector {
         /** The fail count. */
         int failCount;
 
-        /** The skipped count. */
+        /** The skipped count is incremented for cached files that haven't changed since being cached. */
         int skippedCount;
 
+        /** The unchanged count is incremented on cache misses when a file remains unchanged after formatting. */
+        int unchangedCount;
+
         /** The read only count. */
         int readOnlyCount;
     }

src/main/java/net/revelc/code/formatter/java/JavaFormatter.java

@@ -16,6 +16,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
 import java.util.regex.Pattern;
 
 import org.eclipse.jdt.core.ToolFactory;
@@ -37,17 +38,37 @@
  */
 public class JavaFormatter extends AbstractCacheableFormatter implements Formatter {
 
+    @Override
+    public boolean equals(Object o) {
+        if (this == o)
+            return true;
+        if (o == null || getClass() != o.getClass())
+            return false;
+        JavaFormatter that = (JavaFormatter) o;
+        return Objects.equals(formatter, that.formatter) && Objects.equals(exclusionPattern, that.exclusionPattern)
+                && Objects.equals(options, that.options);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(formatter, exclusionPattern, options);
+    }
+
     /** The formatter. */
     private CodeFormatter formatter;
 
     /** The exclusion pattern. */
     private Pattern exclusionPattern;
 
+    /** The configuration options */
+    private Map<String, String> options;
+
     @Override
     public void init(final Map<String, String> options, final ConfigurationSource cfg) {
         super.initCfg(cfg);
 
         this.formatter = ToolFactory.createCodeFormatter(options, ToolFactory.M_FORMAT_EXISTING);
+        this.options = options;
     }
 
     @Override