se.bjurr.violations.lib.ViolationsReporterApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of violations-lib Show documentation
Library for parsing report files from static code analyzis.
There is a newer version: 1.157.3
package se.bjurr.violations.lib;

import static se.bjurr.violations.lib.ViolationsReporterDetailLevel.COMPACT;
import static se.bjurr.violations.lib.ViolationsReporterDetailLevel.PER_FILE_COMPACT;
import static se.bjurr.violations.lib.ViolationsReporterDetailLevel.VERBOSE;
import static se.bjurr.violations.lib.model.SEVERITY.ERROR;
import static se.bjurr.violations.lib.model.SEVERITY.INFO;
import static se.bjurr.violations.lib.model.SEVERITY.WARN;
import static se.bjurr.violations.lib.util.Utils.checkNotNull;

import com.jakewharton.fliptables.FlipTable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;
import se.bjurr.violations.lib.model.SEVERITY;
import se.bjurr.violations.lib.model.Violation;

public class ViolationsReporterApi {

  private Iterable violations;
  private int maxReporterColumnWidth;
  private int maxRuleColumnWidth = 10;
  private int maxSeverityColumnWidth;
  private int maxLineColumnWidth;
  private int maxMessageColumnWidth = 50;

  private ViolationsReporterApi() {}

  public static ViolationsReporterApi violationsReporterApi() {
    return new ViolationsReporterApi();
  }

  public String getReport(final ViolationsReporterDetailLevel level) {
    checkNotNull(violations, "violations");

    final StringBuilder sb = new StringBuilder();

    if (level == COMPACT) {
      sb.append(toCompact(violations, "Summary"));
    } else if (level == PER_FILE_COMPACT) {
      sb.append(toPerFile(violations));
      sb.append(toCompact(violations, "Summary"));
    } else if (level == VERBOSE) {
      sb.append(toVerbose(violations));
      sb.append(toCompact(violations, "Summary"));
    }

    return sb.toString();
  }

  private StringBuilder toVerbose(final Iterable violations) {
    final StringBuilder sb = new StringBuilder();
    final Map> perFile = getViolationsPerFile(violations);
    for (final Entry> perFileEntry : perFile.entrySet()) {
      final String file = perFileEntry.getKey();
      final Set fileViolations = perFile.get(file);
      sb.append(file + "\n");
      sb.append(toDetailed(fileViolations, "Summary of " + file));
      sb.append("\n");
    }
    return sb;
  }

  private StringBuilder toPerFile(final Iterable violations) {
    final StringBuilder sb = new StringBuilder();
    final Map> perFile = getViolationsPerFile(violations);
    for (final Entry> fileEntry : perFile.entrySet()) {
      final Set fileViolations = fileEntry.getValue();
      final String fileName = fileEntry.getKey();
      sb.append(toCompact(fileViolations, "Summary of " + fileName));
      sb.append("\n");
    }
    return sb;
  }

  public ViolationsReporterApi withViolations(final List violations) {
    this.violations = violations;
    return this;
  }

  /**
   * Avoid wider column. Will add new lines if wider. A value of 0 or less will disable the feature.
   */
  public ViolationsReporterApi withMaxMessageColumnWidth(final int maxMessageColumnWidth) {
    this.maxMessageColumnWidth = maxMessageColumnWidth;
    return this;
  }

  /**
   * Avoid wider column. Will add new lines if wider. A value of 0 or less will disable the feature.
   */
  public ViolationsReporterApi withMaxLineColumnWidth(final int maxLineColumnWidth) {
    this.maxLineColumnWidth = maxLineColumnWidth;
    return this;
  }

  /**
   * Avoid wider column. Will add new lines if wider. A value of 0 or less will disable the feature.
   */
  public ViolationsReporterApi withMaxReporterColumnWidth(final int maxReporterColumnWidth) {
    this.maxReporterColumnWidth = maxReporterColumnWidth;
    return this;
  }

  /**
   * Avoid wider column. Will add new lines if wider. A value of 0 or less will disable the feature.
   */
  public ViolationsReporterApi withMaxRuleColumnWidth(final int maxRuleColumnWidth) {
    this.maxRuleColumnWidth = maxRuleColumnWidth;
    return this;
  }

  /** Avoid wider column. Will add new lines if wider. */
  public ViolationsReporterApi withMaxSeverityColumnWidth(final int maxSeverityColumnWidth) {
    this.maxSeverityColumnWidth = maxSeverityColumnWidth;
    return this;
  }

