Adding Codeception tests to improve the feature

Author: nyamsprod

spec/Listener/CodeCoverageListenerSpec.php

@@ -5,12 +5,17 @@
 namespace spec\FriendsOfPhpSpec\PhpSpec\CodeCoverage\Listener;
 
 use FriendsOfPhpSpec\PhpSpec\CodeCoverage\Listener\CodeCoverageListener;
+use InvalidArgumentException;
 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;
+use Throwable;
+use TypeError;
 
 /**
  * Disabled due to tests breaking as php-code-coverage marked their classes
@@ -23,11 +28,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(TypeError::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(Throwable::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(TypeError::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(InvalidArgumentException::class)
+            ->during('beforeSuite', [$event]);
+    }
+
     public function let(ConsoleIO $io)
     {
         $codeCoverage = new CodeCoverage(new DriverStub(), new Filter());

src/Listener/CodeCoverageListener.php

@@ -14,13 +14,17 @@
 
 namespace FriendsOfPhpSpec\PhpSpec\CodeCoverage\Listener;
 
+use InvalidArgumentException;
 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 TypeError;
 
+use function gettype;
+use function is_array;
 use function is_string;
 
 /**
@@ -148,19 +152,15 @@ public function beforeSuite(SuiteEvent $event): void
         $filter = $this->coverage->filter();
 
         foreach ($this->options['whitelist'] as $option) {
-            if (is_string($option)) {
-                $option = ['directory' => $option];
-            }
-            $option = $option + ['suffix' => '.php', 'prefix' => ''];
-            $filter->includeDirectory($option['directory'], $option['suffix'], $option['prefix']);
+            $settings = $this->filterDirectoryParams($option);
+
+            $filter->includeDirectory($settings['directory'], $settings['suffix'], $settings['prefix']);
         }
 
         foreach ($this->options['blacklist'] as $option) {
-            if (is_string($option)) {
-                $option = ['directory' => $option];
-            }
-            $option = $option + ['suffix' => '.php', 'prefix' => ''];
-            $filter->excludeDirectory($option['directory'], $option['suffix'], $option['prefix']);
+            $settings = $this->filterDirectoryParams($option);
+
+            $filter->excludeDirectory($settings['directory'], $settings['suffix'], $settings['prefix']);
         }
 
         $filter->includeFiles($this->options['whitelist_files']);
@@ -190,4 +190,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 TypeError(sprintf(
+                'Directory filtering options must be a string or an associated array, %s given instead.',
+                gettype($option)
+            ));
+        }
+
+        if (!isset($option['directory'])) {
+            throw new InvalidArgumentException('Missing required directory path.');
+        }
+
+        return [
+            'directory' => $option['directory'],
+            'suffix' => $option['suffix'] ?? '.php',
+            'prefix' => $option['prefix'] ?? '',
+        ];
+    }
 }