/*
    * Copyright 2010-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.testdoc.maven.export;
  
  import java.io.IOException;
  import java.io.OutputStream;
  import java.util.List;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import de.smartics.maven.util.report.MessageHelper;
  import de.smartics.testdoc.core.doc.ScenarioTestDoc;
  import de.smartics.testdoc.core.doc.Type;
  import de.smartics.testdoc.core.doc.UnitTestDoc;
  import de.smartics.testdoc.core.export.UnitTestDocExporter;
  import de.smartics.testdoc.report.export.doc.ExternalReportReferences;
  import de.smartics.testdoc.report.export.doc.InformationFilter;
  import de.smartics.testdoc.report.export.doc.TestDocHelper;
  import de.smartics.testdoc.report.junit.JUnitTestCaseManager;
  
  /**
   * Exports the test documentation to an output medium.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  public abstract class AbstractReportExporter implements UnitTestDocExporter
  { // NOPMD
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * Reference to the logger for this class.
     */
    private final Logger log = LoggerFactory
        .getLogger(AbstractReportExporter.class);
  
    /**
     * The resource bundles with messages to display as labels in the generated
     * report.
     */
    protected final MessageHelper messages;
  
    /**
     * Provides access to configuration information.
     */
    protected final TestDocHelper testDocHelper;
  
    /**
     * The configuration that tells which report information is to be displayed.
     */
    protected final InformationFilter informationFilter;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param messages the resource bundles with messages to display as labels in
     *          the generated report.
     * @param testDocHelper the value for testDocHelper.
     */
    protected AbstractReportExporter(final MessageHelper messages,
        final TestDocHelper testDocHelper)
    {
      this.messages = messages;
      this.testDocHelper = testDocHelper;
      this.informationFilter = testDocHelper.getInformationFilter();
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    /**
     * {@inheritDoc}
    *
    * @see de.smartics.testdoc.report.export.UnitTestDocExporter#getFileExtension()
    */
   @Override
   public String getFileExtension()
   {
     return "xml";
   }
 
   /**
    * Returns the configuration that tells which report information is to be
    * displayed.
    *
    * @return the configuration that tells which report information is to be
    *         displayed.
    */
   public InformationFilter getInformationFilter()
   {
     return testDocHelper.getInformationFilter();
   }
 
   /**
    * Returns the value for testDocHelper.
    * <p>
    * Provides access to configuration information.
    *
    * @return the value for testDocHelper.
    */
   public TestDocHelper getTestDocHelper()
   {
     return testDocHelper;
   }
 
   // --- business -------------------------------------------------------------
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.testdoc.report.export.UnitTestDocExporter#export(de.smartics.testdoc.report.doc.UnitTestDoc,
    *      java.io.OutputStream)
    */
   @Override
   public void export(final UnitTestDoc testDoc, final OutputStream output)
     throws IOException
   {
     final Type type = testDoc.getUutType();
 
     final List<ScenarioTestDoc> scenarios =
         testDocHelper.filterScenarios(testDoc.getScenarios());
 
     if (scenarios.isEmpty())
     {
       if (log.isDebugEnabled())
       {
         log.debug("No stories for " + type + " passed the filter.");
       }
       return;
     }
 
     renderTestDocTypeStart(testDoc);
     final ExternalReportReferences reports = testDocHelper.getReports();
     renderTestDocUutReportLinks(type, reports);
 
     final ScenarioTestDoc rep = scenarios.get(0);
     renderTableStart(rep);
 
     int counter = 1;
     for (final ScenarioTestDoc scenario : scenarios)
     {
       renderScenario(counter, scenario);
       counter++;
     }
 
     renderTableEnd(rep);
 
     renderTestDocTypeEnd(testDoc);
   }
 
   /**
    * Override if the report need to initialize the output before individual test
    * documentation units are exported.
    *
    * @param scenarioRepresentant the representant of the documentation units.
    *          This is the first unit peeked from the list to be exported.
    */
   protected void renderTableStart(final ScenarioTestDoc scenarioRepresentant)
     throws IOException
   {
   }
 
   /**
    * Override to export the test doc unit start information. This is the type
    * information.
    *
    * @param testDoc the instance whose test type information is to be exported.
    */
   protected abstract void renderTestDocTypeStart(UnitTestDoc testDoc)
     throws IOException;
 
   /**
    * The symmetric method to {@link #renderTestDocTypeStart(UnitTestDoc)}.
    *
    * @param testDoc the unit whose export ends with this method.
    */
   protected void renderTestDocTypeEnd(final UnitTestDoc testDoc)
     throws IOException
   {
   }
 
   /**
    * Exports links to external reports.
    *
    * @param reports the reports to link to.
    */
   protected abstract void renderTestDocUutReportLinks(Type type,
       ExternalReportReferences reports) throws IOException;
 
   /**
    * Controls the output of a single scenario within the test documentation
    * unit. Usually not to be overridden.
    *
    * @param counter the current counter of the scenario.
    * @param scenario the scenario to be exported.
    */
   protected void renderScenario(final int counter,
       final ScenarioTestDoc scenario) throws IOException
   {
     startScenario();
     renderRowNumber(counter);
     renderJUnitStatus(scenario);
     renderSentence(scenario);
     renderCategories(scenario);
     renderTestCase(scenario);
     endScenario();
   }
 
   protected void startScenario()
   {
   }
 
   protected void endScenario()
   {
   }
 
   protected abstract void renderRowNumber(int counter) throws IOException;
 
   protected abstract void renderJUnitStatus(final ScenarioTestDoc scenario)
     throws IOException;
 
   protected abstract void renderSentence(final ScenarioTestDoc scenario)
     throws IOException;
 
   protected abstract void renderCategories(final ScenarioTestDoc scenario)
     throws IOException;
 
   protected abstract void renderTestCase(final ScenarioTestDoc scenario)
     throws IOException;
 
   protected void renderTableEnd(final ScenarioTestDoc scenarioRepresentant)
     throws IOException
   {
     final Type testCaseType = scenarioRepresentant.getTestCaseType();
     final JUnitTestCaseManager junitManager = testDocHelper.getJunitManager();
     junitManager.evict(testCaseType);
   }
 
   // --- object basics --------------------------------------------------------
 
 }