  private StringBuilder toDetailed(
      final Iterable violations, final String summarySubject) {
    final StringBuilder sb = new StringBuilder();
    final List rows = new ArrayList<>();
    for (final Violation violation : violations) {
      final String message = addNewlines(violation.getMessage(), maxMessageColumnWidth);
      final String line = addNewlines(violation.getStartLine().toString(), maxLineColumnWidth);
      final String severity = addNewlines(violation.getSeverity().name(), maxSeverityColumnWidth);
      final String rule = addNewlines(violation.getRule().or(""), maxRuleColumnWidth);
      final String reporter = addNewlines(violation.getReporter(), maxReporterColumnWidth);
      final String[] row = {reporter, rule, severity, line, message};
      rows.add(row);
    }

    final String[] headers = {"Reporter", "Rule", "Severity", "Line", "Message"};

    final String[][] data = rows.toArray(new String[][] {});
    sb.append(FlipTable.of(headers, data));
    sb.append("\n");
    sb.append(toCompact(violations, summarySubject));
    sb.append("\n");
    return sb;
  }

  private String addNewlines(final String message, final int maxLineLength) {
    if (message == null) {
      return "";
    }
    if (maxLineLength <= 0) {
      return message;
    }

    int noLineCounter = 0;
    final StringBuilder withNewlines = new StringBuilder();
    for (int i = 0; i < message.length(); i++) {
      final char charAt = message.charAt(i);
      withNewlines.append(charAt);
      if (charAt == '\n') {
        noLineCounter = 0;
      } else {
        noLineCounter++;
      }
      if (noLineCounter > 0 && noLineCounter % maxLineLength == 0) {
        withNewlines.append('\n');
        noLineCounter = 0;
      }
    }
    return withNewlines.toString().trim();
  }

  private StringBuilder toCompact(final Iterable violations, final String subject) {
    final StringBuilder sb = new StringBuilder();
    final Map> perReporter = getViolationsPerReporter(violations);
    final List rows = new ArrayList<>();

    Integer totNumInfo = 0;
    Integer totNumWarn = 0;
    Integer totNumError = 0;
    Integer totNumTot = 0;

    for (final Entry> reporterEntry : perReporter.entrySet()) {
      final String reporter = reporterEntry.getKey();
      final Set reporterViolations = reporterEntry.getValue();
      final Map> perSeverity =
          getViolationsPerSeverity(reporterViolations);
      final Integer numInfo = perSeverity.get(INFO).size();
      final Integer numWarn = perSeverity.get(WARN).size();
      final Integer numError = perSeverity.get(ERROR).size();
      final Integer numTot = numInfo + numWarn + numError;
      final String[] row = {
        reporter, numInfo.toString(), numWarn.toString(), numError.toString(), numTot.toString()
      };
      rows.add(row);

      totNumInfo += numInfo;
      totNumWarn += numWarn;
      totNumError += numError;
      totNumTot += numTot;
    }
    final String[] row = {
      "", totNumInfo.toString(), totNumWarn.toString(), totNumError.toString(), totNumTot.toString()
    };
    rows.add(row);

    final String[] headers = {"Reporter", INFO.name(), WARN.name(), ERROR.name(), "Total"};

    final String[][] data = rows.toArray(new String[][] {});
    sb.append(subject + "\n");
    sb.append(FlipTable.of(headers, data));
    return sb;
  }

  private Map> getViolationsPerSeverity(final Set violations) {
    final Map> violationsPerSeverity = new TreeMap<>();
    for (final SEVERITY severity : SEVERITY.values()) {
      violationsPerSeverity.put(severity, new TreeSet());
    }

    for (final Violation violation : violations) {
      final Set perReporter =
          getOrCreate(violationsPerSeverity, violation.getSeverity());
      perReporter.add(violation);
    }
    return violationsPerSeverity;
  }

  private Map> getViolationsPerFile(final Iterable violations) {
    final Map> violationsPerFile = new TreeMap<>();
    for (final Violation violation : violations) {
      final Set perReporter = getOrCreate(violationsPerFile, violation.getFile());
      perReporter.add(violation);
    }
    return violationsPerFile;
  }

  private Map> getViolationsPerReporter(
      final Iterable violations) {
    final Map> violationsPerReporter = new TreeMap<>();
    for (final Violation violation : violations) {
      final Set perReporter =
          getOrCreate(violationsPerReporter, violation.getReporter());
      perReporter.add(violation);
    }
    return violationsPerReporter;
  }

  private  Set getOrCreate(final Map> container, final K key) {
    if (container.containsKey(key)) {
      return container.get(key);
    } else {
      final Set violationList = new TreeSet<>();
      container.put(key, violationList);
      return violationList;
    }
  }
}