AbstractIssuesReportRenderer

/*
 * Copyright 2008-2013 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.issues.bugzilla;

import java.io.IOException;
import java.io.StringReader;
import java.util.List;
import java.util.ResourceBundle;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.maven.doxia.module.xdoc.XdocParser;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.reporting.AbstractMavenReportRenderer;
import org.codehaus.plexus.util.StringUtils;
import org.eclipse.mylyn.internal.bugzilla.core.BugzillaAttribute;
import org.eclipse.mylyn.tasks.core.data.TaskAttribute;
import org.eclipse.mylyn.tasks.core.data.TaskData;

import de.smartics.maven.issues.RendererConfig;

/**
 * The renderer provides helper methods to render a table.
 *
 * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
 */
public abstract class AbstractIssuesReportRenderer extends
    AbstractMavenReportRenderer
{
  // ********************************* Fields *********************************

  // --- constants ------------------------------------------------------------

  /**
   * Reference to the logger for this class.
   */
  private static final Log LOG = LogFactory
      .getLog(AbstractIssuesReportRenderer.class);

  // --- members --------------------------------------------------------------

  /**
   * The configuration to control the rendering process.
   */
  protected final RendererConfig config;

  /**
   * The issue information to render in the report.
   */
  protected final List<TaskData> issues;

  // ****************************** Initializer *******************************

  // ****************************** Constructors ******************************

  /**
   * Default constructor.
   *
   * @param config the configuration to control the rendering process.
   * @param sink the sink to write to.
   * @param issues the issue information to render in the report.
   */
  protected AbstractIssuesReportRenderer(final RendererConfig config,
      final Sink sink, final List<TaskData> issues)
  {
    super(sink);
    this.config = config;
    this.issues = issues;
    if (LOG.isTraceEnabled())
    {
      LOG.trace("Created renderer class instance '" + getClass().getName()
                + "' using this configuration: " + config);
    }
  }

  // ****************************** Inner Classes *****************************

  // ********************************* Methods ********************************

  // --- init -----------------------------------------------------------------

  // --- get&set --------------------------------------------------------------

  /**
   * Returns a short description of the report.
   *
   * @return a short description of the report.
   */
  protected abstract String getDescription();

  /**
   * Returns a short description of the report when there are no results.
   *
   * @return a short description of the report when there are no results.
   */
  protected abstract String getNoResultsDescription();

  /**
   * Returns the title set in the configuration and if unset there, the label
   * provided by the configuration's resource bundle.
   *
   * @param key the key to select the label if the title is not explicitly set.
   * @return the localized title to render.
   */
  protected String getTitle(final String key)
  {
    final String title = config.getTitle();
    if (title != null)
    {
      return title;
    }
    return config.getBundle().getString(key);
  }

  /**
   * Returns the description set in the configuration and if unset there, the
   * label provided by the configuration's resource bundle.
   *
   * @param key the key to select the label if the title is not explicitly set.
   * @return the localized description to render.
   */
  protected String getDescription(final String key)
  {
    final String description = config.getDescription();
    if (description != null)
    {
      return description;
    }
    return config.getBundle().getString(key);
  }

  /**
   * Returns the description if the query matches no issue set in the
   * configuration and if unset there, the label provided by the configuration's
   * resource bundle.
   *
   * @param key the key to select the label if the title is not explicitly set.
   * @return the localized description to render.
   */
  protected String getNoResultsDescription(final String key)
  {
    final String description = config.getNoResultsDescription();
    if (description != null)
    {
      return description;
    }
    return config.getBundle().getString(key);
  }

  // --- business -------------------------------------------------------------

  /**
   * Renders the title block of the report.
   *
   * @param noResults <code>true</code> if the report renders no results (no
   *          issue matches the query), <code>false</code> otherwise.
   */
  protected void renderTitle(final boolean noResults)
  {
    sink.sectionTitle1();
    sink.text(getTitle());
    sink.sectionTitle1_();
    renderDescription(noResults);
  }

  /**
   * Renders the description below the main title.
   *
   * @param noResults <code>true</code> if the report renders no results (no
   *          issue matches the query), <code>false</code> otherwise.
   */
  private void renderDescription(final boolean noResults)
  {
    if (noResults)
    {
      final String description = getNoResultsDescription();
      if (StringUtils.isNotBlank(description))
      {
        sink.paragraph();
        sink.text(description);
        sink.paragraph_();
      }
    }
    else
    {
      final boolean written = writeBodyContent();
      if (!written)
      {
        final String description = getDescription();
        if (StringUtils.isNotBlank(description))
        {
          sink.paragraph();
          sink.text(description);
          sink.paragraph_();
        }
      }
    }
  }

  /**
   * Writes the body content.
   *
   * @return <code>true</code> if the content is successfully written,
   *         <code>false</code> otherwise.
   */
  private boolean writeBodyContent()
  {
    try
    {
      final String bodyContent = config.getDescriptionFileBodyContent();
      if (!"".equals(bodyContent))
      {
        final XdocParser parser = new XdocParser();
        parser.parse(new StringReader(bodyContent), sink);
        // sink.rawText(bodyContent);
        return true;
      }
    }
    catch (final IOException e)
    {
      if (LOG.isWarnEnabled())
      {
        LOG.warn("Cannot read description file '"
                 + config.getDescriptionFile().getAbsolutePath() + "'.");
      }
    }
    catch (final ParseException e)
    {
      if (LOG.isWarnEnabled())
      {
        LOG.warn("Cannot read description file '"
                 + config.getDescriptionFile().getAbsolutePath() + "'.");
      }
    }
    return false;
  }

  /**
   * Renders the footer text.
   */
  protected void renderFooter()
  {
    final String footerText = config.getFooterText();
    if (StringUtils.isNotBlank(footerText))
    {
      sink.rawText(footerText);
    }
  }

  /**
   * Renders a table header.
   */
  protected void renderTableHeader()
  {
    final ResourceBundle bundle = config.getBundle();
    final List<String> columns = config.getColumns();
    final List<String> columnWidths = config.getColumnWidths();

    int i = 0;
    sink.tableRow();
    for (String column : columns)
    {
      final String label = ReportHelper.getLabel(bundle, column);
      final String width = columnWidths.get(i);
      if ("0".equals(width))
      {
        sink.tableHeaderCell();
      }
      else
      {
        sink.tableHeaderCell(width);
      }
      sink.text(label);
      sink.tableHeaderCell_();
      i++;
    }
    sink.tableRow_();
  }

  /**
   * Renders a table row.
   *
   * @param issue the issue whose values will be rendered to the columns.
   */
  protected void renderTableRow(final TaskData issue)
  {
    final boolean renderEmailAddresses = config.isRenderEmailAdresses();
    final TaskAttribute root = issue.getRoot();
    sink.tableRow();
    final List<String> columns = config.getColumns();
    for (String column : columns)
    {
      // TODO: Remove this dependency to Bugzilla (should be moved in the
      // config). BugzillaAttribute.BUG_ID.getKey()
      if (BugzillaAttribute.BUG_ID.getKey().equals(column))
      {
        final String id = issue.getTaskId();
        // TODO: Remove this dependency to Bugzilla (should be moved in the
        // config): "/show_bug.cgi?id="
        final String url = issue.getRepositoryUrl() + "/show_bug.cgi?id=" + id;
        ReportHelper.renderTableCellWithLink(sink, url, id);
      }
      else if (renderEmailAddresses
               && ReportHelper.PERSON_NAME_TO_EMAIL.containsKey(column))
      {
        final String eMailKey = ReportHelper.PERSON_NAME_TO_EMAIL.get(column);
        ReportHelper.renderTableCellWithMailto(sink, root, column, eMailKey);
      }
      else
      {
        ReportHelper.renderTableCell(sink, root, column);
      }
    }
    sink.tableRow_();
  }

  // --- object basics --------------------------------------------------------

}