com.buschmais.jqassistant.scm.maven.ProjectResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jqassistant-maven-plugin Show documentation
There is a newer version: 1.1.4
Show newest version
package com.buschmais.jqassistant.scm.maven;

import java.io.File;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.project.MavenProject;

/**
 * Resolver for root modules in a multi-module hierarchy.
 */
public final class ProjectResolver {

    /**
     * The name of the rules directory.
     */
    public static final String DEFAULT_RULES_DIRECTORY = "jqassistant";

    /**
     * The name of the rules directory.
     */
    public static final String OUTPUT_DIRECTORY = "jqassistant";

    /**
     * Private constructor.
     */
    private ProjectResolver() {
    }

    /**
     * Return the {@link MavenProject} which is the base module for scanning and
     * analysis.
     * 
     * The base module is by searching with the module tree starting from the
     * current module over its parents until a module is found containing a
     * directory "jqassistant" or no parent can be determined.
     * 
     * 
     * @param module
     *            The current module.
     * @param rulesDirectory
     *            The name of the directory used for identifying the root module
     * @return The {@link MavenProject} containing a rules directory.
     * @throws MojoExecutionException
     *             If the directory cannot be resolved.
     */
    static MavenProject getRootModule(MavenProject module, String rulesDirectory) throws MojoExecutionException {
        String rootModuleContextKey = ProjectResolver.class.getName() + "#rootModule";
        MavenProject rootModule = (MavenProject) module.getContextValue(rootModuleContextKey);
        if (rootModule == null) {
            File directory = getRulesDirectory(module, rulesDirectory);
            if (directory.exists() && directory.isDirectory()) {
                rootModule = module;
            } else {
                MavenProject parent = module.getParent();
                if (parent != null && parent.getBasedir() != null) {
                    rootModule = getRootModule(parent, rulesDirectory);
                } else {
                    rootModule = module;
                }
            }
            module.setContextValue(rootModuleContextKey, rootModule);
        }
        return rootModule;
    }

    /**
     * Returns the directory containing rules.
     * 
     * @param rootModule
     *            The root module of the project.
     * @param rulesDirectory
     *            The name of the directory used for identifying the root
     *            module.
     * @return The file representing the directory.
     */
    static File getRulesDirectory(MavenProject rootModule, String rulesDirectory) {
        File rules = new File(rulesDirectory);
        return rules.isAbsolute() ? rules : new File(rootModule.getBasedir().getAbsolutePath() + File.separator + rulesDirectory);
    }

    /**
     * Determines the directory for writing output files.
     * 
     * @param rootModule
     *            The root module of the project.
     * @return The report directory.
     */
    static File getOutputDirectory(MavenProject rootModule) {
        String directoryName = rootModule.getBuild().getDirectory() + "/" + OUTPUT_DIRECTORY;
        File directory = new File(directoryName);
        directory.mkdirs();
        return directory;
    }

    /**
     * Determines a report file name.
     * 
     * @param rootModule
     *            The base project.
     * @param reportFile
     *            The report file as specified in the pom.xml file or on the
     *            command line.
     * @return The resolved {@link java.io.File}.
     * @throws MojoExecutionException
     *             If the file cannot be determined.
     */
    static File getOutputFile(MavenProject rootModule, File reportFile, String defaultFile) throws MojoExecutionException {
        File selectedXmlReportFile;
        if (reportFile != null) {
            selectedXmlReportFile = reportFile;
        } else if (rootModule != null) {
            selectedXmlReportFile = new File(getOutputDirectory(rootModule) + "/" + defaultFile);
        } else {
            throw new MojoExecutionException("Cannot determine report file.");
        }
        return selectedXmlReportFile;
    }

}