class PHP_CodeCoverage_Filter

PHP_CodeCoverageTest::testConstructor in drupal/core/vendor/phpunit/php-code-coverage/Tests/PHP/CodeCoverageTest.php

@covers PHP_CodeCoverage::__construct @covers PHP_CodeCoverage::filter

class PHP_CodeCoverage_Filter {

  /**
   * Source files that are blacklisted.
   *
   * @var array
   */
  protected $blacklistedFiles = array();

  /**
   * Source files that are whitelisted.
   *
   * @var array
   */
  protected $whitelistedFiles = array();

  /**
   * @var boolean
   */
  protected $blacklistPrefilled = FALSE;

  /**
   * Adds a directory to the blacklist (recursively).
   *
   * @param string $directory
   * @param string $suffix
   * @param string $prefix
   */
  public function addDirectoryToBlacklist($directory, $suffix = '.php', $prefix = '') {
    $facade = new File_Iterator_Facade();
    $files = $facade
      ->getFilesAsArray($directory, $suffix, $prefix);
    foreach ($files as $file) {
      $this
        ->addFileToBlacklist($file);
    }
  }

  /**
   * Adds a file to the blacklist.
   *
   * @param string $filename
   */
  public function addFileToBlacklist($filename) {
    $this->blacklistedFiles[realpath($filename)] = TRUE;
  }

  /**
   * Adds files to the blacklist.
   *
   * @param array $files
   */
  public function addFilesToBlacklist(array $files) {
    foreach ($files as $file) {
      $this
        ->addFileToBlacklist($file);
    }
  }

  /**
   * Removes a directory from the blacklist (recursively).
   *
   * @param string $directory
   * @param string $suffix
   * @param string $prefix
   */
  public function removeDirectoryFromBlacklist($directory, $suffix = '.php', $prefix = '') {
    $facade = new File_Iterator_Facade();
    $files = $facade
      ->getFilesAsArray($directory, $suffix, $prefix);
    foreach ($files as $file) {
      $this
        ->removeFileFromBlacklist($file);
    }
  }

  /**
   * Removes a file from the blacklist.
   *
   * @param string $filename
   */
  public function removeFileFromBlacklist($filename) {
    $filename = realpath($filename);
    if (isset($this->blacklistedFiles[$filename])) {
      unset($this->blacklistedFiles[$filename]);
    }
  }

  /**
   * Adds a directory to the whitelist (recursively).
   *
   * @param string $directory
   * @param string $suffix
   * @param string $prefix
   */
  public function addDirectoryToWhitelist($directory, $suffix = '.php', $prefix = '') {
    $facade = new File_Iterator_Facade();
    $files = $facade
      ->getFilesAsArray($directory, $suffix, $prefix);
    foreach ($files as $file) {
      $this
        ->addFileToWhitelist($file);
    }
  }

  /**
   * Adds a file to the whitelist.
   *
   * @param string $filename
   */
  public function addFileToWhitelist($filename) {
    $this->whitelistedFiles[realpath($filename)] = TRUE;
  }

  /**
   * Adds files to the whitelist.
   *
   * @param array $files
   */
  public function addFilesToWhitelist(array $files) {
    foreach ($files as $file) {
      $this
        ->addFileToWhitelist($file);
    }
  }

  /**
   * Removes a directory from the whitelist (recursively).
   *
   * @param string $directory
   * @param string $suffix
   * @param string $prefix
   */
  public function removeDirectoryFromWhitelist($directory, $suffix = '.php', $prefix = '') {
    $facade = new File_Iterator_Facade();
    $files = $facade
      ->getFilesAsArray($directory, $suffix, $prefix);
    foreach ($files as $file) {
      $this
        ->removeFileFromWhitelist($file);
    }
  }

  /**
   * Removes a file from the whitelist.
   *
   * @param string $filename
   */
  public function removeFileFromWhitelist($filename) {
    $filename = realpath($filename);
    if (isset($this->whitelistedFiles[$filename])) {
      unset($this->whitelistedFiles[$filename]);
    }
  }

