ListDiffPrinter.java

  1. /*
  2.  *  Copyright (c) 2001-2024, Jean Tessier
  3.  *  All rights reserved.
  4.  *  
  5.  *  Redistribution and use in source and binary forms, with or without
  6.  *  modification, are permitted provided that the following conditions
  7.  *  are met:
  8.  *  
  9.  *      * Redistributions of source code must retain the above copyright
  10.  *        notice, this list of conditions and the following disclaimer.
  11.  *  
  12.  *      * Redistributions in binary form must reproduce the above copyright
  13.  *        notice, this list of conditions and the following disclaimer in the
  14.  *        documentation and/or other materials provided with the distribution.
  15.  *  
  16.  *      * Neither the name of Jean Tessier nor the names of his contributors
  17.  *        may be used to endorse or promote products derived from this software
  18.  *        without specific prior written permission.
  19.  *  
  20.  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21.  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22.  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23.  *  A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR
  24.  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25.  *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26.  *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  27.  *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  28.  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  29.  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  30.  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31.  */

  33. package com.jeantessier.diff;

  35. import com.jeantessier.text.PrinterBuffer;
  36. import org.apache.oro.text.perl.Perl5Util;

  38. import java.util.Collection;
  39. import java.util.Collections;
  40. import java.util.TreeSet;

  42. public class ListDiffPrinter {
  43.     public static final boolean DEFAULT_COMPRESS = false;
  44.     public static final String DEFAULT_ENCODING = "utf-8";
  45.     public static final String DEFAULT_DTD_PREFIX  = "https://jeantessier.github.io/dependency-finder/dtd";
  46.     public static final String DEFAULT_INDENT_TEXT = PrinterBuffer.DEFAULT_INDENT_TEXT;

  48.     private static final Perl5Util perl = new Perl5Util();
  49.     
  50.     private final boolean compress;
  51.     private final PrinterBuffer buffer;

  53.     private String name = "";
  54.     private String oldVersion = "";
  55.     private String newVersion = "";
  56.     private final Collection<String> removed = new TreeSet<>();
  57.     private final Collection<String> added = new TreeSet<>();

  59.     public ListDiffPrinter() {
  60.         this(DEFAULT_COMPRESS, DEFAULT_INDENT_TEXT, DEFAULT_ENCODING, DEFAULT_DTD_PREFIX);
  61.     }

  63.     public ListDiffPrinter(boolean compress) {
  64.         this(compress, DEFAULT_INDENT_TEXT, DEFAULT_ENCODING, DEFAULT_DTD_PREFIX);
  65.     }

  67.     public ListDiffPrinter(boolean compress, String indentText, String encoding, String dtdPrefix) {
  68.         this.buffer = new PrinterBuffer(indentText);
  69.         this.compress = compress;

  71.         appendHeader(encoding, dtdPrefix);
  72.     }

  74.     private void appendHeader(String encoding, String dtdPrefix) {
  75.         append("<?xml version=\"1.0\" encoding=\"").append(encoding).append("\" ?>").eol();
  76.         eol();
  77.         append("<!DOCTYPE list-diff SYSTEM \"").append(dtdPrefix).append("/list-diff.dtd\">").eol();
  78.         eol();
  79.     }

  81.     public String getName() {
  82.         return name;
  83.     }

  85.     public void setName(String name) {
  86.         this.name = name;
  87.     }

  89.     public String getOldVersion() {
  90.         return oldVersion;
  91.     }

  93.     public void setOldVersion(String oldVersion) {
  94.         this.oldVersion = oldVersion;
  95.     }

  97.     public String getNewVersion() {
  98.         return newVersion;
  99.     }

  101.     public void setNewVersion(String newVersion) {
  102.         this.newVersion = newVersion;
  103.     }
  104.     
  105.     public Collection<String> getRemoved() {
  106.         return Collections.unmodifiableCollection(removed);
  107.     }

  109.     public void remove(String line) {
  110.         this.removed.add(line);
  111.     }
  112.     
  113.     public Collection<String> getAdded() {
  114.         return Collections.unmodifiableCollection(added);
  115.     }

  117.     public void add(String line) {
  118.         this.added.add(line);
  119.     }

  121.     protected ListDiffPrinter append(boolean b) {
  122.         buffer.append(b);
  123.         return this;
  124.     }

  126.     protected ListDiffPrinter append(char c) {
  127.         buffer.append(c);
  128.         return this;
  129.     }

  131.     protected ListDiffPrinter append(char[] str, int offset, int len) {
  132.         buffer.append(str, offset, len);
  133.         return this;
  134.     }

  136.     protected ListDiffPrinter append(char[] str) {
  137.         buffer.append(str);
  138.         return this;
  139.     }

  141.     protected ListDiffPrinter append(double d) {
  142.         buffer.append(d);
  143.         return this;
  144.     }

  146.     protected ListDiffPrinter append(float f) {
  147.         buffer.append(f);
  148.         return this;
  149.     }

  151.     protected ListDiffPrinter append(int i) {
  152.         buffer.append(i);
  153.         return this;
  154.     }

  156.     protected ListDiffPrinter append(long l) {
  157.         buffer.append(l);
  158.         return this;
  159.     }

  161.     protected ListDiffPrinter append(Object obj) {
  162.         buffer.append(obj);
  163.         return this;
  164.     }

  166.     protected ListDiffPrinter append(String str) {
  167.         buffer.append(str);
  168.         return this;
  169.     }

  171.     protected ListDiffPrinter indent() {
  172.         buffer.indent();
  173.         return this;
  174.     }

  176.     protected ListDiffPrinter eol() {
  177.         buffer.eol();
  178.         return this;
  179.     }

  181.     protected void raiseIndent() {
  182.         buffer.raiseIndent();
  183.     }

  185.     protected void lowerIndent() {
  186.         buffer.lowerIndent();
  187.     }

  189.     public String toString() {
  190.         indent().append("<list-diff>").eol();
  191.         raiseIndent();
  192.         
  193.         indent().append("<name>").append(getName()).append("</name>").eol();
  194.         indent().append("<old>").append(getOldVersion()).append("</old>").eol();
  195.         indent().append("<new>").append(getNewVersion()).append("</new>").eol();
  196.         
  197.         indent().append("<removed>").eol();
  198.         raiseIndent();
  199.         printLines(compress ? compress(getRemoved()) : getRemoved());
  200.         lowerIndent();
  201.         indent().append("</removed>").eol();
  202.         
  203.         indent().append("<added>").eol();
  204.         raiseIndent();
  205.         printLines(compress ? compress(getAdded()) : getAdded());
  206.         lowerIndent();
  207.         indent().append("</added>").eol();
  208.         
  209.         lowerIndent();
  210.         indent().append("</list-diff>").eol();
  211.         
  212.         return buffer.toString();
  213.     }

  215.     private void printLines(Collection<String> lines) {
  216.         lines.forEach(line -> {
  217.             int pos = line.lastIndexOf(" [");
  218.             if (pos != -1) {
  219.                 indent().append("<line>").append(line.substring(0, pos)).append("</line>").eol();
  220.             } else {
  221.                 indent().append("<line>").append(line).append("</line>").eol();
  222.             }
  223.         });
  224.     }

  226.     private Collection<String> compress(Collection<String> lines) {
  227.         Collection<String> result = new TreeSet<>();

  229.         lines.forEach(line -> {
  230.             boolean add = true;
  231.             if (line.endsWith(" [C]")) {
  232.                 String packageName = extractPackageName(line);

  234.                 add = !lines.contains(packageName + " [P]");
  235.             } else if (line.endsWith(" [F]")) {
  236.                 String className = extractClassName(line);
  237.                 String packageName = extractPackageName(className);

  239.                 add = !lines.contains(packageName + " [P]") && !lines.contains(className + " [C]");
  240.             }

  242.             if (add) {
  243.                 result.add(line);
  244.             }
  245.         });

  247.         return result;
  248.     }

  250.     private String extractPackageName(String className) {
  251.         String result = "";

  253.         int pos = className.lastIndexOf('.');
  254.         if (pos != -1) {
  255.             result = className.substring(0, pos);
  256.         }
  257.         
  258.         return result;
  259.     }

  261.     private String extractClassName(String featureName) {
  262.         String result = "";

  264.         synchronized (perl) {
  265.             if (perl.match("/^(.*)\\.[^\\.]*\\(.*\\)(: \\S.*)?/", featureName)) {
  266.                 result = perl.group(1);
  267.             } else if (perl.match("/^(.*)\\.[\\^.]*/", featureName)) {
  268.                 result = perl.group(1);
  269.             }
  270.         }
  271.         
  272.         return result;
  273.     }
  274. }
Created with JaCoCo 0.8.12.202403310830