play.modules.docviewer.ExportDocumentationGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of play-docviewer Show documentation
Play! DocViewer Module
There is a newer version: 1.5.0
package play.modules.docviewer;

import org.apache.commons.io.FilenameUtils;
import org.apache.commons.io.filefilter.SuffixFileFilter;
import play.Logger;
import play.Play;
import play.libs.Files;
import play.libs.IO;
import play.vfs.VirtualFile;

import java.io.File;
import java.io.FilenameFilter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @author Marek Piechut
 */
public class ExportDocumentationGenerator extends DocumentationGenerator {

    @Override
    public List> listSections() {
        File[] textileFiles = projectDocsPath.listFiles((FilenameFilter) new SuffixFileFilter(".textile"));
        List> sections = new ArrayList>(textileFiles.length);

        for (File textileFile : textileFiles) {
            String textile = IO.readContentAsString(textileFile);
            String title = getTitle(textile);
            String id = FilenameUtils.getBaseName(textileFile.getPath());

            Map section = new HashMap(2);
            section.put("title", title);
            section.put("href", id + ".html");
            section.put("id", id);

            sections.add(section);
        }

        return sections;
    }

    /**
     * Generate HTMLs so you can share project documentation without source
     *
     * @param args
     * @throws java.io.IOException
     */
    public static void main(String[] args) throws IOException {
        if (!Play.started) {
            Play.init(new File("."), "dev");
            Play.start();
        }

        DocumentationGenerator generator = new ExportDocumentationGenerator();
        if(!generator.projectDocsPath.isDirectory()) {
            Logger.error("Project documentation folder does not exist. Nothing to generate.");
            return;
        }

        File targetFolder = new File(Play.tmpDir, "documentation");
        Files.deleteDirectory(targetFolder);

        targetFolder.mkdirs();
        String index = generator.generateIndex();
        File outFile = new File(targetFolder, "index.html");
        outFile.createNewFile();
        IO.writeContent(index, outFile);

        List> sections = generator.listSections();
        for (Map section : sections) {
            String href = section.get("href");
            outFile = new File(targetFolder, href);
            outFile.createNewFile();
            IO.writeContent(generator.generatePage(section.get("id")), outFile);
        }

        Play.stop();

        File images = new File(generator.projectDocsPath, "images");
        if (images.exists()) {
            IO.copyDirectory(images, new File(targetFolder, "images"));
        }

        File files = new File(generator.projectDocsPath, "files");
        if (files.exists()) {
            IO.copyDirectory(files, new File(targetFolder, "files"));
        }

        String fileName = Play.configuration.getProperty("application.name") + "-docs.zip";
        //Make sure zip can be written
        fileName = Files.sanitizeFileName(fileName);

        File zipFile = new File(generator.projectDocsPath, fileName);
        Files.zip(targetFolder, zipFile);
        Logger.info("Project documentation exported to: %s", VirtualFile.open(zipFile).relativePath());
    }
}