build: increase PHPStan analysis level to 8

- Removed missingType.generics suppression by adding proper generic
  type annotations to AbstractFilter, AbstractProvider,
  ProviderInterface, BetweenFilter, and OnFilter
- Added runtime instanceof ProviderInterface guard in Yasumi::create()
  and throw ProviderNotFoundException if not satisfied
- Added is_string() guard after preg_replace() in getProviders() and
  narrow return type PHPDoc to array<string, string>
- Fixed null-unsafe usage of getHoliday() result in examples/basic.php
- Added test covering the new ProviderInterface guard in create()

Signed-off-by: Sacha Telgenhof <me@sachatelgenhof.com>

Author: stelgenhof

examples/basic.php

@@ -43,18 +43,20 @@
 // Get a holiday instance for Independence Day
 $independenceDay = $holidays->getHoliday('independenceDay');
 
-// Show the localized name
-echo 'Name of the holiday : ' . $independenceDay->getName() . PHP_EOL;
+if (null !== $independenceDay) {
+    // Show the localized name
+    echo 'Name of the holiday : ' . $independenceDay->getName() . PHP_EOL;
 
-// Show the date
-echo "Date of the holiday : {$independenceDay}" . PHP_EOL;
+    // Show the date
+    echo "Date of the holiday : {$independenceDay}" . PHP_EOL;
 
-// Show the type of holiday
-echo 'Type of holiday     : ' . $independenceDay->getType() . PHP_EOL;
+    // Show the type of holiday
+    echo 'Type of holiday     : ' . $independenceDay->getType() . PHP_EOL;
+}
 echo PHP_EOL;
 
 // Dump the holiday as a JSON object
 echo 'Holiday as a JSON object:' . PHP_EOL;
-echo json_encode($independenceDay, JSON_PRETTY_PRINT);
+echo json_encode($independenceDay ?? [], JSON_PRETTY_PRINT);
 
 echo PHP_EOL;

phpstan.neon.dist

@@ -1,14 +1,12 @@
 parameters:
-  level: 6
+  level: 8
   paths:
     - src
     - examples
   ignoreErrors:
     -
       message: '#Comparison operation "<=" between [0-9]+ and int<[0-9]+, max> is always true.#'
       path: src/Yasumi/Provider/Turkey.php
-    -
-      identifier: missingType.generics
   reportUnmatchedIgnoredErrors: true # Do not allow outdated errors in the baseline
   treatPhpDocTypesAsCertain: false
   tipsOfTheDay: false

src/Yasumi/Filters/AbstractFilter.php

@@ -17,8 +17,10 @@
 
 namespace Yasumi\Filters;
 
+use Yasumi\Holiday;
 use Yasumi\SubstituteHoliday;
 
