com.github.cukedoctor.mojo.CukedoctorMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cukedoctor-maven-plugin Show documentation
There is a newer version: 3.9.0
Show newest version
package com.github.cukedoctor.mojo;

/*
 * Copyright 2001-2005 The Apache Software Foundation.
 *
 * 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.
 */

import static com.github.cukedoctor.extension.CukedoctorExtensionRegistry.*;

import com.github.cukedoctor.Cukedoctor;
import com.github.cukedoctor.api.CukedoctorConverter;
import com.github.cukedoctor.api.DocumentAttributes;
import com.github.cukedoctor.api.model.Feature;
import com.github.cukedoctor.mojo.model.Format;
import com.github.cukedoctor.mojo.model.Toc;
import com.github.cukedoctor.parser.FeatureParser;
import com.github.cukedoctor.util.FileUtil;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.asciidoctor.Asciidoctor;
import org.asciidoctor.OptionsBuilder;
import org.asciidoctor.SafeMode;

import java.io.File;
import java.util.*;

@Mojo(name = "execute",
        defaultPhase = LifecyclePhase.INSTALL)
public class CukedoctorMojo extends AbstractMojo {

    @Parameter(defaultValue = "documentation", required = false)
    String outputFileName;

    @Parameter(defaultValue = "cukedoctor", required = false)
    String outputDir;

    @Parameter(required = false)
    String featuresDir;

    @Parameter(required = false)
    String introChapterDir;

    @Parameter(required = false)
    String documentTitle;

    @Parameter(defaultValue = "html5", required = true)
    Format format;

    @Parameter(defaultValue = "right", required = false)
    Toc toc;

    @Parameter(defaultValue = "false", required = false)
    boolean numbered;

    @Parameter(defaultValue = "false", required = false)
    boolean disableTheme;

    @Parameter(defaultValue = "false", required = false)
    boolean disableFilter;

    @Parameter(defaultValue = "false", required = false)
    boolean disableMinimizable;

    @Parameter(defaultValue = "false", required = false)
    boolean disableFooter;

    @Parameter(required = false)
    String docVersion;

    @Parameter(defaultValue = "true", required = false)
    boolean hardBreaks;


    @Component
    MavenProject project;

    private String generatedFile = null;//only for tests


    public void execute() throws MojoExecutionException, MojoFailureException {
        String startDir = null;
        if (featuresDir != null) {
            startDir = featuresDir;
        }
        if (startDir == null || !new File(startDir).exists()) {
            startDir = project.getBuild().getDirectory() != null ? new File(project.getBuild().getDirectory()).getAbsolutePath() : null;
            if (startDir == null || !new File(startDir).exists()) {
                //last resource use project dir
                startDir = project.getBasedir().getAbsolutePath();
            }
        }
        if(introChapterDir != null){
            System.setProperty("INTRO_CHAPTER_DIR",introChapterDir);
        }
        getLog().info("Searching cucumber features in path: " + startDir);
        List featuresFound = FeatureParser.findAndParse(startDir);
        if (featuresFound == null || featuresFound.isEmpty()) {
            getLog().warn("No cucumber json files found in " + startDir);
            return;
        } else {
            getLog().info("Generating living documentation for " + featuresFound.size() + " feature(s)...");
        }

        configExtensions();
        DocumentAttributes documentAttributes = new DocumentAttributes().
                backend(format.name().toLowerCase()).
                toc(toc.name().toLowerCase()).
                revNumber(docVersion).
                hardBreaks(hardBreaks).
                numbered(numbered);
        if (format.equals(Format.pdf)) {
            documentAttributes.pdfTheme(true).docInfo(false);
        } else {
            documentAttributes.docInfo(true).
                    backend(Format.html5.name()).
                    pdfTheme(false);
        }

        if (documentTitle == null) {
            documentTitle = "Living Documentation";
        }
        documentAttributes.docTitle(documentTitle);
        CukedoctorConverter converter = Cukedoctor.instance(featuresFound, documentAttributes);
        String targetFile = "";
        if (outputFileName.contains(".")) {
            targetFile = outputFileName.substring(0, outputFileName.lastIndexOf(".")) + ".adoc";
        } else {
            targetFile = outputFileName + ".adoc";
        }

        String targetDir = getDocumentationDir();
        String pathToSave = targetDir + targetFile;
        converter.setFilename(pathToSave);//needed by docinfo, pdf-theme
        generatedFile = converter.renderDocumentation();
        File adocFile = FileUtil.saveFile(pathToSave, generatedFile);

        Asciidoctor asciidoctor = Asciidoctor.Factory.create();

        if (format.equals(Format.all)) {
            documentAttributes.backend(Format.html5.name().toLowerCase());
            generateDocumentation(documentAttributes, adocFile, asciidoctor);
            //pdf backend
            documentAttributes = new DocumentAttributes().
                    backend(Format.pdf.name()).
                    toc(toc.name().toLowerCase()).
                    revNumber(docVersion).
                    hardBreaks(hardBreaks).
                    numbered(numbered);
            converter = Cukedoctor.instance(featuresFound, documentAttributes);
            converter.setFilename(pathToSave);//needed by docinfo, pdf-theme
            generatedFile = converter.renderDocumentation();
            adocFile = FileUtil.saveFile(pathToSave, generatedFile);
            generateDocumentation(documentAttributes, adocFile, asciidoctor);
        } else {
            generateDocumentation(documentAttributes, adocFile, asciidoctor);
        }

        asciidoctor.shutdown();
    }

