Merge pull request #44 from bakame-php/feature/exposing-codecoverage-blacklist-options

Exposes Code coverage optional arguments for directory filtering

Author: shulard

README.md

@@ -127,6 +127,10 @@ extensions:
     whitelist:
       - src
       - lib
+      # or to apply filtering on files names
+      #- directory: src
+      #  suffix: "Controller.php"
+      #  prefix: "Get"
     #
     # Whiltelist files for which code generation should be done
     # Default: empty
@@ -137,6 +141,10 @@ extensions:
     # Blacklist directories for which code generation should NOT be done
     #blacklist:
       #- src/legacy
+      # or to apply filtering on files names
+      #- directory: src/legacy
+      #  suffix: "Spec.php"
+      #  prefix: "Test"
     #
     # Blacklist files for which code generation should NOT be done
     #blacklist_files:
@@ -161,10 +169,12 @@ extensions:
 * `high_lower_bound` (optional) sets high lower bound for code coverage
   (default `70`)
 * `whitelist` takes an array of directories to whitelist (default: `lib`,
-  `src`).
+  `src`). The array can be made more specific if an associative array is 
+  given with the following keys (`directory`, `prefix`, `suffix`)
 * `whitelist_files` takes an array of files to whitelist (default: none).
 * `blacklist` takes an array of directories to blacklist (default: `test,
-  vendor, spec`)
+  vendor, spec`). The array can be made more specific if an associative 
+  array is given with the following keys (`directory`, `prefix`, `suffix`)
 * `blacklist_files` takes an array of files to blacklist
 
 ## Authors

spec/Exception/ConfigurationExceptionSpec.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\FriendsOfPhpSpec\PhpSpec\CodeCoverage\Exception;
+
+use FriendsOfPhpSpec\PhpSpec\CodeCoverage\Exception\ConfigurationException;
+use InvalidArgumentException;
+use PhpSpec\ObjectBehavior;
+
+/**
+ * @author Ignace Nyamagana Butera
+ */
+class ConfigurationExceptionSpec extends ObjectBehavior
+{
+    public function it_is_initializable(): void
+    {
+        $this->shouldBeAnInstanceOf(InvalidArgumentException::class);
+        $this->shouldHaveType(ConfigurationException::class);
+    }
+}

spec/Listener/CodeCoverageListenerSpec.php

@@ -4,13 +4,16 @@
 
 namespace spec\FriendsOfPhpSpec\PhpSpec\CodeCoverage\Listener;
 
+use FriendsOfPhpSpec\PhpSpec\CodeCoverage\Exception\ConfigurationException;
 use FriendsOfPhpSpec\PhpSpec\CodeCoverage\Listener\CodeCoverageListener;
 use PhpSpec\Console\ConsoleIO;
+use PhpSpec\Event\SuiteEvent;
 use PhpSpec\ObjectBehavior;
 use SebastianBergmann\CodeCoverage\CodeCoverage;
 use SebastianBergmann\CodeCoverage\Driver\Driver;
 use SebastianBergmann\CodeCoverage\Filter;
 use SebastianBergmann\CodeCoverage\RawCodeCoverageData;
+use stdClass;
 
 /**
  * Disabled due to tests breaking as php-code-coverage marked their classes
@@ -23,11 +26,66 @@
  */
 class CodeCoverageListenerSpec extends ObjectBehavior
 {
+    public function it_can_process_all_directory_filtering_options(SuiteEvent $event)
+    {
+        $this->setOptions([
+            'blacklist' => [
+                'src',
+                ['directory' => 'src', 'suffix' => 'Spec.php', 'prefix' => 'Get'],
+                ['directory' => 'src', 'suffix' => 'Test.php'],
+                ['directory' => 'src'],
+            ],
+        ]);
+
+        $this
+            ->shouldNotThrow(ConfigurationException::class)
+            ->during('beforeSuite', [$event]);
+    }
+
     public function it_is_initializable()
     {
         $this->shouldHaveType(CodeCoverageListener::class);
     }
 
+    public function it_will_ignore_unknown_directory_filtering_options(SuiteEvent $event)
+    {
+        $this->setOptions([
+            'whitelist' => [
+                ['directory' => 'test', 'foobar' => 'baz'],
+            ],
+        ]);
+
+        $this
+            ->shouldNotThrow(ConfigurationException::class)
+            ->during('beforeSuite', [$event]);
+    }
+
+    public function it_will_throw_if_the_directory_filter_option_type_is_not_supported(SuiteEvent $event)
+    {
+        $this->setOptions([
+            'whitelist' => [
+                new stdClass(),
+            ],
+        ]);
+
+        $this
+            ->shouldThrow(ConfigurationException::class)
+            ->during('beforeSuite', [$event]);
+    }
+
+    public function it_will_throw_if_the_directory_parameter_is_missing(SuiteEvent $event)
+    {
+        $this->setOptions([
+            'whitelist' => [
+                ['foobar' => 'baz', 'suffix' => 'Spec.php', 'prefix' => 'Get'],
+            ],
+        ]);
+
+        $this
+            ->shouldThrow(ConfigurationException::class)
+            ->during('beforeSuite', [$event]);
+    }
+
     public function let(ConsoleIO $io)
     {
         $codeCoverage = new CodeCoverage(new DriverStub(), new Filter());

src/Exception/ConfigurationException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FriendsOfPhpSpec\PhpSpec\CodeCoverage\Exception;
+
+use InvalidArgumentException;
+
+class ConfigurationException extends InvalidArgumentException
+{
+}

src/Listener/CodeCoverageListener.php

@@ -14,13 +14,18 @@
 
 namespace FriendsOfPhpSpec\PhpSpec\CodeCoverage\Listener;
 
+use FriendsOfPhpSpec\PhpSpec\CodeCoverage\Exception\ConfigurationException;
 use PhpSpec\Console\ConsoleIO;
 use PhpSpec\Event\ExampleEvent;
 use PhpSpec\Event\SuiteEvent;
 use SebastianBergmann\CodeCoverage\CodeCoverage;
 use SebastianBergmann\CodeCoverage\Report;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
+use function gettype;
+use function is_array;
+use function is_string;
+
 /**
  * @author Henrik Bjornskov
  */
@@ -146,11 +151,15 @@ public function beforeSuite(SuiteEvent $event): void
         $filter = $this->coverage->filter();
 
         foreach ($this->options['whitelist'] as $option) {
-            $filter->includeDirectory($option);
+            $settings = $this->filterDirectoryParams($option);
+
+            $filter->includeDirectory($settings['directory'], $settings['suffix'], $settings['prefix']);
         }
 
         foreach ($this->options['blacklist'] as $option) {
-            $filter->excludeDirectory($option);
+            $settings = $this->filterDirectoryParams($option);
+
+            $filter->excludeDirectory($settings['directory'], $settings['suffix'], $settings['prefix']);
         }
 
         $filter->includeFiles($this->options['whitelist_files']);
@@ -180,4 +189,33 @@ public function setOptions(array $options): void
     {
         $this->options = $options + $this->options;
     }
+
+    /**
+     * @param array<string, string>|string $option
+     *
+     * @return array{directory:string, prefix:string, suffix:string}
+     */
+    protected function filterDirectoryParams($option): array
+    {
+        if (is_string($option)) {
+            $option = ['directory' => $option];
+        }
+
+        if (!is_array($option)) {
+            throw new ConfigurationException(sprintf(
+                'Directory filtering options must be a string or an associated array, %s given instead.',
+                gettype($option)
+            ));
+        }
+
+        if (!isset($option['directory'])) {
+            throw new ConfigurationException('Missing required directory path.');
+        }
+
+        return [
+            'directory' => $option['directory'],
+            'suffix' => $option['suffix'] ?? '.php',
+            'prefix' => $option['prefix'] ?? '',
+        ];
+    }
 }