com.btkelly.gnag.utils.ReportWriter.java Source code

Introduction

Here is the source code for com.btkelly.gnag.utils.ReportWriter.java
Source

/**
 * Copyright 2016 Bryan Kelly
 *
 * 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.btkelly.gnag.utils;

import com.btkelly.gnag.models.Violation;
import org.apache.commons.io.FileUtils;
import org.jetbrains.annotations.NotNull;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.Set;

/**
 * Created by bobbake4 on 4/18/16.
 */
public final class ReportWriter {

    public static final String REPORT_FILE_NAME = "gnag.html";
    private static final String CSS_FILE_NAME = "github-markdown.css";
    private static final String LOCAL_SUCCESS_COMMENT = "Congrats, no poop code found!";

    private static final String HTML_REPORT_PREFIX = "<!DOCTYPE html>" + "<html>"
            + "<link rel=\"stylesheet\" href=\"github-markdown.css\">" + "<article class=\"markdown-body\">";

    private static final String HTML_REPORT_SUFFIX = "</article></html>";

    public static boolean writeReportToDirectory(@NotNull final Set<Violation> violations,
            @NotNull final File directory) {

        //noinspection ResultOfMethodCallIgnored
        directory.mkdirs();

        final StringBuilder builder = new StringBuilder().append(HTML_REPORT_PREFIX);

        if (violations.isEmpty()) {
            builder.append(LOCAL_SUCCESS_COMMENT);
        } else {
            builder.append(ViolationsFormatter.getHtmlStringForAggregatedComment(violations));
        }

        builder.append(HTML_REPORT_SUFFIX);

        try {
            final File htmlReportFile = new File(directory, REPORT_FILE_NAME);
            FileUtils.write(htmlReportFile, builder.toString());
        } catch (final IOException e) {
            System.out.println("Error writing Gnag local report.");
            e.printStackTrace();
            return false;
        }

        copyCssFileToDirectory(directory);

        return true;
    }

    private static void copyCssFileToDirectory(@NotNull final File directory) {
        try {
            //TODO fix this
            final InputStream resourceAsStream = ReportWriter.class.getClassLoader()
                    .getResourceAsStream(CSS_FILE_NAME);
            final File gnagCssOutputFile = new File(directory, CSS_FILE_NAME);
            FileUtils.copyInputStreamToFile(resourceAsStream, gnagCssOutputFile);

        } catch (final Exception e) {
            System.out.println("Error copying CSS file for local report.");
        }
    }

    private ReportWriter() {

    }

}