SummaryReport.java

package org.apache.maven.report.projectinfo;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.model.DistributionManagement;
import org.apache.maven.model.Organization;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.project.MavenProject;
import org.apache.maven.reporting.MavenReportException;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.xml.Xpp3Dom;

import java.io.File;
import java.io.IOException;
import java.util.Locale;

/**
 * Generates the Project Summary report.
 *
 * @author Edwin Punzalan
 * @version $Id$
 * @since 2.0
 */
@Mojo( name = "summary" )
public class SummaryReport
    extends AbstractProjectInfoReport
{
    // ----------------------------------------------------------------------
    // Mojo parameters
    // ----------------------------------------------------------------------

    // ----------------------------------------------------------------------
    // Public methods
    // ----------------------------------------------------------------------

    @Override
    protected void executeReport( Locale locale )
        throws MavenReportException
    {
        new ProjectSummaryRenderer( getSink(), locale ).render();
    }

    /** {@inheritDoc} */
    public String getOutputName()
    {
        return "project-summary";
    }

    @Override
    protected String getI18Nsection()
    {
        return "summary";
    }

    // ----------------------------------------------------------------------
    // Private
    // ----------------------------------------------------------------------

    /**
     * Internal renderer class
     */
    private class ProjectSummaryRenderer
        extends AbstractProjectInfoRenderer
    {
        ProjectSummaryRenderer( Sink sink, Locale locale )
        {
            super( sink, getI18N( locale ), locale );
        }

        @Override
        protected String getI18Nsection()
        {
            return "summary";
        }

        @Override
        protected void renderBody()
        {
            startSection( getTitle() );

            // general information sub-section
            startSection( getI18nString( "general.title" ) );
            startTable();
            tableHeader( new String[] { getI18nString( "field" ), getI18nString( "value" ) } );
            tableRow( new String[] { getI18nString( "general.name" ), project.getName() } );
            tableRow( new String[] { getI18nString( "general.description" ), project.getDescription() } );
            tableRowWithLink( new String[] { getI18nString( "general.homepage" ), project.getUrl() } );
            endTable();
            endSection();

            // organization sub-section
            startSection( getI18nString( "organization.title" ) );
            Organization organization = project.getOrganization();
            if ( organization == null )
            {
                paragraph( getI18nString( "noorganization" ) );
            }
            else
            {
                startTable();
                tableHeader( new String[] { getI18nString( "field" ), getI18nString( "value" ) } );
                tableRow( new String[] { getI18nString( "organization.name" ), organization.getName() } );
                tableRowWithLink( new String[] { getI18nString( "organization.url" ), organization.getUrl() } );
                endTable();
            }
            endSection();

            // build section
            startSection( getI18nString( "build.title" ) );
            startTable();
            tableHeader( new String[] { getI18nString( "field" ), getI18nString( "value" ) } );
            tableRow( new String[] { getI18nString( "build.groupid" ), project.getGroupId() } );
            tableRow( new String[] { getI18nString( "build.artifactid" ), project.getArtifactId() } );
            tableRow( new String[] { getI18nString( "build.version" ), project.getVersion() } );
            tableRow( new String[] { getI18nString( "build.type" ), project.getPackaging() } );
            if ( isJavaProject( project ) )
            {
                tableRow( new String[] { getI18nString( "build.javaVersion" ), getMinimumJavaVersion() } );
            }
            endTable();
            endSection();

            // download section
            DistributionManagement distributionManagement = project.getDistributionManagement();
            if ( distributionManagement != null )
            {
                if ( StringUtils.isNotEmpty( distributionManagement.getDownloadUrl() ) )
                {
                    startSection( getI18nString( "download" ) );
                    link( distributionManagement.getDownloadUrl(), distributionManagement.getDownloadUrl() );
                    endSection();
                }
            }

            endSection();
        }

        private String getMinimumJavaVersion()
        {

            final String pluginId = "org.apache.maven.plugins:maven-compiler-plugin";
            String sourceConfigured = getPluginParameter( pluginId, "source" );
            String targetConfigured = getPluginParameter( pluginId, "target" );

            String forkFlag = getPluginParameter( pluginId, "fork" );
            String compilerVersionConfigured = null;
            if ( "true".equalsIgnoreCase( forkFlag ) )
            {
                compilerVersionConfigured = getPluginParameter( pluginId, "compilerVersion" );
            }

            String minimumJavaVersion = compilerVersionConfigured;
            if ( targetConfigured != null )
            {
                minimumJavaVersion = targetConfigured;
            }
            else if ( sourceConfigured != null )
            {
                minimumJavaVersion = sourceConfigured;
            }
            else
            {
                // ${maven.compiler.target} default value
                minimumJavaVersion = project.getProperties().getProperty( "maven.compiler.target" );

                // default to 1.5 if not set?
            }

            return minimumJavaVersion;
        }

        private void tableRowWithLink( String[] content )
        {
            sink.tableRow();

            for ( int ctr = 0; ctr < content.length; ctr++ )
            {
                String cell = content[ctr];

                sink.tableCell();

                if ( StringUtils.isEmpty( cell ) )
                {
                    sink.text( "-" );
                }
                else if ( ctr == content.length - 1 && cell.length() > 0 )
                {
                    sink.link( cell );
                    sink.text( cell );
                    sink.link_();
                }
                else
                {
                    sink.text( cell );
                }
                sink.tableCell_();
            }

            sink.tableRow_();
        }

        /**
         * @param project not null
         * @return return <code>true</code> if the Maven project sounds like a Java Project, i.e. has a java type
         *         packaging (like jar, war...) or java files in the source directory, <code>false</code> otherwise.
         * @since 2.3
         */
        private boolean isJavaProject( MavenProject project )
        {
            String packaging = project.getPackaging().trim().toLowerCase( Locale.ENGLISH );
            if ( packaging.equals( "pom" ) )
            {
                return false;
            }

            // some commons java packaging
            if ( packaging.equals( "jar" ) || packaging.equals( "ear" ) || packaging.equals( "war" )
                || packaging.equals( "rar" ) || packaging.equals( "sar" ) || packaging.equals( "har" )
                || packaging.equals( "par" ) || packaging.equals( "ejb" ) )
            {
                return true;
            }

            // java files in the source directory?
            final File sourceDir = new File( project.getBuild().getSourceDirectory() );
            if ( sourceDir.exists() )
            {
                try
                {
                    if ( FileUtils.getFileNames( sourceDir, "**/*.java", null, false ).size() > 0 )
                    {
                        return true;
                    }
                }
                catch ( IOException e )
                {
                    //ignored
                }
            }

            // maven-compiler-plugin ?
            Xpp3Dom pluginConfig =
                project.getGoalConfiguration( "org.apache.maven.plugins", "maven-compiler-plugin", null, null );
            if ( pluginConfig != null )
            {
                return true;
            }

            return false;
        }
    }
}