    private void configExtensions() {
        if (disableFilter) {
            System.setProperty(FILTER_DISABLE_EXT_KEY, "disabled");
        } else {
            System.clearProperty(FILTER_DISABLE_EXT_KEY);
        }
        if (disableMinimizable) {
            System.setProperty("cukedoctor.disable.minmax", "disabled");
        } else {
            System.clearProperty("cukedoctor.disable.minmax");
        }
        if (disableTheme) {
            System.setProperty("cukedoctor.disable.theme", "disabled");
        } else {
            System.clearProperty("cukedoctor.disable.theme");
        }
        if (disableFooter) {
            System.setProperty("cukedoctor.disable.footer", "disabled");
        } else {
            System.clearProperty("cukedoctor.disable.footer");
        }
    }

    private void generateDocumentation(DocumentAttributes documentAttributes, File adocFile, Asciidoctor asciidoctor) {
        if ("pdf".equals(documentAttributes.getBackend())) {
            asciidoctor.unregisterAllExtensions();
        }
        asciidoctor.convertFile(adocFile, OptionsBuilder.options().backend(documentAttributes.getBackend()).safe(SafeMode.UNSAFE).asMap());
        //remove auxiliary files
        if ("pdf".equals(documentAttributes.getBackend())) {
            FileUtil.removeFile(adocFile.getParent() + "/" + outputFileName + "-theme.yml");

        }

        getLog().info("Generated documentation at: " + adocFile.getParent());
    }

    /**
     * documentation is saved under ${buildDir}/cukedoctor folder
     */
    String getDocumentationDir() {
        String baseDir = project.getBuild().getDirectory();
        if (baseDir == null || new File(baseDir).exists()) {
            baseDir = project.getBasedir().getAbsolutePath();
            baseDir = baseDir + "/target";
            if (!new File(baseDir).exists()) {
                //maven plugin declared in child module
                baseDir = project.getBasedir().getAbsolutePath();
            }
        }
        if (!baseDir.endsWith("/")) {
            baseDir = baseDir + "/";
        }

        if (outputDir == null) {
            outputDir = "cukedoctor/";
        }

        if (!outputDir.endsWith("/")) {
            outputDir = outputDir + "/";
        }

        return baseDir + outputDir;

    }

    public String getGeneratedFile() {
        return generatedFile;
    }
}