  /**
   * Checks whether a filename is a real filename.
   *
   * @param string $filename
   */
  public function isFile($filename) {
    if ($filename == '-' || strpos($filename, 'eval()\'d code') !== FALSE || strpos($filename, 'runtime-created function') !== FALSE || strpos($filename, 'runkit created function') !== FALSE || strpos($filename, 'assert code') !== FALSE || strpos($filename, 'regexp code') !== FALSE) {
      return FALSE;
    }
    return TRUE;
  }

  /**
   * Checks whether or not a file is filtered.
   *
   * When the whitelist is empty (default), blacklisting is used.
   * When the whitelist is not empty, whitelisting is used.
   *
   * @param  string  $filename
   * @param  boolean $ignoreWhitelist
   * @return boolean
   * @throws PHP_CodeCoverage_Exception
   */
  public function isFiltered($filename) {
    $filename = realpath($filename);
    if (!empty($this->whitelistedFiles)) {
      return !isset($this->whitelistedFiles[$filename]);
    }
    if (!$this->blacklistPrefilled) {
      $this
        ->prefillBlacklist();
    }
    return isset($this->blacklistedFiles[$filename]);
  }

  /**
   * Returns the list of blacklisted files.
   *
   * @return array
   */
  public function getBlacklist() {
    return array_keys($this->blacklistedFiles);
  }

  /**
   * Returns the list of whitelisted files.
   *
   * @return array
   */
  public function getWhitelist() {
    return array_keys($this->whitelistedFiles);
  }

  /**
   * Returns whether this filter has a whitelist.
   *
   * @return boolean
   * @since  Method available since Release 1.1.0
   */
  public function hasWhitelist() {
    return !empty($this->whitelistedFiles);
  }

  /**
   * @since Method available since Release 1.2.3
   */
  protected function prefillBlacklist() {
    if (defined('__PHPUNIT_PHAR__')) {
      $this
        ->addFileToBlacklist(__PHPUNIT_PHAR__);
    }
    $this
      ->addDirectoryContainingClassToBlacklist('File_Iterator');
    $this
      ->addDirectoryContainingClassToBlacklist('PHP_CodeCoverage');
    $this
      ->addDirectoryContainingClassToBlacklist('PHP_Invoker');
    $this
      ->addDirectoryContainingClassToBlacklist('PHP_Timer');
    $this
      ->addDirectoryContainingClassToBlacklist('PHP_Token');
    $this
      ->addDirectoryContainingClassToBlacklist('PHPUnit_Framework_TestCase', 2);
    $this
      ->addDirectoryContainingClassToBlacklist('PHPUnit_Extensions_Database_TestCase', 2);
    $this
      ->addDirectoryContainingClassToBlacklist('PHPUnit_Framework_MockObject_Generator', 2);
    $this
      ->addDirectoryContainingClassToBlacklist('PHPUnit_Extensions_SeleniumTestCase', 2);
    $this
      ->addDirectoryContainingClassToBlacklist('PHPUnit_Extensions_Story_TestCase', 2);
    $this
      ->addDirectoryContainingClassToBlacklist('Text_Template');
    $this
      ->addDirectoryContainingClassToBlacklist('Symfony\\Component\\Yaml\\Yaml');
    $this->blacklistPrefilled = TRUE;
  }

  /**
   * @param string  $className
   * @param integer $parent
   * @since Method available since Release 1.2.3
   */
  protected function addDirectoryContainingClassToBlacklist($className, $parent = 1) {
    if (!class_exists($className)) {
      return;
    }
    $reflector = new ReflectionClass($className);
    $directory = $reflector
      ->getFileName();
    for ($i = 0; $i < $parent; $i++) {
      $directory = dirname($directory);
    }
    $this
      ->addDirectoryToBlacklist($directory);
  }

}