com.google.code.play2.plugin.Play2RoutesCompileMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of play2-maven-plugin Show documentation
Play! 2.x Maven Plugin
There is a newer version: 1.0.0-rc5
/*
 * Copyright 2013-2015 Grzegorz Slowikowski (gslowikowski at gmail dot com)
 *
 * 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 com.google.code.play2.plugin;

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

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

import org.codehaus.plexus.util.DirectoryScanner;

import org.sonatype.plexus.build.incremental.BuildContext;

import com.google.code.play2.provider.api.Play2Provider;
import com.google.code.play2.provider.api.Play2RoutesCompiler;
import com.google.code.play2.provider.api.RoutesCompilationException;

/**
 * Compile routes
 * 
 * @author Grzegorz Slowikowski
 * @since 1.0.0
 */
@Mojo( name = "routes-compile", defaultPhase = LifecyclePhase.GENERATE_SOURCES )
public class Play2RoutesCompileMojo
    extends AbstractPlay2Mojo
{

    /**
     * Main language ("scala" or "java").
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play2.mainLang", required = true, defaultValue = "scala" )
    private String mainLang;

    /**
     * The "conf" directory.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play2.confDirectory", readonly = true, defaultValue = "${project.basedir}/conf" )
    private File confDirectory;

    /**
     * Routes generator type ("static" or "injected").
     * 

     * 

     * Supported by Play! 2.4.x and later.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play2.routesGenerator", required = true, defaultValue = "static" )
    private String routesGenerator;

    /**
     * For M2E integration.
     */
    @Component
    private BuildContext buildContext;

    private static final String defaultTargetDirectoryName = "src_managed";

    private static final String[] routesIncludes = new String[] { "*.routes", "routes" };

    @Override
    protected void internalExecute()
        throws MojoExecutionException, MojoFailureException, IOException
    {
        if ( !"java".equals( mainLang ) && !"scala".equals( mainLang ) )
        {
            throw new MojoExecutionException(
                                              String.format( "Routes compilation failed  - unsupported  configuration parameter value \"%s\"",
                                                             mainLang ) );
        }

        if ( !confDirectory.isDirectory() )
        {
            getLog().info( "No routes to compile" );
            return;
        }

        DirectoryScanner scanner = new DirectoryScanner();
        scanner.setBasedir( confDirectory );
        scanner.setIncludes( routesIncludes );
        scanner.addDefaultExcludes();
        scanner.scan();
        String[] files = scanner.getIncludedFiles();

        if ( files.length == 0 )
        {
            getLog().debug( "No routes to compile" );
            return;
        }

        Play2Provider play2Provider = getProvider();
        Play2RoutesCompiler compiler = play2Provider.getRoutesCompiler();

        File targetDirectory = new File( project.getBuild().getDirectory() );
        String outputDirectoryName = compiler.getCustomOutputDirectoryName();
        if ( outputDirectoryName == null )
        {
            outputDirectoryName = defaultTargetDirectoryName;
        }
        File generatedDirectory = new File( targetDirectory, outputDirectoryName + "/main" );

        compiler.setMainLang( mainLang );
        compiler.setOutputDirectory( generatedDirectory );
        compiler.setGenerator( routesGenerator );
        String defaultNamespace = compiler.getDefaultNamespace();
        String mainRoutesFileName = compiler.getMainRoutesFileName();

        for ( String fileName : files )
        {
            File routesFile = new File( confDirectory, fileName );
            String generatedFileName = getGeneratedFileName( fileName, defaultNamespace, mainRoutesFileName );
            File generatedFile = new File( generatedDirectory, generatedFileName );
            boolean modified = true;
            if ( generatedFile.isFile() )
            {
                modified = ( generatedFile.lastModified() < routesFile.lastModified() );
            }

            if ( modified )
            {
                try
                {
                    compiler.compile( routesFile );
                    buildContextRefresh( generatedDirectory, generatedFileName );
                    getLog().debug( String.format( "\"%s\" processed", fileName ) );
                }
                catch ( RoutesCompilationException e )
                {
                    throw new MojoExecutionException( String.format( "Routes compilation failed (%s)",
                                                                     routesFile.getPath() ), e );
                }
            }
            else
            {
                getLog().debug( String.format( "\"%s\" skipped - no changes", fileName ) );
            }
        }

        if ( !project.getCompileSourceRoots().contains( generatedDirectory.getAbsolutePath() ) )
        {
            project.addCompileSourceRoot( generatedDirectory.getAbsolutePath() );
            getLog().debug( "Added source directory: " + generatedDirectory.getAbsolutePath() );
        }
    }

    private String getGeneratedFileName( String routesFileName, String defaultNamespace, String mainRoutesFileName )
    {
        String namespace = defaultNamespace;
        if ( routesFileName.endsWith( ".routes" ) )
        {
            namespace = routesFileName.substring( 0, routesFileName.length() - ".routes".length() );
        }

        String result = mainRoutesFileName;
        if ( namespace != null )
        {
            String packageDir = namespace.replace( '.', File.separatorChar );
            result = packageDir + File.separatorChar + result;
        }

        return result;
    }

    private void buildContextRefresh( File generatedDirectory, String generatedFileName )
    {
        File fileTargetDir = new File( generatedDirectory, generatedFileName ).getParentFile();
        File generatedFile = new File( fileTargetDir, "routes_routing.scala" );
        buildContext.refresh( generatedFile );
        generatedFile = new File( fileTargetDir, "routes_reverseRouting.scala" );
        if ( generatedFile.exists() )
        {
            buildContext.refresh( generatedFile );
        }
        generatedFile = new File( generatedDirectory, "controllers/routes.java" );
        buildContext.refresh( generatedFile );
    }

}