Merge pull request #35 from exadel-inc/develop

smiakchilo · web-flow · commit 928ba89cc3da · 2025-02-28T20:49:14.000+03:00
[Tech] Release 1.1.2
diff --git a/README.md b/README.md
@@ -99,7 +99,7 @@ To use Java API, add the following dependency to your Maven project:
 <dependency>
     <groupId>com.exadel.etoolbox</groupId>
     <artifactId>etoolbox-anydiff-core</artifactId>
-    <version>1.1.1</version> <!-- always prefer the latest stable version -->
+    <version>1.1.2</version> <!-- always prefer the latest stable version -->
 </dependency>
 ```
 
diff --git a/cli/pom.xml b/cli/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.exadel.etoolbox</groupId>
         <artifactId>etoolbox-anydiff</artifactId>
-        <version>1.1.1</version>
+        <version>1.1.2</version>
     </parent>
 
     <artifactId>etoolbox-anydiff-cli</artifactId>
diff --git a/cli/src/main/java/com/exadel/etoolbox/anydiff/Main.java b/cli/src/main/java/com/exadel/etoolbox/anydiff/Main.java
@@ -43,9 +43,6 @@
 @Slf4j
 public class Main {
 
-    private static final org.slf4j.Marker CONSOLE_ONLY = MarkerFactory.getMarker("CONSOLE_ONLY");
-    private static final org.slf4j.Marker LOGFILE_ONLY = MarkerFactory.getMarker("FILE_ONLY");
-
     private static final String REPLACED_FILENAME_CHARS = "[.,:/?\"<>|*\\\\]+";
 
     private static final String EXTENSION_HTML = ".html";
@@ -67,7 +64,6 @@ public static void main(String[] args) {
                     log.info("-{} (--{}) {}", option.getOpt(), option.getLongOpt(), option.getDescription()));
             return;
         }
-        System.out.print("EToolbox AnyDiff ");
         AnyDiff anyDiff = new AnyDiff()
                 .left(runArguments.getLeft())
                 .right(runArguments.getRight());
@@ -194,8 +190,9 @@ private static void printHead(int allCount, long pendingCount) {
             log.info(line);
             log.info(StringUtils.repeat(Constants.EQUALS, line.length() - 1));
         } else {
-            log.info(String.format("\nFound %d new difference(-s)", pendingCount));
+            String line = String.format("\nFound %d new difference(-s)", pendingCount);
             String secondLine = String.format("There are also %d accepted difference(-s)", allCount - pendingCount);
+            log.info(line);
             log.info(secondLine);
             log.info(StringUtils.repeat(Constants.EQUALS, secondLine.length()));
         }
@@ -216,11 +213,11 @@ private static void print(Diff diff, RunArguments runArguments, boolean isOneOfM
                 log.info("No differences");
             }
         } else {
-            if (isOneOfMany) {
+            if (isOneOfMany && diff.getCount() > 0) {
                 log.info("{} difference(-s)", diff.getCount());
             }
-            log.info(CONSOLE_ONLY, diff.toString(OutputType.CONSOLE));
-            log.info(LOGFILE_ONLY, diff.toString(OutputType.LOG));
+            log.info(MarkerFactory.getMarker(Constants.MARKER_CONSOLE_ONLY), diff.toString(OutputType.CONSOLE));
+            log.info(MarkerFactory.getMarker(Constants.MARKER_FILE_ONLY), diff.toString(OutputType.LOG));
         }
     }
 
diff --git a/cli/src/main/java/com/exadel/etoolbox/anydiff/log/ConsoleAppender.java b/cli/src/main/java/com/exadel/etoolbox/anydiff/log/ConsoleAppender.java
@@ -0,0 +1,48 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.exadel.etoolbox.anydiff.log;
+
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.classic.spi.LoggingEvent;
+import com.exadel.etoolbox.anydiff.Constants;
+import org.apache.commons.lang3.StringUtils;
+
+import java.io.IOException;
+
+/**
+ * Extends {@link  ch.qos.logback.core.ConsoleAppender} to handle both transient (disappearing) and persistent console
+ * messages
+ */
+public class ConsoleAppender extends ch.qos.logback.core.ConsoleAppender<ILoggingEvent> {
+
+    private int transientMessageLength = 0;
+
+    @Override
+    protected void writeOut(ILoggingEvent event) throws IOException {
+        if (!(event instanceof LoggingEvent)) {
+            super.writeOut(event);
+            return;
+        }
+        if (transientMessageLength > 0) {
+            LoggingEvent newEvent = new LoggingEvent();
+            newEvent.setMessage("." + StringUtils.repeat('\b', transientMessageLength));
+            super.writeOut(newEvent);
+            transientMessageLength = 0;
+        }
+        if (StringUtils.startsWith(event.getMessage(), Constants.DOT)) {
+            transientMessageLength = event.getFormattedMessage().length() - 1;
+        }
+        super.writeOut(event);
+    }
+}
diff --git a/cli/src/main/java/com/exadel/etoolbox/anydiff/log/ConsoleEncoder.java b/cli/src/main/java/com/exadel/etoolbox/anydiff/log/ConsoleEncoder.java
@@ -0,0 +1,33 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.exadel.etoolbox.anydiff.log;
+
+import ch.qos.logback.classic.encoder.PatternLayoutEncoder;
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import com.exadel.etoolbox.anydiff.Constants;
+import org.apache.commons.lang3.StringUtils;
+
+/**
+ * Extends {@link PatternLayoutEncoder} to handle both transient and persistent console messages
+ */
+public class ConsoleEncoder extends PatternLayoutEncoder {
+
+    @Override
+    public byte[] encode(ILoggingEvent event) {
+        if (StringUtils.startsWith(event.getMessage(), Constants.DOT)) {
+            return event.getFormattedMessage().substring(Constants.DOT.length()).getBytes();
+        }
+        return super.encode(event);
+    }
+}
diff --git a/cli/src/main/java/com/exadel/etoolbox/anydiff/log/FileAppender.java b/cli/src/main/java/com/exadel/etoolbox/anydiff/log/FileAppender.java
@@ -22,7 +22,7 @@
 
 /**
  * Extends {@link  ch.qos.logback.core.FileAppender} to provide a custom log file cleanup logic
- * @param <E>
+ * @param <E> Type of log event
  */
 public class FileAppender<E> extends ch.qos.logback.core.FileAppender<E> {
 
diff --git a/cli/src/main/resources/logback.xml b/cli/src/main/resources/logback.xml
@@ -2,7 +2,7 @@
 <configuration>
     <timestamp key="timestamp" datePattern="yyyyMMddHHmmss"/>
 
-    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
+    <appender name="CONSOLE" class="com.exadel.etoolbox.anydiff.log.ConsoleAppender">
         <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
             <evaluator class="com.exadel.etoolbox.anydiff.log.ExcludingEventEvaluator">
                 <exclude>FILE_ONLY</exclude>
@@ -12,7 +12,7 @@
             <OnMismatch>DENY</OnMismatch>
             <OnMatch>ACCEPT</OnMatch>
         </filter>
-        <encoder>
+        <encoder class="com.exadel.etoolbox.anydiff.log.ConsoleEncoder">
             <charset>UTF-8</charset>
             <pattern>%msg%n</pattern>
         </encoder>
diff --git a/core/pom.xml b/core/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.exadel.etoolbox</groupId>
         <artifactId>etoolbox-anydiff</artifactId>
-        <version>1.1.1</version>
+        <version>1.1.2</version>
     </parent>
 
     <artifactId>etoolbox-anydiff-core</artifactId>
diff --git a/core/src/main/java/com/exadel/etoolbox/anydiff/Constants.java b/core/src/main/java/com/exadel/etoolbox/anydiff/Constants.java
@@ -64,6 +64,9 @@ public class Constants {
     public static final char BRACKET_OPEN = '[';
     public static final char BRACKET_CLOSE = ']';
 
+    public static final String MARKER_CONSOLE_ONLY = "CONSOLE_ONLY";
+    public static final String MARKER_FILE_ONLY = "FILE_ONLY";
+
     public static final String TAG_AUTO_CLOSE = "/>";
     public static final String TAG_CLOSE = ">";
     public static final char TAG_CLOSE_CHAR = '>';
diff --git a/core/src/main/java/com/exadel/etoolbox/anydiff/ContentType.java b/core/src/main/java/com/exadel/etoolbox/anydiff/ContentType.java
@@ -90,6 +90,8 @@ boolean matchesName(String value) {
             String extension = StringUtils.substringAfterLast(value, Constants.DOT);
             return StringUtils.equalsAnyIgnoreCase(
                     extension,
+                    "any",
+                    "conf",
                     "css",
                     "csv",
                     "ecma",
@@ -104,8 +106,11 @@ boolean matchesName(String value) {
                     "mf",
                     "php",
                     "properties",
+                    "rules",
                     "ts",
-                    "txt");
+                    "txt",
+                    "vars",
+                    "vhost");
         }
     };
 
diff --git a/core/src/main/java/com/exadel/etoolbox/anydiff/comparison/DiffImpl.java b/core/src/main/java/com/exadel/etoolbox/anydiff/comparison/DiffImpl.java
@@ -201,7 +201,7 @@ private String toText(OutputType target) {
                 .stream()
                 .filter(Objects::nonNull)
                 .map(PrintableEntry.class::cast)
-                .map(entry -> entry.toString(target).trim())
+                .map(entry -> entry.toString(target))
                 .collect(Collectors.joining(StringUtils.LF + StringUtils.LF)) +
                 StringUtils.LF;
     }
diff --git a/core/src/main/java/com/exadel/etoolbox/anydiff/comparison/DiffTask.java b/core/src/main/java/com/exadel/etoolbox/anydiff/comparison/DiffTask.java
@@ -25,7 +25,9 @@
 import com.github.difflib.text.DiffRow;
 import com.github.difflib.text.DiffRowGenerator;
 import lombok.Builder;
+import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
+import org.slf4j.MarkerFactory;
 
 import java.util.ArrayList;
 import java.util.Collections;
@@ -40,12 +42,11 @@
  * <u>Note</u>: This class is not a part of public API and is subject to change. You should not use it directly
  */
 @Builder(builderClassName = "Builder")
+@Slf4j
 public class DiffTask {
 
     private static final UnaryOperator<String> EMPTY_NORMALIZER = StringUtils::defaultString;
 
-    private static final String MESSAGE_COMPARING = "Comparing... ";
-
     private final ContentType contentType;
 
     private final String leftId;
@@ -118,10 +119,8 @@ public Diff run() {
                     .build();
             return new DiffImpl(leftId, rightId).withChildren(miss);
         }
-        System.out.print(MESSAGE_COMPARING);
-        Diff result = contentType == ContentType.UNDEFINED ? runForBinary() : runForText();
-        System.out.print(StringUtils.repeat('\b', MESSAGE_COMPARING.length()));
-        return result;
+        log.info(MarkerFactory.getMarker(Constants.MARKER_CONSOLE_ONLY), ".Comparing...");
+        return contentType == ContentType.UNDEFINED ? runForBinary() : runForText();
     }
 
     private Diff runForBinary() {
@@ -151,7 +150,15 @@ private Diff runForText() {
         String rightPreprocessed = getPreprocessor(rightId).apply(rightContent.toString());
         List<String> leftLines = StringUtil.splitByNewline(leftPreprocessed);
         List<String> rightLines = StringUtil.splitByNewline(rightPreprocessed);
-        List<DiffRow> diffRows = generator.generateDiffRows(leftLines, rightLines);
+
+        List<DiffRow> diffRows;
+        try {
+            diffRows = generator.generateDiffRows(leftLines, rightLines);
+        } catch (Exception e) {
+            log.error("Exception when comparing {} and {}", leftId, rightId, e);
+            return new DiffImpl(leftId, rightId)
+                .withChildren(new ErrorBlockImpl(e, taskParameters.getColumnWidth() - 1));
+        }
         diffRows = getPostprocessor().apply(diffRows);
 
         DiffImpl result = new DiffImpl(leftId, rightId);
diff --git a/core/src/main/java/com/exadel/etoolbox/anydiff/comparison/ErrorBlockImpl.java b/core/src/main/java/com/exadel/etoolbox/anydiff/comparison/ErrorBlockImpl.java
@@ -0,0 +1,105 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.exadel.etoolbox.anydiff.comparison;
+
+import com.exadel.etoolbox.anydiff.Constants;
+import com.exadel.etoolbox.anydiff.OutputType;
+import com.exadel.etoolbox.anydiff.diff.DiffState;
+import org.apache.commons.lang3.NotImplementedException;
+import org.apache.commons.lang3.StringUtils;
+
+/**
+ * Implements {@link AbstractBlock} to represent an exception in the comparison process
+ */
+class ErrorBlockImpl extends AbstractBlock {
+    private final MarkedString message;
+
+    ErrorBlockImpl(Exception e, int columnWidth) {
+        String messageString = StringUtils.defaultIfEmpty(e.getMessage(), e.getClass().getName());
+        this.message = new MarkedString(messageString, Marker.ERROR);
+        setColumnWidth(columnWidth);
+    }
+
+    /* ---------
+       Accessors
+       --------- */
+
+    @Override
+    public int getCount() {
+        return 0;
+    }
+
+    @Override
+    public int getPendingCount() {
+        return 0;
+    }
+
+    @Override
+    public DiffState getState() {
+        return DiffState.ERROR;
+    }
+
+    /* -------
+       Content
+       ------- */
+
+    @Override
+    public String getLeft(boolean includeContext) {
+        return StringUtils.EMPTY;
+    }
+
+    @Override
+    public String getRight(boolean includeContext) {
+        return StringUtils.EMPTY;
+    }
+
+    /* ----------
+       Operations
+       ---------- */
+
+    @Override
+    public void accept() {
+        throw new NotImplementedException();
+    }
+
+    /* ------
+       Output
+       ------ */
+
+    @Override
+    public String toString(OutputType target) {
+        if (target == OutputType.HTML) {
+            return toHtml();
+        } else {
+            return toText(target);
+        }
+    }
+
+    private String toHtml() {
+        return HtmlTags
+                .div().withClassAttr(Constants.CLASS_LEFT).withContent(getLeftLabel())
+                .div().withClassAttr(Constants.CLASS_RIGHT).withContent(getRightLabel())
+                .wrapIn(HtmlTags.line())
+                .withClassAttr(Constants.CLASS_HEADER)
+                .wrapIn(HtmlTags.section())
+                .withClassAttr("no-header")
+                .withContent(message.toHtml())
+                .toString();
+    }
+
+    private String toText(OutputType target) {
+        int fullWidth = getColumnWidth() * 2 + 3;
+        return String.join(StringUtils.LF, message.toText(target, fullWidth));
+    }
+}
diff --git a/core/src/main/java/com/exadel/etoolbox/anydiff/comparison/FragmentImpl.java b/core/src/main/java/com/exadel/etoolbox/anydiff/comparison/FragmentImpl.java
diff --git a/core/src/main/java/com/exadel/etoolbox/anydiff/comparison/Marker.java b/core/src/main/java/com/exadel/etoolbox/anydiff/comparison/Marker.java
diff --git a/core/src/main/java/com/exadel/etoolbox/anydiff/comparison/TokenizerUtil.java b/core/src/main/java/com/exadel/etoolbox/anydiff/comparison/TokenizerUtil.java
diff --git a/core/src/main/java/com/exadel/etoolbox/anydiff/diff/DiffState.java b/core/src/main/java/com/exadel/etoolbox/anydiff/diff/DiffState.java
diff --git a/core/src/main/resources/html/style.css b/core/src/main/resources/html/style.css
diff --git a/pom.xml b/pom.xml
