com.google.code.play2.plugin.Play2TemplateCompileMojo 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-2014 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 java.util.List;

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.Play2TemplateCompiler;
import com.google.code.play2.provider.api.TemplateCompilationException;

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

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

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

    private static final String targetDirectoryName = "src_managed/main";

    private static final String[] scalaTemplatesIncludes = new String[] { "**/*.scala.*" };

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

        File targetDirectory = new File( project.getBuild().getDirectory() );
        File generatedDirectory = new File( targetDirectory, targetDirectoryName );

        List compileSourceRoots = project.getCompileSourceRoots();
        int processedFiles = 0;
        int compiledFiles = 0;

        Play2Provider play2Provider = getProvider();
        Play2TemplateCompiler compiler = play2Provider.getTemplatesCompiler();
        compiler.setOutputDirectory( generatedDirectory );
        compiler.setMainLang( mainLang );

        for ( String sourceRoot : compileSourceRoots )
        {
            File sourceRootDirectory = new File( sourceRoot );
            if ( sourceRootDirectory.isDirectory()
                && !sourceRootDirectory.getAbsolutePath().equals( generatedDirectory.getAbsolutePath() ) )
            {
                DirectoryScanner scanner = new DirectoryScanner();
                scanner.setBasedir( sourceRootDirectory );
                scanner.setIncludes( scalaTemplatesIncludes );
                scanner.addDefaultExcludes();
                scanner.scan();
                String[] files = scanner.getIncludedFiles();

                if ( files.length > 0 )
                {
                    compiler.setSourceDirectory( sourceRootDirectory );

                    for ( String fileName : files )
                    {
                        File templateFile = new File( sourceRootDirectory, fileName );
                        try
                        {
                            File generatedFile = compiler.compile( templateFile );
                            processedFiles++;
                            if ( generatedFile != null )
                            {
                                compiledFiles++;
                                getLog().debug( String.format( "\"%s\" processed", fileName ) );
                                buildContext.refresh( generatedFile );
                            }
                            else
                            {
                                getLog().debug( String.format( "\"%s\" skipped - no changes", fileName ) );
                            }
                        }
                        catch ( TemplateCompilationException e )
                        {
                            throw new MojoExecutionException( String.format( "Template compilation failed (%s)",
                                                                             templateFile.getPath() ), e );
                        }
                    }
                }
            }
        }

        if ( processedFiles > 0 )
        {
            getLog().info( String.format( "%d templates processed, %d compiled", Integer.valueOf( processedFiles ),
                                          Integer.valueOf( compiledFiles ) ) );
            if ( !compileSourceRoots.contains( generatedDirectory.getAbsolutePath() ) )
            {
                project.addCompileSourceRoot( generatedDirectory.getAbsolutePath() );
                getLog().debug( "Added source directory: " + generatedDirectory.getAbsolutePath() );
            }
        }
        else
        {
            getLog().info( "No templates to compile" );
        }

    }

}