Merge pull request #42 from lcobucci/improve-type-declaration

Improve type declaration

.travis.yml

@@ -57,7 +57,7 @@ jobs:
         - mv ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini{.disabled,}
         - if [[ ! $(php -m | grep -si xdebug) ]]; then echo "xdebug required for mutation"; exit 1; fi
       script:
-        - ./vendor/bin/infection -s --min-msi=98 --min-covered-msi=98 --threads=$(nproc)
+        - ./vendor/bin/infection -s --min-msi=100 --min-covered-msi=100 --threads=$(nproc)
 
     - stage: Quality
       env: STATIC_ANALYSIS=1

composer.json

@@ -25,6 +25,7 @@
         "infection/infection": "^0.15",
         "lcobucci/coding-standard": "^4.0",
         "mikey179/vfsstream": "^1.6.8",
+        "phpstan/extension-installer": "^1.0",
         "phpstan/phpstan": "^0.12",
         "phpstan/phpstan-deprecation-rules": "^0.12",
         "phpstan/phpstan-phpunit": "^0.12",

phpstan.neon.dist

@@ -1,12 +1,5 @@
-includes:
-    - vendor/phpstan/phpstan-phpunit/extension.neon
-    - vendor/phpstan/phpstan-phpunit/rules.neon
-    - vendor/phpstan/phpstan-strict-rules/rules.neon
-    - vendor/phpstan/phpstan-deprecation-rules/rules.neon
-
 parameters:
     level: 7
     paths:
         - src
         - test
-    checkMissingIterableValueType: false 

src/Compiler.php

@@ -16,6 +16,7 @@
 use function class_exists;
 use function dirname;
 use function is_array;
+use function is_int;
 use function is_string;
 
 final class Compiler
@@ -55,13 +56,15 @@ private function configurePassList(
         ContainerConfiguration $config
     ): void {
         foreach ($config->getPassList() as $passConfig) {
-            assert(is_array($passConfig));
             [$pass, $type, $priority] = $passConfig + self::DEFAULT_PASS_CONFIG;
+            assert(is_string($type));
+            assert(is_int($priority));
 
             if (! $pass instanceof CompilerPassInterface) {
                 [$className, $constructArguments] = $pass;
 
                 $pass = new $className(...$constructArguments);
+                assert($pass instanceof CompilerPassInterface);
             }
 
             $container->addCompilerPass($pass, $type, $priority);

src/CompilerPassListProvider.php

@@ -5,8 +5,12 @@
 
 use Generator as DefaultGenerator;
 use Lcobucci\DependencyInjection\Config\Package;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 
 interface CompilerPassListProvider extends Package
 {
+    /**
+     * @return DefaultGenerator<array<CompilerPassInterface|string|int|array<string|array<mixed>>>>
+     */
     public function getCompilerPasses(): DefaultGenerator;
 }

src/Config/ContainerConfiguration.php

@@ -28,7 +28,7 @@ final class ContainerConfiguration
     private array $files;
 
     /**
-     * @var mixed[]
+     * @var array<int, array<int, CompilerPassInterface|string|int|array<string|array<mixed>>>>
      */
     private array $passList;
 
@@ -97,6 +97,9 @@ public function addPackage(string $className, array $constructArguments = []): v
         $this->packages[] = [$className, $constructArguments];
     }
 
+    /**
+     * @return Generator<string>
+     */
     public function getFiles(): Generator
     {
         foreach ($this->filterPackages(FileListProvider::class) as $package) {
@@ -126,6 +129,9 @@ public function addFile(string $file): void
         $this->files[] = $file;
     }
 
+    /**
+     * @return Generator<array<CompilerPassInterface|string|int|array<int, string|array<mixed>>>>
+     */
     public function getPassList(): Generator
     {
         foreach ($this->filterPackages(CompilerPassListProvider::class) as $package) {

src/FileListProvider.php

@@ -8,5 +8,8 @@
 
 interface FileListProvider extends Package
 {
+    /**
+     * @return DefaultGenerator<string>
+     */
     public function getFiles(): DefaultGenerator;
 }

test/CompilerTest.php

@@ -14,7 +14,6 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Config\ConfigCache;
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
-use function assert;
 use function count;
 use function file_put_contents;
 use function iterator_to_array;
@@ -86,8 +85,6 @@ public function compileShouldCreateMultipleFiles(): void
         self::assertCount(count($expectedFiles), $generatedFiles);
 
         foreach ($generatedFiles as $name => $file) {
-            assert($file instanceof vfsStreamFile);
-
             self::assertContains($name, $expectedFiles);
             self::assertSame($expectedPermissions, $file->getPermissions());
         }
@@ -141,6 +138,9 @@ public function compilationShouldBeSkippedWhenFileAlreadyExists(): void
         self::assertCount(1, $generatedFiles);
     }
 
+    /**
+     * @return PHPGenerator<string, vfsStreamFile>
+     */
     private function getGeneratedFiles(vfsStreamDirectory $directory): PHPGenerator
     {
         foreach ($directory->getChildren() as $child) {
@@ -150,9 +150,11 @@ private function getGeneratedFiles(vfsStreamDirectory $directory): PHPGenerator
                 continue;
             }
 
-            if ($child->getName() !== 'services.yml') {
-                yield $child->getName() => $child;
+            if (! $child instanceof vfsStreamFile || $child->getName() === 'services.yml') {
+                continue;
             }
+
+            yield $child->getName() => $child;
         }
     }
 }

test/Config/ContainerConfigurationTest.php

@@ -62,6 +62,9 @@ public function getFilesShouldYieldTheFilesFromPackagesFirst(): void
     {
         $package1 = new class implements CompilerPassListProvider
         {
+            /**
+             * @return Generator<array<CompilerPassInterface|string|int|array<string|array<mixed>>>>
+             */
             public function getCompilerPasses(): Generator
             {
                 yield [CompilerPassInterface::class, 'beforeOptimization'];
@@ -70,6 +73,9 @@ public function getCompilerPasses(): Generator
 
         $package2 = new class implements FileListProvider
         {
+            /**
+             * @return Generator<string>
+             */
             public function getFiles(): Generator
             {
                 yield 'services2.xml';

test/ContainerBuilderTest.php

@@ -15,6 +15,7 @@
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use function get_class;
+use function iterator_to_array;
 
 final class ContainerBuilderTest extends TestCase
 {
@@ -278,7 +279,7 @@ public function getContainerShouldGenerateAndReturnTheContainer(): void
 
         $this->generator->expects(self::once())
                         ->method('generate')
-                        ->with($this->config, self::equalTo(new ConfigCache($this->config->getDumpFile(), false)))
+                        ->with($this->config, new ConfigCache($this->config->getDumpFile(), false))
                         ->willReturn($container);
 
         self::assertSame($container, $builder->getContainer());
@@ -307,9 +308,13 @@ public function getTestContainerShouldGenerateAndReturnTheContainer(): void
 
         $this->generator->expects(self::once())
                         ->method('generate')
-                        ->with(self::equalTo($config), self::equalTo($cacheConfig))
+                        ->with($config, $cacheConfig)
                         ->willReturn($container);
 
         self::assertSame($container, $builder->getTestContainer());
+
+        $compilerPasses = iterator_to_array($this->config->getPassList());
+        self::assertCount(1, $compilerPasses);
+        self::assertSame($this->parameterBag, $compilerPasses[0][0]);
     }
 }