info.novatec.testit.livingdoc.report.FileReportGenerator.java Source code

Introduction

Here is the source code for info.novatec.testit.livingdoc.report.FileReportGenerator.java

Source

/* Copyright (c) 2007 Pyxis Technologies inc.
 * 
 * This is free software; you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later
 * version.
 * 
 * This software is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site:
 * http://www.fsf.org. */

package info.novatec.testit.livingdoc.report;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;

import org.apache.commons.io.IOUtils;

import info.novatec.testit.livingdoc.util.Factory;
import info.novatec.testit.livingdoc.util.URIUtil;

public class FileReportGenerator implements ReportGenerator {
    private final File reportsDirectory;

    private Class<? extends Report> reportClass;
    private boolean automaticExtension;

    public FileReportGenerator(File outputDir) {
        this.reportsDirectory = outputDir;
        this.reportClass = PlainReport.class;
    }

    public void setReportClass(Class<? extends Report> reportClass) {
        this.reportClass = reportClass;
    }

    @Override
    public void adjustReportFilesExtensions(boolean enable) {
        this.automaticExtension = enable;
    }

    @Override
    public Report openReport(String name) {
        Factory<Report> factory = new Factory<Report>(reportClass);
        return factory.newInstance(name);
    }

    @Override
    public void closeReport(Report report) throws IOException {
        Writer out = null;
        try {
            File reportFile = new File(reportsDirectory, outputNameOf(report));
            reportFile.getParentFile().mkdirs();
            out = new BufferedWriter(
                    new OutputStreamWriter(new FileOutputStream(reportFile.getAbsolutePath()), "UTF-8"));
            report.printTo(out);
            out.flush();
        } finally {
            IOUtils.closeQuietly(out);
        }
    }

    private String outputNameOf(Report report) {
        String name = report.getName();
        StringBuilder nameBuilder = new StringBuilder(name);
        if (automaticExtension && !name.endsWith(extensionOf(report))) {
            nameBuilder.append(extensionOf(report));
        }
        return URIUtil.escapeFileSystemForbiddenCharacters(nameBuilder.toString());
    }

    private String extensionOf(Report report) {
        return "." + report.getType();
    }
}