+/** @extends \FilterIterator<string, Holiday, \Iterator<string, Holiday>> */
 abstract class AbstractFilter extends \FilterIterator implements \Countable
 {
     /**

src/Yasumi/Filters/BetweenFilter.php

@@ -17,8 +17,6 @@
 
 namespace Yasumi\Filters;
 
-use Yasumi\ProviderInterface;
-
 /**
  * BetweenFilter is a class used for filtering holidays based on given date range.
  *
@@ -40,11 +38,11 @@ class BetweenFilter extends AbstractFilter
     /**
      * Construct the Between FilterIterator Object.
      *
-     * @param \Iterator<ProviderInterface> $iterator  Iterator object of the Holidays Provider
-     * @param \DateTimeInterface           $startDate Start date of the time frame to check against
-     * @param \DateTimeInterface           $endDate   End date of the time frame to check against
-     * @param bool                         $equal     Indicate whether the start and end dates should be included in the
-     *                                                comparison
+     * @param \Iterator<string, \Yasumi\Holiday> $iterator  Iterator object of the Holidays Provider
+     * @param \DateTimeInterface                 $startDate Start date of the time frame to check against
+     * @param \DateTimeInterface                 $endDate   End date of the time frame to check against
+     * @param bool                               $equal     Indicate whether the start and end dates should be included in the
+     *                                                      comparison
      */
     public function __construct(
         \Iterator $iterator,

src/Yasumi/Filters/OnFilter.php

@@ -17,8 +17,6 @@
 
 namespace Yasumi\Filters;
 
-use Yasumi\ProviderInterface;
-
 /**
  * OnFilter is a class used for filtering holidays based on a given date.
  *
@@ -36,8 +34,8 @@ class OnFilter extends AbstractFilter
     /**
      * Construct the On FilterIterator Object.
      *
-     * @param \Iterator<ProviderInterface> $iterator Iterator object of the Holidays Provider
-     * @param \DateTimeInterface           $date     Start date of the time frame to check against
+     * @param \Iterator<string, \Yasumi\Holiday> $iterator Iterator object of the Holidays Provider
+     * @param \DateTimeInterface                 $date     Start date of the time frame to check against
      */
     public function __construct(
         \Iterator $iterator,

src/Yasumi/Provider/AbstractProvider.php

@@ -28,6 +28,8 @@
 
 /**
  * Class AbstractProvider.
+ *
+ * @implements \IteratorAggregate<string, Holiday>
  */
 abstract class AbstractProvider implements \Countable, ProviderInterface, \IteratorAggregate
 {
@@ -236,6 +238,7 @@ public function between(
         return new BetweenFilter($this->getIterator(), $startDate, $endDate, $equals ?? true);
     }
 
+    /** @return \ArrayIterator<string, Holiday> */
     public function getIterator(): \ArrayIterator
     {
         $this->ensureSorted();

src/Yasumi/ProviderInterface.php

@@ -89,7 +89,7 @@ public function isHoliday(\DateTimeInterface $date): bool;
     /**
      * Get an iterator for the holidays.
      *
-     * @return \ArrayIterator iterator for the holidays of this calendar
+     * @return \ArrayIterator<string, Holiday> iterator for the holidays of this calendar
      */
     public function getIterator(): \ArrayIterator;
 

src/Yasumi/Yasumi.php

@@ -150,7 +150,13 @@ public static function create(string $class, int $year = self::YEAR_LOWER_BOUND,
             throw new UnknownLocaleException(sprintf('Locale "%s" is not a valid locale.', $locale));
         }
 
-        return new $providerClass($year, $locale, self::$globalTranslations);
+        $instance = new $providerClass($year, $locale, self::$globalTranslations);
+
+        if (! $instance instanceof ProviderInterface) {
+            throw new ProviderNotFoundException(sprintf('Holiday provider "%s" does not implement ProviderInterface.', $class));
+        }
+
+        return $instance;
     }
 
     /**
@@ -200,7 +206,7 @@ public static function createByISO3166_2(
     /**
      * Returns a list of available holiday providers.
      *
-     * @return array<string, array<array-key, string>|string|null> list of available holiday providers
+     * @return array<string, string> list of available holiday providers
      *
      * @throws \ReflectionException
      */
@@ -238,7 +244,13 @@ public static function getProviders(): array
             $quotedDs = preg_quote(\DIRECTORY_SEPARATOR, '');
             $provider = preg_replace("#^.+{$quotedDs}Provider{$quotedDs}(.+)\\.php$#", '$1', $file->getPathName());
 
-            $class = new \ReflectionClass(sprintf('Yasumi\Provider\%s', str_replace('/', '\\', $provider)));
+            if (! is_string($provider)) {
+                continue;
+            }
+
+            /** @var class-string $providerClass */
+            $providerClass = sprintf('Yasumi\Provider\%s', str_replace('/', '\\', $provider));
+            $class = new \ReflectionClass($providerClass);
 
             $key = 'ID';
 

tests/Base/YasumiTest.php

@@ -61,6 +61,14 @@ public function testCreateWithAbstractClassProvider(): void
         Yasumi::create('AbstractProvider');
     }
 
+    public function testCreateWithClassNotImplementingProviderInterface(): void
+    {
+        $this->expectException(ProviderNotFoundException::class);
+
+        $class = new class {};
+        Yasumi::create($class::class, self::YEAR_LOWER_BOUND);
+    }
+
     public function testCreateWithAbstractExtension(): void
     {
         $class = YasumiExternalProvider::class;