org.codehaus.gmavenplus.mojo.AbstractGroovySourcesMojo Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013 the original author or authors.
 *
 * 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.codehaus.gmavenplus.mojo;

import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.shared.model.fileset.FileSet;
import org.apache.maven.shared.model.fileset.util.FileSetManager;

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

import static java.util.Collections.singletonList;


/**
 * This mojo provides access to the Groovy sources.
 *
 * @author Keegan Witt
 * @since 1.0-beta-2
 */
public abstract class AbstractGroovySourcesMojo extends AbstractGroovyMojo {

    /**
     * Main source directory name.
     */
    protected static final String MAIN = "main";

    /**
     * Test source directory name.
     */
    protected static final String TEST = "test";

    /**
     * The Groovy source files (relative paths).
     * Default: "${project.basedir}/src/main/groovy/**/*.groovy"
     */
    @Parameter
    protected FileSet[] sources;

    /**
     * The Groovy test source files (relative paths).
     * Default: "${project.basedir}/src/test/groovy/**/*.groovy"
     */
    @Parameter
    protected FileSet[] testSources;


    /**
     * Flag to allow test compilation/GroovyDoc/stub generation to be skipped.
     */
    @Parameter(property = "maven.test.skip", defaultValue = "false")
    protected boolean skipTests;

    /**
     * Whether to use a shared classloader that includes both the project classpath and plugin classpath.
     * Use only if you know what you're doing.
     *
     * @since 1.6.3
     */
    @Parameter(defaultValue = "false")
    protected boolean useSharedClassLoader;

    /**
     * Gets the filesets of the the main sources.
     *
     * @param includeJavaSources Whether to include Java sources
     * @return The filesets of the the main sources
     */
    protected FileSet[] getSourceRoots(final boolean includeJavaSources) {
        return getFilesets(sources, MAIN, includeJavaSources);
    }

    /**
     * Gets the filesets of the the main sources (not including Java sources).
     *
     * @return The filesets of the the main sources
     */
    protected FileSet[] getSourceRoots() {
        return getFilesets(sources, MAIN, false);
    }

    /**
     * Gets the set of files of the the main sources.
     *
     * @param includeJavaSources Whether to include Java sources
     * @return The set of files of the the main sources
     */
    protected Set getSources(final boolean includeJavaSources) {
        return getFiles(sources, MAIN, includeJavaSources);
    }

    /**
     * Gets the set of files of the the main sources (not including Java sources).
     *
     * @return The set of files of the the main sources
     */
    protected Set getSources() {
        return getFiles(sources, MAIN, false);
    }

    /**
     * Gets the filesets of the test sources.
     *
     * @param includeJavaSources Whether to include Java sources
     * @return The filesets of the test sources
     */
    protected FileSet[] getTestSourceRoots(final boolean includeJavaSources) {
        return getFilesets(testSources, TEST, includeJavaSources);
    }

    /**
     * Gets the filesets of the test sources (not including Java sources).
     *
     * @return The filesets of the test sources
     */
    protected FileSet[] getTestSourceRoots() {
        return getFilesets(testSources, TEST, false);
    }

    /**
     * Gets the set of files of the test sources.
     *
     * @param includeJavaSources Whether to include Java sources
     * @return The set of files of the test sources
     */
    protected Set getTestSources(final boolean includeJavaSources) {
        return getFiles(testSources, TEST, includeJavaSources);
    }

    /**
     * Gets the set of files of the test sources (not including Java sources).
     *
     * @return The set of files of the test sources
     */
    protected Set getTestSources() {
        return getFiles(testSources, TEST, false);
    }

    /**
     * Gets the set of included files from the specified source files or source directory (if sources are null).
     *
     * @param fromSources The sources to get the included files from
     * @param defaultSourceDirectory The source directory to fall back on if sources are null
     * @param includeJavaSources Whether to include Java sources
     * @return The included files from the specified sources
     */
    protected Set getFiles(final FileSet[] fromSources, final String defaultSourceDirectory, final boolean includeJavaSources) {
        Set files = new HashSet();
        FileSetManager fileSetManager = new FileSetManager(getLog());

        for (FileSet fileSet : getFilesets(fromSources, defaultSourceDirectory, includeJavaSources)) {
            for (String include : fileSetManager.getIncludedFiles(fileSet)) {
                files.add(new File(fileSet.getDirectory(), include));
            }
        }

        return files;
    }

    /**
     * Gets the set of included filesets from the specified source files or source directory (if sources are null).
     *
     * @param fromSources The sources to get the included files from
     * @param defaultSubDirectory The source subdirectory to fall back on if sources are null
     * @param includeJavaSources Whether to include Java sources
     * @return The included filesets from the specified sources
     */
    protected FileSet[] getFilesets(final FileSet[] fromSources, final String defaultSubDirectory, final boolean includeJavaSources) {
        FileSet[] result;
        FileSet[] groovyFileSets;

        if (fromSources != null) {
            groovyFileSets = fromSources;
        } else {
            FileSet groovyFileSet = new FileSet();
            String groovyDirectory = "src" + File.separator + defaultSubDirectory + File.separator + "groovy";
            groovyFileSet.setDirectory(project.getBasedir() + File.separator + groovyDirectory);
            groovyFileSet.setIncludes(singletonList(GROOVY_SOURCES_PATTERN));
            groovyFileSets = new FileSet[] {groovyFileSet};
        }

        if (includeJavaSources) {
            List javaFileSets = new ArrayList();
            if (TEST.equals(defaultSubDirectory)) {
                for (Object sourceRoot : project.getTestCompileSourceRoots()) {
                    FileSet javaFileSet = new FileSet();
                    javaFileSet.setDirectory((String) sourceRoot);
                    javaFileSet.setIncludes(singletonList(JAVA_SOURCES_PATTERN));
                    javaFileSets.add(javaFileSet);
                }
            } else {
                for (Object sourceRoot : project.getCompileSourceRoots()) {
                    FileSet javaFileSet = new FileSet();
                    javaFileSet.setDirectory((String) sourceRoot);
                    javaFileSet.setIncludes(singletonList(JAVA_SOURCES_PATTERN));
                    javaFileSets.add(javaFileSet);
                }
            }
            FileSet[] javaFileSetsArr = javaFileSets.toArray(new FileSet[0]);
            result = Arrays.copyOf(groovyFileSets, groovyFileSets.length + javaFileSetsArr.length);
            System.arraycopy(javaFileSetsArr, 0, result, groovyFileSets.length, javaFileSetsArr.length);
        } else {
            result = groovyFileSets;
        }

        return result;
    }

}