org.ops4j.ramler.maven.HtmlMojo Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016 OPS4J Contributors
 *
 * 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 org.ops4j.ramler.maven;

import java.io.File;
import java.io.IOException;

import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.ops4j.ramler.common.exc.Exceptions;
import org.ops4j.ramler.common.exc.RamlerException;
import org.ops4j.ramler.html.HtmlConfiguration;
import org.ops4j.ramler.html.HtmlGenerator;

/**
 * Generates HTML documentation from a RAML model.
 *
 * @author Harald Wellmann
 *
 */
@Mojo(name = "html", defaultPhase = LifecyclePhase.GENERATE_RESOURCES)
public class HtmlMojo extends AbstractRamlerMojo {

    /**
     * Output directory for generated HTML and other web resources.
     */
    @Parameter(defaultValue = "${project.build.directory}/ramler/html")
    private File outputDir;

    /**
     * Directory with web resources to be used instead of the built-in resources.
     */
    @Parameter
    private File webResourceDir;

    /**
     * Directory with Trimou templates which take precedence over the built-in templates. The entry
     * template is named {@code api.trimou.html}.
     */
    @Parameter
    private File templateDir;

    @Override
    protected void generateOutput() throws MojoFailureException {
        getLog().info("Generating HTML documentation from " + model);
        String sourceFile = new File(project.getBasedir(), model).getPath();

        HtmlConfiguration config = new HtmlConfiguration();
        config.setSourceFile(sourceFile);
        config.setTargetDir(getOutputDir().getAbsolutePath());
        if (templateDir != null) {
            config.setTemplateDir(templateDir.getAbsolutePath());
        }
        if (webResourceDir != null) {
            config.setWebResourceDir(webResourceDir.getAbsolutePath());
        }

        HtmlGenerator generator = new HtmlGenerator(config);
        try {
            generator.generate();
        }
        catch (RamlerException exc) {
            throw new MojoFailureException("HTML generation failed", exc);
        }
        catch (IOException exc) {
            throw Exceptions.unchecked(exc);
        }
    }

    @Override
    public File getOutputDir() {
        return outputDir;
    }
}