org.jboss.maven.plugins.qstools.fixers.FileHeaderFixer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-qstools-plugin

This a Maven Plugin that helps JBoss Developer quickstarts maintenance. You can use it to verify if your project/quickstart follow the JBoss Developer Guidelines. It will run all JBoss Developer Guideline checkers and generate a report that provides information about any violations that your project/quickstarts has.

There is a newer version: 1.4.1.Final

Show newest version

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2013, Red Hat, Inc. and/or its affiliates, and individual
 * contributors by the @authors tag. See the copyright.txt in the
 * distribution for a full listing of individual 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.jboss.maven.plugins.qstools.fixers;

import static org.twdata.maven.mojoexecutor.MojoExecutor.*;

import java.util.ArrayList;
import java.util.List;

import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.BuildPluginManager;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.annotations.Requirement;
import org.codehaus.plexus.context.Context;
import org.jboss.maven.plugins.qstools.Constants;
import org.jboss.maven.plugins.qstools.QSFixer;
import org.jboss.maven.plugins.qstools.QSCheckerException;
import org.jboss.maven.plugins.qstools.checkers.FileHeaderChecker;
import org.jboss.maven.plugins.qstools.config.ConfigurationProvider;
import org.jboss.maven.plugins.qstools.config.Rules;

/**
 * Fixer for {@link FileHeaderChecker}
 * 
 * @author rafaelbenevides
 * 
 */
@Component(role = QSFixer.class, hint = "FileHeaderFixer")
public class FileHeaderFixer implements QSFixer {

    private BuildPluginManager pluginManager;

    @Requirement
    private Context context;

    @Requirement
    private ConfigurationProvider configurationProvider;

    @Override
    public String getFixerDescription() {
        return "Fix the license header on all files";
    }

    @Override
    public void fix(MavenProject project, MavenSession mavenSession, List reactorProjects, Log log)
        throws QSCheckerException {
        Rules rules = configurationProvider.getQuickstartsRules(project.getGroupId());
        // Execute License-Maven-Plugin - http://code.mycila.com/license-maven-plugin/reports/2.3/format-mojo.html
        try {
            // Get Excluded files
            List excludes = new ArrayList();
            for (String exclude : rules.getExcludesArray()) {
                excludes.add(element("exclude", exclude));
            }
            for (String exclude : rules.getFixerSpecificExcludesArray(this)) {
                excludes.add(element("exclude", exclude));
            }
            List includes = new ArrayList();

            // Get includes extensions
            String[] includesExtensions = new String[] {
                "**/*.xml",
                "**/*.xsd",
                "**/*.java",
                "**/*.js",
                "**/*.properties",
                "**/*.html",
                "**/*.xhtml",
                "**/*.sql",
                "**/*.css" };

            for (String include : includesExtensions) {
                includes.add(element("include", include));
            }

            pluginManager = (BuildPluginManager) context.get(Constants.PLUGIN_MANAGER);
            executeMojo(plugin(groupId("com.mycila"), artifactId("license-maven-plugin"), version("2.5")),
                goal("format"),
                configuration(element(name("header"), rules.getLicenseFileLocation()),
                    element(name("aggregate"), "true"),
                    element(name("strictCheck"), "true"),
                    element(name("encoding"), "utf-8"),
                    element(name("headerDefinitions"), element(name("headerDefinition"), rules.getHeaderDefinitionLocation())),
                    element(name("includes"), includes.toArray(new Element[] {})),
                    element(name("excludes"), excludes.toArray(new Element[] {}))),
                executionEnvironment(project, mavenSession, pluginManager));
        } catch (Exception e) {
            throw new QSCheckerException(e);
        }

    }

    @Override
    public int order() {
        return 0;
    }

}