CompilationReportRenderer.java

package org.codehaus.mojo.gwt.reports;

/*
 * 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 java.util.List;
import java.util.Locale;

import org.apache.commons.lang.StringUtils;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.reporting.AbstractMavenReportRenderer;
import org.codehaus.mojo.gwt.GwtModule;
import org.codehaus.plexus.i18n.I18N;

/**
 * project compilation report renderer to display links to 
 * all modules report
 * @author <a href="mailto:olamy@apache.org">Olivier Lamy</a>
 * @since 2.1.0-1
 */
public class CompilationReportRenderer
    extends AbstractMavenReportRenderer
{
    private final List<GwtModule> gwtModules;
    
    private final Log log;
    
    private boolean reportsAvailable;
    
    private String compilerReportsPath;
    
    private boolean compilerReport;
    
    private final I18N i18n;
    
    private final Locale locale;
    
    public CompilationReportRenderer( final Sink sink, final List<GwtModule> gwtModules, Log log,
                                      boolean reportsAvailable, String compilerReportsPath, boolean compilerReport,
                                      I18N i18n, Locale locale )
    {
        super( sink );

        this.gwtModules = gwtModules;
        this.log = log;
        this.reportsAvailable = reportsAvailable;
        this.compilerReportsPath = compilerReportsPath;
        this.compilerReport = compilerReport;
        this.i18n = i18n;
        this.locale = locale;
    }

    /**
     * @see org.apache.maven.reporting.AbstractMavenReportRenderer#getTitle()
     */
    @Override
    public String getTitle()
    {
        // TODO i18n
        return "GWT Compilation Reports";
    }

    /**
     * @see org.apache.maven.reporting.AbstractMavenReportRenderer#renderBody()
     */
    @Override
    protected void renderBody()
    {
        // TODO i18n and message for none
        log.debug( "start renderBody" );
        startSection( getI18nString( locale, "compiler.report.section.title" ) );
        // display a specific warning message for SoycDashboard Report
        if ( !compilerReport )
        {
            sink.paragraph();
            sink.bold();
            sink.text( getI18nString( locale, "soyc.report.warning" ) );
            sink.bold_();
            sink.paragraph_();

        }
        if ( !this.reportsAvailable )
        {
            sink.paragraph();
            sink.bold();
            if ( compilerReport )
            {
                sink.text( getI18nString( locale, "compiler.report.none.warning" ) );
            }
            else
            {
                sink.text( getI18nString( locale, "compiler.report.soyc.warning" ) );
            }
            sink.bold_();
            sink.paragraph_();
        }
        else
        {
            sink.list();
            for ( GwtModule gwtModule : this.gwtModules )
            {
                sink.listItem();
                if ( StringUtils.isNotBlank( compilerReportsPath ) )
                {
                    sink.link( "./" + compilerReportsPath + "/" + gwtModule.getPath() + "/index.html" );
                }
                else
                {
                    sink.link( "./" + gwtModule.getPath() + "/index.html" );
                }
                sink.text( gwtModule.getName() );
                sink.link_();
                sink.listItem_();
            }
            sink.list_();
        }
        endSection();
        log.debug( "end renderBody" );
    }
    
    protected String getI18nString( Locale locale, String key )
    {
        return i18n.getString( "compile-report", locale, key );
    }
}