guard-phpunit2 0.2.3 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29049fcae5b8a04752ba78a2a8e4b99299fa282e
-  data.tar.gz: 5d74a651906f7d51085ca82faf7b0211a0967464
+  metadata.gz: 0f96efc03dc54e656212472d776a045c5ad5268e
+  data.tar.gz: ea337d8a51a8ba57c5b5d53101ff0b0fc45be8a6
 SHA512:
-  metadata.gz: a274812dc59206fc0f1edc7f2c7c654e35868477e989c513d29becd82f62f2a1c21ecb9eb69c64caa99a553a6513da9d5ccb2850cf4a43c4727c8bcb47a0e140
-  data.tar.gz: d7a39c5e0467acb4ae0a2298d5f4a4d12848e14ea1c11fc0411a3fee756c610e534613204678ffbe4f557e6fcd8686069ebda77550f865188ea8885e2cb8c3c2
+  metadata.gz: 3001101cc7c940c0bbd5a00ea95837c56c6b2f5e47c6b2cf20b91b5a6b5a3a6c86289b13cda46dc0e7ed86131763e4c735da3aebf158648dc9d276c7d9098b47
+  data.tar.gz: 481ecdda28ef0f20f106797adb443f5c0820de6d8bdfd756ab91734c3db4f8f84952a54d0b26c2132f2163e7cd1e27b508aa283c92c4d8fcaa7b23f4427df392

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.5 - June 02, 2013
+- Fixed issues with providing the command
+- Made it include an explicit output formatter 
+
 ## 0.1.4 - August 09, 2012
 
 - [#2][]: Add support for Windows.
@@ -34,4 +38,4 @@
 
 <!--- The following link definition list is generated by PimpMyChangelog --->
 [#2]: https://github.com/Maher4Ever/guard-phpunit/issues/2
-[#3]: https://github.com/Maher4Ever/guard-phpunit/issues/3
+[#3]: https://github.com/Maher4Ever/guard-phpunit/issues/3

data/README.md

@@ -1,7 +1,7 @@
-Guard::PHPUnit [![Build Status](https://secure.travis-ci.org/Maher4Ever/guard-phpunit.png)](http://travis-ci.org/Maher4Ever/guard-phpunit) [![Dependency Status](https://gemnasium.com/Maher4Ever/guard-phpunit.png?branch=master)](https://gemnasium.com/Maher4Ever/guard-phpunit)
+Guard::PHPUnit [![Build Status](https://secure.travis-ci.org/ramon/guard-phpunit2.png)](http://travis-ci.org/ramon/guard-phpunit2)
 ==============
 
-Guard-phpunit allows you to automatically run [PHPUnit][6] tests when sources
+Guard-phpunit2 allows you to automatically run [PHPUnit][6] tests when sources
 are modified. It helps with integrating test-driven development (TDD) into
 your development process: Just launch guard-phpunit before you start working
 and it will notify you about the status of your tests!
@@ -18,10 +18,10 @@ you proceed with the installation.
 The latest versions of [Ruby][1] come with a packages-manager called `gem`. `gem` can be used to
 install various packages, including guard-phpunit.
 
-To install guard-phpunit, run the following command in the terminal:
+To install guard-phpunit2, run the following command in the terminal:
 
 ```shell
-$ gem install guard-phpunit
+$ gem install guard-phpunit2
 ```
 
 Usage
@@ -48,7 +48,7 @@ An example of the Guardfile for the same project would look
 something like:
 
 ```ruby
-guard 'phpunit', :tests_path => 'Tests', :cli => '--colors' do
+guard 'phpunit2', :tests_path => 'Tests', :cli => '--colors' do
   # Watch tests files
   watch(%r{^.+Test\.php$})
 
@@ -82,13 +82,17 @@ The following options can be passed to Guard::PHPUnit:
 :cli => '--colors'            # The options passed to the phpunit command
                               # when running the tests.
                               # default: nil
+
+:command => "./bin/phpunit"   # specify alternative phpunit location
+                              # that is not on the path.
+                              # Useful if running phpunit from composer
 ```
 
 Development
 -----------
 
-* Source hosted at [GitHub](https://github.com/Maher4Ever/guard-phpunit)
-* Report issues/Questions/Feature requests on [GitHub Issues](https://github.com/Maher4Ever/guard-phpunit/issues)
+* Source hosted at [GitHub](https://github.com/ramon/guard-phpunit2)
+* Report issues/Questions/Feature requests on [GitHub Issues](https://github.com/ramon/guard-phpunit2/issues)
 
 Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change
 you make.
@@ -98,6 +102,11 @@ Author
 
 [Maher Sallam](https://github.com/Maher4Ever)
 
+[Ramon Soares](https://github.com/ramon)
+
+[Marek Kalnik](https://github.com/marekkalnik)
+
+
 [1]:http://ruby-lang.org
 [3]:https://github.com/guard/guard#readme
 [4]:http://www.phpunit.de/manual/current/en/

data/lib/guard/phpunit/formatters/PHPUnit-Progress/PHPUnit/Extensions/Progress/ResultPrinter.php

@@ -0,0 +1,503 @@
+<?php
+
+/**
+ * Prints tests' results in a similar way
+ * to rspec's progress formatter.
+ *
+ * @package    PHPUnit
+ * @subpackage Progress
+ * @author     Maher Sallam <maher@sallam.me>
+ * @copyright  2011 Maher Sallam <maher@sallam.me>
+ * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
+ * @version    0.1
+ */
+class PHPUnit_Extensions_Progress_ResultPrinter extends PHPUnit_TextUI_ResultPrinter {
+
+  /**
+   * Constructor.
+   *
+   * @param  mixed   $out
+   * @param  boolean $verbose
+   * @param  boolean $colors
+   * @param  boolean $debug
+   */
+  public function __construct($out = NULL, $verbose = FALSE, $colors = FALSE, $debug = FALSE) {
+
+    // Start capturing output
+    ob_start();
+
+    $argv = $_SERVER['argv'];
+    $colors  = in_array('--colors', $argv) || $colors;
+    $verbose = in_array('--verbose', $argv) || in_array('-v', $argv) || $verbose;
+    $debug   = in_array('--debug', $argv) || $debug;
+
+    parent::__construct($out, $verbose, $colors, $debug);
+  }
+
+  /**
+   * @param  PHPUnit_Framework_TestResult $result
+   */
+  public function printResult(PHPUnit_Framework_TestResult $result)
+  {
+    print "\n";
+
+    if ($result->errorCount() > 0) {
+      $this->printErrors($result);
+    }
+
+    if ($result->failureCount() > 0) {
+      $this->printFailures($result);
+    }
+
+    if ($this->verbose) {
+      if ($result->deprecatedFeaturesCount() > 0) {
+        if ($result->failureCount() > 0) {
+          print "\n--\n\nDeprecated PHPUnit features are being used";
+        }
+
+        foreach ($result->deprecatedFeatures() as $deprecatedFeature) {
+          $this->write($deprecatedFeature . "\n\n");
+        }
+      }
+
+      if ($result->notImplementedCount() > 0) {
+        $this->printIncompletes($result);
+      }
+
+      if ($result->skippedCount() > 0) {
+        $this->printSkipped($result);
+      }
+    }
+
+    $this->printFooter($result);
+  } 
+
+  /**
+   * @param  array   $defects
+   * @param  integer $count
+   * @param  string  $type
+   */
+  protected function printDefects(array $defects, $count, $type)
+  {
+    if ($count == 0) {
+      return;
+    }
+
+    $this->write("\n" . $type . ":\n");
+
+    $i = 1;
+    $failOrError = $type == 'Failures' || $type == 'Errors';
+
+    foreach ($defects as $defect) {
+      $this->printDefect($defect, $i++, $failOrError);
+      $this->write("\n");
+    }
+  }
+
+  /**
+   * @param  PHPUnit_Framework_TestFailure $defect
+   * @param  integer                       $count
+   * @param  boolean                       $failOrError
+   */
+  protected function printDefect(PHPUnit_Framework_TestFailure $defect, $count, $failOrError = true)
+  {
+    $this->printDefectHeader($defect, $count, $failOrError);
+
+    $padding = str_repeat(' ', 
+      4 + ( $failOrError ? strlen((string)$count) : 0 )
+    );
+
+    $this->printDefectBody($defect, $count, $failOrError, $padding);
+    $this->printDefectTrace($defect, $padding);
+  }
+
+  /**
+   * @param  PHPUnit_Framework_TestFailure $defect
+   * @param  integer                       $count
+   * @param  boolean                       $failOrError
+   */
+  protected function printDefectHeader(PHPUnit_Framework_TestFailure $defect, $count, $failOrError = true)
+  {
+    $failedTest = $defect->failedTest();
+
+    if ($failedTest instanceof PHPUnit_Framework_SelfDescribing) {
+      $testName = $failedTest->toString();
+    } else {
+      $testName = get_class($failedTest);
+    }
+
+    if ( $failOrError ) {
+      $this->write(
+        sprintf(
+          "\n  %d) %s",
+
+          $count,
+          $testName
+        )
+      );
+    } else {
+      $this->write( 
+        sprintf( "  %s", $this->yellow($testName) )
+      ); 
+    }
+  }
+
+  /**
+   * @param  PHPUnit_Framework_TestFailure $defect
+   * @param  integer                       $count
+   * @param  boolean                       $failOrError
+   * @param  string                        $padding
+   */
+  protected function printDefectBody(PHPUnit_Framework_TestFailure $defect, $count, $failOrError, $padding)
+  {
+    $error = trim($defect->getExceptionAsString());
+
+    if ( !empty($error) ) {
+      $error = explode("\n", $error);
+      $error = "\n" . $padding . implode("\n  " . $padding , $error);
+
+      $this->write( $failOrError ? $this->red($error) : $this->cyan($error) );
+    }
+  }
+
+  /**
+   * @param  PHPUnit_Framework_TestFailure $defect
+   * @param  string                        $padding
+   */
+  protected function printDefectTrace(PHPUnit_Framework_TestFailure $defect, $padding = 0)
+  { 
+    $trace = trim(
+      PHPUnit_Util_Filter::getFilteredStacktrace(
+        $defect->thrownException()
+      )
+    );
+
+    if ( ! empty($trace) ) {
+      $trace = explode("\n", $trace);
+      $trace = "\n" . $padding . '# ' . implode("\n${padding}# ", $trace);
+
+      $this->write($this->cyan($trace));
+    }
+  }
+
+  /**
+   * @param  PHPUnit_Framework_TestResult  $result
+   */
+  protected function printErrors(PHPUnit_Framework_TestResult $result)
+  {
+    $this->printDefects(
+      $result->errors(),
+      $result->errorCount(), 
+      'Errors'
+    );
+  }
+
+  /**
+   * @param  PHPUnit_Framework_TestResult  $result
+   */
+  protected function printFailures(PHPUnit_Framework_TestResult $result)
+  {
+    $this->printDefects(
+      $result->failures(),
+      $result->failureCount(),
+      'Failures'
+    );
+  }
+
+  /**
+   * @param  PHPUnit_Framework_TestResult  $result
+   */
+  protected function printIncompletes(PHPUnit_Framework_TestResult $result)
+  {
+    $this->printDefects(
+      $result->notImplemented(),
+      $result->notImplementedCount(),
+      'Incomplete tests'
+    );
+  }
+
+  /**
+   * @param  PHPUnit_Framework_TestResult  $result
+   * @since  Method available since Release 3.0.0
+   */
+  protected function printSkipped(PHPUnit_Framework_TestResult $result)
+  {
+    $this->printDefects(
+      $result->skipped(),
+      $result->skippedCount(),
+      'Skipped tests'
+    );
+  }
+
+  /**
+   * @param  PHPUnit_Framework_TestResult  $result
+   */
+  protected function printFooter(PHPUnit_Framework_TestResult $result)
+  {
+
+    $this->write( sprintf("\nFinished in %s\n", PHP_Timer::timeSinceStartOfRequest()) );
+
+    $resultsCount = count($result);
+
+    $footer = sprintf("%d test%s, %d assertion%s",
+      $resultsCount,
+      $resultsCount == 1 ? '' : 's',
+      $this->numAssertions,
+      $this->numAssertions == 1 ? '' : 's' 
+    );
+
+    // backwards/forwards compatibility hack for naming fix from phpunit 3.7.11
+    // @see https://github.com/sebastianbergmann/phpunit/issues/762
+    $allCompletelyImplemented = method_exists($result, 'allCompletelyImplemented')?
+	  'allCompletelyImplemented':'allCompletlyImplemented';
+
+    if ( $result->wasSuccessful() &&
+	  $result->$allCompletelyImplemented() &&
+      $result->noneSkipped() )
+    {
+      $this->write($this->green($footer));
+    }
+
+    else if ( ( !$result->$allCompletelyImplemented() || !$result->noneSkipped() ) 
+      &&
+      $result->wasSuccessful() ) 
+    {
+
+      $footer .= sprintf(
+        "%s%s",
+
+        $this->getCountString(
+          $result->notImplementedCount(), 'incomplete'
+        ),
+        $this->getCountString(
+          $result->skippedCount(), 'skipped'
+        )
+      );
+
+      $this->write($this->yellow($footer));
+
+    }
+
+    else {
+
+      $footer .= sprintf(
+        "%s%s%s%s",
+
+        $this->getCountString($result->failureCount(), 'failures'),
+        $this->getCountString($result->errorCount(), 'errors'),
+        $this->getCountString(
+          $result->notImplementedCount(), 'incomplete'
+        ),
+        $this->getCountString($result->skippedCount(), 'skipped')
+      );
+
+      $footer  = preg_replace('/,$/', '', $footer);
+
+      $this->write($this->red($footer));
+    }
+
+    if ( ! $this->verbose &&
+      $result->deprecatedFeaturesCount() > 0 ) 
+    {
+      $message = sprintf(
+        "Warning: Deprecated PHPUnit features are being used %s times!\n".
+        "Use --verbose for more information.\n",
+        $result->deprecatedFeaturesCount()
+      );
+
+      if ($this->colors) {
+        $message = "\x1b[37;41m\x1b[2K" . $message .
+          "\x1b[0m";
+      }
+
+      $this->write("\n" . $message);
+    }
+
+    $this->writeNewLine();
+  }
+
+  /**
+   * @param  integer $count
+   * @param  string  $name
+   * @return string
+   * @since  Method available since Release 3.0.0
+   */
+  protected function getCountString($count, $name)
+  {
+    $string = '';
+
+    if ($count > 0) {
+      $string = sprintf(
+        ', %d %s',
+
+        $count,
+        $name
+      );
+    }
+
+    return $string;
+  }
+
+  /**
+   * An error occurred.
+   *
+   * @param  PHPUnit_Framework_Test $test
+   * @param  Exception              $e
+   * @param  float                  $time
+   */
+  public function addError(PHPUnit_Framework_Test $test, Exception $e, $time)
+  {
+    $this->writeProgress($this->red('E'));
+    $this->lastTestFailed = TRUE;
+  }
+
+  /**
+   * 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)
+  {
+    $this->writeProgress($this->red('F'));
+    $this->lastTestFailed = TRUE;
+  }
+
+  /**
+   * Incomplete test.
+   *
+   * @param  PHPUnit_Framework_Test $test
+   * @param  Exception              $e
+   * @param  float                  $time
+   */
+  public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time)
+  {
+    $this->writeProgress($this->yellow('I'));
+    $this->lastTestFailed = TRUE;
+  }
+
+  /**
+   * 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)
+  {
+    $this->writeProgress($this->yellow('S'));
+    $this->lastTestFailed = TRUE;
+  }
+
+  /**
+   * A test ended.
+   *
+   * @param  PHPUnit_Framework_Test $test
+   * @param  float                  $time
+   */
+  public function endTest(PHPUnit_Framework_Test $test, $time)
+  {
+    if (!$this->lastTestFailed) {
+      $this->writeProgress($this->green('.'));
+    }
+
+    if ($test instanceof PHPUnit_Framework_TestCase) {
+      $this->numAssertions += $test->getNumAssertions();
+    }
+
+    else if ($test instanceof PHPUnit_Extensions_PhptTestCase) {
+      $this->numAssertions++;
+    }
+
+    $this->lastTestFailed = FALSE;
+
+    if ($this->verbose && $test instanceof PHPUnit_Framework_TestCase) {
+      $this->write($test->getActualOutput());
+    }
+
+  }
+
+  /**
+   * @param  string $progress
+   */
+  protected function writeProgress($progress)
+  {
+    static $deletedHeader = false;
+
+    if ( ! $deletedHeader ) {
+      ob_clean();
+      $deletedHeader = true;
+    }
+
+    parent::writeProgress($progress);
+  }
+
+  /**
+   * Returns a colored string which can be used
+   * in the terminal.
+   *
+   * @param string  $text
+   * @param integer $color_code
+   */
+  protected function color($text, $color_code) {
+    return $this->colors ? "\033[${color_code}m" . $text . "\033[0m" : $text;
+  }
+
+  /**
+   * @param string $text
+   */
+  protected function bold($text) {
+    return $this->color($text, "1");
+  }
+
+  /**
+   * @param string $text
+   */
+  protected function red($text) {
+    return $this->color($text, "31");
+  }
+
+  /**
+   * @param string $text
+   */
+  protected function green($text) {
+    return $this->color($text, "32");
+  }
+
+  /**
+   * @param string $text
+   */
+  protected function yellow($text) {
+    return $this->color($text, "33");
+  }
+
+  /**
+   * @param string $text
+   */
+  protected function blue($text) {
+    return $this->color($text, "34");
+  }
+
+  /**
+   * @param string $text
+   */
+  protected function magenta($text) {
+    return $this->color($text, "35");
+  }
+
+  /**
+   * @param string $text
+   */
+  protected function cyan($text) {
+    return $this->color($text, "36");
+  }
+
+  /**
+   * @param string $text
+   */
+  protected function white($text) {
+    return $this->color($text, "37");
+  }
+}