pl.allegro.tdr.gruntmaven.CreateResourcesMojo Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013 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 pl.allegro.tdr.gruntmaven;

import java.io.File;
import java.util.ArrayList;
import java.util.List;
import org.apache.maven.plugin.MojoExecutionException;
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 pl.allegro.tdr.gruntmaven.resources.Resource;
import static org.twdata.maven.mojoexecutor.MojoExecutor.*;

/**
 * MOJO executing maven-resources-plugin to create target/{jsTargetDir} directory containing all statics.
 *
 * @author Adam Dubiel
 */
@Mojo(name = "create-resources", defaultPhase = LifecyclePhase.GENERATE_SOURCES, threadSafe = true)
public class CreateResourcesMojo extends BaseMavenGruntMojo {

    private static final String INNER_PROPERTIES_RESOURCE_NAME = "grunt-maven.json";

    private static final int FILTERED_RESOURCES_JSON_LENGTH = 100;

    /**
     * Resources plugin groupId.
     */
    private static final String RESOURCES_MAVEN_GROUP = "org.apache.maven.plugins";

    /**
     * Reosurces plugin artefactId.
     */
    private static final String RESOURCES_MAVEN_ARTIFACT = "maven-resources-plugin";

    /**
     * Resources plugin version.
     */
    private static final String RESOURCES_GOAL = "copy-resources";

    /**
     * Change resources plugin version if needed, defaults to 2.6.
     */
    @Parameter(property = "mavenResourcesPluginVersion", defaultValue = "2.6")
    private String mavenResourcesPluginVersion;

    /**
     * Should copy-resources plugin overwrite resources even if target has newer version (see maven-resources-plugin documentation for more
     * details), defaults to true.
     */
    @Parameter(property = "overwriteResources", defaultValue = "true")
    private boolean overwriteResources;

    /**
     * Name of resources that should be filtered by Maven. When using integrated workflow, be sure to make Grunt ignore there resources, as
     * it will overwrite filtered values.
     */
    @Parameter(property = "filteredResources")
    private String[] filteredResources;

    /**
     * Resources that should not be copied during create-resources phase.
     */
    @Parameter(property = "excludedResources")
    private String[] excludedResources;

    @Override
    public void executeInternal() throws MojoExecutionException, MojoFailureException {
        executeMojo(plugin(
                groupId(RESOURCES_MAVEN_GROUP),
                artifactId(RESOURCES_MAVEN_ARTIFACT),
                version(mavenResourcesPluginVersion)),
                goal(RESOURCES_GOAL),
                configuration(
                        element(name("overwrite"), Boolean.toString(overwriteResources)),
                        element(name("outputDirectory"), gruntBuildDirectory),
                        element(name("resources"), createResourceElements())
                ),
                pluginExecutionEnvironment());

        createWorkflowTasksDirectory();
        createInnerPropertiesResource();
    }

    private Element[] createResourceElements() {
        List resourceElements = new ArrayList(2);

        Element normalResourcesElement = element(name("resource"),
                element(name("directory"), sourceDirectory + "/" + jsSourceDirectory),
                element(name("includes"),
                        element(name("include"), "**/*")
                ),
                element(name("excludes"),
                        createResourcesListElement(excludedResources, "exclude", element(name("exclude"), "**/" + npmOfflineModulesFile))
                ),
                element(name("filtering"), "false")
        );
        resourceElements.add(normalResourcesElement);

        if (filteredResources.length > 0) {
            Element filteredResourcesElement = element(name("resource"),
                    element(name("directory"), sourceDirectory + "/" + jsSourceDirectory),
                    element(name("includes"), createResourcesListElement(filteredResources, "include")),
                    element(name("filtering"), "true")
            );
            resourceElements.add(filteredResourcesElement);
        }

        return resourceElements.toArray(new Element[resourceElements.size()]);
    }

    private void createWorkflowTasksDirectory() {
        File file = new File(pathToWorkflowTasksDirectory());
        if (!file.exists()) {
            file.mkdirs();
        }
    }

    private Element[] createResourcesListElement(String[] resources, String elementName, Element... append) {
        Element[] elements = new Element[resources.length + append.length];

        int index = 0;
        for (; index < resources.length; ++index) {
            elements[index] = element(name(elementName), resources[index]);
        }
        for (int appendIndex = 0; appendIndex < append.length; appendIndex++, ++index) {
            elements[index] = append[appendIndex];
        }

        return elements;
    }

    private void createInnerPropertiesResource() {
        Resource.from("/" + INNER_PROPERTIES_RESOURCE_NAME, getLog())
                .withFilter("filesToWatch", pathToWatchDirectory() + File.separator + "**")
                .withFilter("directoryToWatch", pathToWatchDirectory())
                .withFilter("projectRootPath", basedir())
                .withFilter("targetPath", target())
                .withFilter("sourceDirectory", sourceDirectory)
                .withFilter("jsSourceDirectory", jsSourceDirectory)
                .withFilter("warTargetDirectory", warTargetDirectory)
                .withFilter("filteredFiles", filteredResourcesAsJSONArray())
                .copyAndOverwrite(pathToWorkflowTasksDirectory() + INNER_PROPERTIES_RESOURCE_NAME);
    }

    private String filteredResourcesAsJSONArray() {
        StringBuilder builder = new StringBuilder(FILTERED_RESOURCES_JSON_LENGTH);
        builder.append("[");

        builder.append("\"").append("**/").append(npmOfflineModulesFile).append("\"").append(", ");
        for (int index = 0; index < filteredResources.length; ++index) {
            builder.append("\"").append(filteredResources[index]).append("\"").append(", ");
        }
        for (int index = 0; index < excludedResources.length; ++index) {
            builder.append("\"").append(excludedResources[index]).append("\"").append(", ");
        }
        builder.delete(builder.length() - 2, builder.length());

        builder.append("]");
        return builder.toString();
    }

    private String pathToWatchDirectory() {
        return fullJsSourceDirectory();
    }

    private String pathToWorkflowTasksDirectory() {
        return pathToGruntBuildDirectory() + File.separator;
    }

    private String pathToGruntBuildDirectory() {
        return gruntBuildDirectory + File.separator;
    }
}