ru.vyarus.yaml.updater.report.ReportPrinter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yaml-config-updater Show documentation
Merges current yaml config with a new version to add missed properties
There is a newer version: 1.4.4
package ru.vyarus.yaml.updater.report;

import java.util.List;
import java.util.Map;

/**
 * Formats update report.
 *
 * @author Vyacheslav Rusakov
 * @since 31.08.2021
 */
@SuppressWarnings("checkstyle:MultipleStringLiterals")
public final class ReportPrinter {

    private ReportPrinter() {
    }

    /**
     * @param report report object
     * @return formatted update report
     */
    public static String print(final UpdateReport report) {
        final StringBuilder res = new StringBuilder(50);
        if (report.isConfigChanged()) {
            printHeader(report, res);

            if (!report.getAppliedVariables().isEmpty()) {
                res.append("\n\tApplied variables:\n");
                for (Map.Entry entry : report.getAppliedVariables().entrySet()) {
                    res.append("\t\t").append(String.format("%-25s = %s", entry.getKey(), entry.getValue()))
                            .append('\n');
                }
            }

            if (report.getBeforeSize() == 0) {
                res.append("\n\tNew configuration copied as-is\n");
            } else if (report.getRemoved().isEmpty() && report.getAdded().isEmpty()) {
                res.append("\n\tOnly comments, order or formatting changed\n");
            } else {
                if (!report.getRemoved().isEmpty()) {
                    res.append("\n\tRemoved from old file:\n");
                    printChanges(report.getRemoved(), res);
                }
                if (!report.getAdded().isEmpty()) {
                    res.append("\n\tAdded from new file:\n");
                    printChanges(report.getAdded(), res);
                }
            }

            printBackup(report, res);
        } else {
            printConfigurationInfo(report, res);
            res.append("\n\tNot changed\n");
        }
        return res.toString();
    }

    /**
     * Prints merged file from dry run execution.
     *
     * @param report report instance
     * @return formatted merged file
     */
    public static String printDryRunResult(final UpdateReport report) {
        if (!report.isDryRun()) {
            throw new IllegalArgumentException("Not a DRY RUN");
        }
        return "\n\n----------------------------------------------------------------------------------"
                + "[ Merged config (NOT SAVED) ]\n"
                + report.getDryRunResult()
                + "\n----------------------------------------------------------------------------------"
                + "[ end of merged config ] \n\n";
    }


    private static void printHeader(final UpdateReport report, final StringBuilder out) {
        if (report.getBeforeSize() > 0) {
            printConfigurationInfo(report, out);
        } else {
            out.append("Not existing configuration: ").append(report.getConfig().getAbsolutePath()).append('\n');
        }

        out.append("Updated from source of ");
        printSize(report.getUpdateSize(), report.getUpdateLines(), out);

        out.append("\nResulted in ");
        printSize(report.getAfterSize(), report.getAfterLinesCnt(), out);
        out.append('\n');
    }

    private static void printConfigurationInfo(final UpdateReport report, final StringBuilder out) {
        out.append("Configuration: ").append(report.getConfig().getAbsolutePath()).append(" (");
        printSize(report.getBeforeSize(), report.getBeforeLinesCnt(), out);
        out.append(")\n");
    }

    private static void printSize(final long size, final int lines, final StringBuilder out) {
        out.append(size).append(" bytes, ").append(lines).append(" lines");
    }

    private static void printChanges(final List changes, final StringBuilder out) {
        for (UpdateReport.Pair change : changes) {
            out.append("\t\t").append(String.format("%-40s %s%s", change.getPath(), change.getValue(), '\n'));
        }
    }

    private static void printBackup(final UpdateReport report, final StringBuilder out) {
        if (report.getBackup() != null) {
            out.append("\n\tBackup created: ");
            if (report.getConfig().getAbsoluteFile().getParentFile()
                    .equals(report.getBackup().getAbsoluteFile().getParentFile())) {
                // when backup created in the same dir show only file name
                out.append(report.getBackup().getName());
            } else {
                // when custom dir show complete path
                out.append(report.getBackup().getAbsolutePath());
            }
            out.append('\n');
        }
    }
}