/*
    * Copyright 2009-2012 smartics, Kronseder & Reiner GmbH
    *
    * 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 de.smartics.maven.apidoc;
  
  import java.text.MessageFormat;
  import java.util.List;
  import java.util.ResourceBundle;
  
  import org.apache.maven.doxia.sink.Sink;
  import org.apache.maven.reporting.AbstractMavenReportRenderer;
  import org.codehaus.plexus.util.StringUtils;
  
  import de.smartics.analysis.javadoc.log.JavadocMessageLogger;
  import de.smartics.analysis.javadoc.log.message.IssueLocation;
  import de.smartics.analysis.javadoc.log.message.IssueMessage;
  
  /**
   * Renders the Javadoc tool messages to a Maven report.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  public class JavadocMessageReportRenderer extends AbstractMavenReportRenderer
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The configuration to control the report rendering.
     */
    private final JavadocMessageConfig messageConfig;
  
    /**
     * The helper that contains the filtered messages.
     */
    private final MessageHelper helper;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param sink the sink to write to.
     * @param messageConfig the configuration to control the report rendering.
     * @param logger the information to render to the report.
     */
    public JavadocMessageReportRenderer(final Sink sink,
        final JavadocMessageConfig messageConfig,
        final JavadocMessageLogger logger)
    {
      super(sink);
      this.messageConfig = messageConfig;
      this.helper = new MessageHelper(messageConfig, logger);
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    /**
     * {@inheritDoc}
     *
     * @see org.apache.maven.reporting.AbstractMavenReportRenderer#getTitle()
     */
    @Override
    public String getTitle()
    {
      return "Javadoc Message Report";
    }
  
    /**
     * {@inheritDoc}
     *
     * @see org.apache.maven.reporting.AbstractMavenReportRenderer#renderBody()
     */
   @Override
   protected void renderBody()
   {
     sink.section1();
 
     final boolean hasResults = helper.hasMessages();
     renderTitle(hasResults);
 
     if (hasResults)
     {
       writeBodyContent();
     }
 
     renderFooter();
     sink.section1_();
   }
 
   /**
    * Renders the title block of the report.
    *
    * @param hasResults <code>true</code> if the report renders results (at least
    *          one message issued by the Javadoc tool), <code>false</code>
    *          otherwise.
    */
   protected void renderTitle(final boolean hasResults)
   {
     sink.sectionTitle1();
     sink.text(getTitle());
     sink.sectionTitle1_();
     renderDescription(hasResults);
   }
 
   /**
    * Renders the description below the main title.
    *
    * @param hasResults <code>true</code> if the report renders results (at least
    *          one message issued by the Javadoc tool), <code>false</code>
    *          otherwise.
    */
   private void renderDescription(final boolean hasResults)
   {
     final String description =
         hasResults ? getDescription() : getNoResultsDescription();
     if (StringUtils.isNotBlank(description))
     {
       sink.paragraph();
       sink.text(description);
       sink.paragraph_();
     }
   }
 
   /**
    * Returns the description to be rendered if the Javadoc tool had no issues to
    * report.
    *
    * @return the description to render if no issue has been raised by the
    *         Javadoc tool.
    */
   private String getNoResultsDescription()
   {
     return messageConfig.getBundle().getString("report.noResultsDescription");
   }
 
   /**
    * Writes the content of the report.
    */
   private void writeBodyContent()
   {
     renderSubsection("report.subsection.errors", helper.getErrMessages());
     renderSubsection("report.subsection.warnings", helper.getWarnMessages());
     if (messageConfig.isNoticeMessagesRendered())
     {
       renderNotices("report.subsection.notices", helper.getNoticeMessages());
     }
   }
 
   /**
    * Renders a subsection with the given header message and messages.
    *
    * @param messageKey the key to the message rendered as header of the
    *          subsection.
    * @param messages the messages to be rendered in a table.
    */
   private void renderSubsection(final String messageKey,
       final List<IssueMessage> messages)
   {
     if (!messages.isEmpty())
     {
       final ResourceBundle bundle = messageConfig.getBundle();
 
       sink.section2();
       sink.sectionTitle2();
       sink.text(bundle.getString(messageKey));
       sink.sectionTitle2_();
       sink.paragraph();
       final String pattern = bundle.getString(messageKey + ".text");
       final String text = MessageFormat.format(pattern, messages.size());
       sink.text(text);
       sink.paragraph_();
 
       sink.table();
       renderTableHeader(bundle);
       for (IssueMessage message : messages)
       {
         renderRow(bundle, message);
       }
       sink.table_();
 
       sink.section2_();
     }
   }
 
   /**
    * Renders the table header.
    *
    * @param bundle the bundle to use.
    */
   private void renderTableHeader(final ResourceBundle bundle)
   {
     sink.tableRow();
     sink.tableHeaderCell();
     sink.text(bundle.getString("report.table.header.sourceFile"));
     sink.tableHeaderCell_();
     sink.tableHeaderCell();
     sink.text(bundle.getString("report.table.header.line"));
     sink.tableHeaderCell_();
     sink.tableHeaderCell();
     sink.text(bundle.getString("report.table.header.message"));
     sink.tableHeaderCell_();
     sink.tableRow_();
   }
 
   /**
    * Renders a row with the information from the message.
    *
    * @param bundle the bundle to fetch static texts from.
    * @param message the message information from the Javadoc tool to be
    *          rendered.
    */
   private void renderRow(final ResourceBundle bundle, final IssueMessage message)
   {
     final IssueMessageWrapper wrapper =
         new IssueMessageWrapper(messageConfig.getSourceRoots(),
             messageConfig.getXrefLocation(), message);
     sink.tableRow();
     renderClassNameColumn(bundle, wrapper);
     renderLineNumberColumn(bundle, wrapper);
     renderMessageColumn(message);
   }
 
   /**
    * Renders the cell containing the line number where the issue has been marked
    * by the Javadoc tool.
    *
    * @param bundle the bundle with labels to render.
    * @param wrapper the message wrapper to get access to the information to
    *          render.
    */
   private void renderLineNumberColumn(final ResourceBundle bundle,
       final IssueMessageWrapper wrapper)
   {
     sink.tableCell();
     final IssueLocation location = wrapper.getMessage().getLocation();
     if (location != null)
     {
       final String line = String.valueOf(location.getLine());
       final String link = wrapper.getXref() + '#' + line;
       sink.link(link);
       sink.text(line);
       sink.link_();
     }
     else
     {
       final String lineText = bundle.getString("report.table.line.none");
       sink.text(lineText);
     }
     sink.tableCell_();
   }
 
   /**
    * Renders the column containing the class name of the file an issue has been
    * marked by the Javadoc too.
    *
    * @param bundle the bundle with labels to render.
    * @param wrapper the message wrapper to get access to the information to
    *          render.
    */
   private void renderClassNameColumn(final ResourceBundle bundle,
       final IssueMessageWrapper wrapper)
   {
     sink.tableCell();
     final IssueLocation location = wrapper.getMessage().getLocation();
     if (location != null)
     {
       final String label = wrapper.getClassName();
       final String link = wrapper.getXref();
       sink.link(link);
       sink.text(label);
       sink.link_();
     }
     else
     {
       final String sourceText = bundle.getString("report.table.file.none");
       sink.text(sourceText);
     }
     sink.tableCell_();
   }
 
   /**
    * Renders the column containing the message issued by the Javadoc tool.
    *
    * @param message the message of the Javadoc tool.
    */
   private void renderMessageColumn(final IssueMessage message)
   {
     sink.tableCell();
     sink.text(message.getMessage());
     sink.tableCell_();
     sink.tableRow_();
   }
 
   /**
    * Renders a subsection with the given header message and messages.
    *
    * @param messageKey the key to the message rendered as header of the
    *          subsection.
    * @param messages the messages to be rendered in a table.
    */
   private void renderNotices(final String messageKey,
       final List<IssueMessage> messages)
   {
     if (!messages.isEmpty())
     {
       final ResourceBundle bundle = messageConfig.getBundle();
 
       sink.section2();
       sink.sectionTitle2();
       sink.text(bundle.getString(messageKey));
       sink.sectionTitle2_();
 
       sink.table();
       sink.tableRow();
       sink.tableHeaderCell();
       sink.text(bundle.getString("report.table.header.message"));
       sink.tableHeaderCell_();
       sink.tableRow_();
 
       for (IssueMessage message : messages)
       {
         sink.tableRow();
         renderMessageColumn(message);
       }
       sink.table_();
 
       sink.section2_();
     }
   }
 
   /**
    * Returns the description to be rendered in the header.
    *
    * @return the description of the report.
    */
   private String getDescription()
   {
     return messageConfig.getBundle().getString("report.resultsDescription");
   }
 
   /**
    * Renders the footer text.
    */
   protected void renderFooter()
   {
     final String footerText = messageConfig.getFooterText();
     if (StringUtils.isNotBlank(footerText))
     {
       sink.rawText(footerText);
     }
   }
 
   // --- object basics --------------------------------------------------------
 
 }