abstract class PHPUnit_Util_TestDox_ResultPrinter

abstract class PHPUnit_Util_TestDox_ResultPrinter extends PHPUnit_Util_Printer implements PHPUnit_Framework_TestListener {

  /**
   * @var PHPUnit_Util_TestDox_NamePrettifier
   */
  protected $prettifier;

  /**
   * @var string
   */
  protected $testClass = '';

  /**
   * @var integer
   */
  protected $testStatus = FALSE;

  /**
   * @var array
   */
  protected $tests = array();

  /**
   * @var integer
   */
  protected $successful = 0;

  /**
   * @var integer
   */
  protected $failed = 0;

  /**
   * @var integer
   */
  protected $skipped = 0;

  /**
   * @var integer
   */
  protected $incomplete = 0;

  /**
   * @var string
   */
  protected $testTypeOfInterest = 'PHPUnit_Framework_TestCase';

  /**
   * @var string
   */
  protected $currentTestClassPrettified;

  /**
   * @var string
   */
  protected $currentTestMethodPrettified;

  /**
   * Constructor.
   *
   * @param  resource  $out
   */
  public function __construct($out = NULL) {
    parent::__construct($out);
    $this->prettifier = new PHPUnit_Util_TestDox_NamePrettifier();
    $this
      ->startRun();
  }

  /**
   * Flush buffer and close output.
   *
   */
  public function flush() {
    $this
      ->doEndClass();
    $this
      ->endRun();
    parent::flush();
  }

  /**
   * An error occurred.
   *
   * @param  PHPUnit_Framework_Test $test
   * @param  Exception              $e
   * @param  float                  $time
   */
  public function addError(PHPUnit_Framework_Test $test, Exception $e, $time) {
    if ($test instanceof $this->testTypeOfInterest) {
      $this->testStatus = PHPUnit_Runner_BaseTestRunner::STATUS_ERROR;
      $this->failed++;
    }
  }

  /**
   * A failure occurred.
   *
   * @param  PHPUnit_Framework_Test                 $test
   * @param  PHPUnit_Framework_AssertionFailedError $e
   * @param  float                                  $time
   */
  public function addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time) {
    if ($test instanceof $this->testTypeOfInterest) {
      $this->testStatus = PHPUnit_Runner_BaseTestRunner::STATUS_FAILURE;
      $this->failed++;
    }
  }

  /**
   * Incomplete test.
   *
   * @param  PHPUnit_Framework_Test $test
   * @param  Exception              $e
   * @param  float                  $time
   */
  public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time) {
    if ($test instanceof $this->testTypeOfInterest) {
      $this->testStatus = PHPUnit_Runner_BaseTestRunner::STATUS_INCOMPLETE;
      $this->incomplete++;
    }
  }

  /**
   * Skipped test.
   *
   * @param  PHPUnit_Framework_Test $test
   * @param  Exception              $e
   * @param  float                  $time
   * @since  Method available since Release 3.0.0
   */
  public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time) {
    if ($test instanceof $this->testTypeOfInterest) {
      $this->testStatus = PHPUnit_Runner_BaseTestRunner::STATUS_SKIPPED;
      $this->skipped++;
    }
  }

  /**
   * A testsuite started.
   *
   * @param  PHPUnit_Framework_TestSuite $suite
   * @since  Method available since Release 2.2.0
   */
  public function startTestSuite(PHPUnit_Framework_TestSuite $suite) {
  }

  /**
   * A testsuite ended.
   *
   * @param  PHPUnit_Framework_TestSuite $suite
   * @since  Method available since Release 2.2.0
   */
  public function endTestSuite(PHPUnit_Framework_TestSuite $suite) {
  }

  /**
   * A test started.
   *
   * @param  PHPUnit_Framework_Test $test
   */
  public function startTest(PHPUnit_Framework_Test $test) {
    if ($test instanceof $this->testTypeOfInterest) {
      $class = get_class($test);
      if ($this->testClass != $class) {
        if ($this->testClass != '') {
          $this
            ->doEndClass();
        }
        $this->currentTestClassPrettified = $this->prettifier
          ->prettifyTestClass($class);
        $this
          ->startClass($class);
        $this->testClass = $class;
        $this->tests = array();
      }
      $prettified = FALSE;
      if ($test instanceof PHPUnit_Framework_TestCase && !$test instanceof PHPUnit_Framework_Warning) {
        $annotations = $test
          ->getAnnotations();
        if (isset($annotations['method']['testdox'][0])) {
          $this->currentTestMethodPrettified = $annotations['method']['testdox'][0];
          $prettified = TRUE;
        }
      }
      if (!$prettified) {
        $this->currentTestMethodPrettified = $this->prettifier
          ->prettifyTestMethod($test
          ->getName(FALSE));
      }
      $this->testStatus = PHPUnit_Runner_BaseTestRunner::STATUS_PASSED;
    }
  }

  /**
   * A test ended.
   *
   * @param  PHPUnit_Framework_Test $test
   * @param  float                  $time
   */
  public function endTest(PHPUnit_Framework_Test $test, $time) {
    if ($test instanceof $this->testTypeOfInterest) {
      if (!isset($this->tests[$this->currentTestMethodPrettified])) {
        if ($this->testStatus == PHPUnit_Runner_BaseTestRunner::STATUS_PASSED) {
          $this->tests[$this->currentTestMethodPrettified]['success'] = 1;
          $this->tests[$this->currentTestMethodPrettified]['failure'] = 0;
        }
        else {
          $this->tests[$this->currentTestMethodPrettified]['success'] = 0;
          $this->tests[$this->currentTestMethodPrettified]['failure'] = 1;
        }
      }
      else {
        if ($this->testStatus == PHPUnit_Runner_BaseTestRunner::STATUS_PASSED) {
          $this->tests[$this->currentTestMethodPrettified]['success']++;
        }
        else {
          $this->tests[$this->currentTestMethodPrettified]['failure']++;
        }
      }
      $this->currentTestClassPrettified = NULL;
      $this->currentTestMethodPrettified = NULL;
    }
  }

  /**
   * @since  Method available since Release 2.3.0
   */
  protected function doEndClass() {
    foreach ($this->tests as $name => $data) {
      $this
        ->onTest($name, $data['failure'] == 0);
    }
    $this
      ->endClass($this->testClass);
  }

  /**
   * Handler for 'start run' event.
   *
   */
  protected function startRun() {
  }

  /**
   * Handler for 'start class' event.
   *
   * @param  string $name
   */
  protected function startClass($name) {
  }

  /**
   * Handler for 'on test' event.
   *
   * @param  string  $name
   * @param  boolean $success
   */
  protected function onTest($name, $success = TRUE) {
  }

  /**
   * Handler for 'end class' event.
   *
   * @param  string $name
   */
  protected function endClass($name) {
  }

  /**
   * Handler for 'end run' event.
   *
   */
  protected function endRun() {
  }

}