style #12 Add PHPStan to the build (pamil)

This PR was merged into the 1.3 branch. Discussion ---------- Fixes #5. Commits ------- 9c7b535 Set up PHPStan 4aa535d Improve code to match PHPStan's level 4 ca99d98 Improve code to match PHPStan's level 5 5a3cce9 Improve code to match PHPStan's level 6 8ea9cbe Improve code to match PHPStan's level "max"
Sylius · Feb 20, 2019 · 6dbdfea · 6dbdfea
2 parents 0547431 + 8ea9cbe
commit 6dbdfea
Show file tree

Hide file tree

Showing 10 changed files with 82 additions and 12 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -17,5 +17,7 @@ install:
 script:
     - composer validate --strict
 
+    - composer analyse
+
     - vendor/bin/phpspec run
     - vendor/bin/phpunit
diff --git a/composer.json b/composer.json
@@ -30,31 +30,39 @@
         "zendframework/zend-stdlib": "^3.0"
     },
     "require-dev": {
-        "doctrine/orm": "^2.5",
         "doctrine/doctrine-bundle": "^1.3",
+        "doctrine/orm": "^2.5",
         "matthiasnoback/symfony-config-test": "^4.0",
         "matthiasnoback/symfony-dependency-injection-test": "^3.0",
         "phpspec/phpspec": "^5.0",
+        "phpstan/phpstan-shim": "^0.10",
         "phpunit/phpunit": "^7.0",
-        "twig/twig": "^2.0",
+        "polishsymfonycommunity/symfony-mocker-container": "^1.0",
         "symfony/browser-kit": "^3.4|^4.1.1",
         "symfony/dependency-injection": "^3.4|^4.1.1",
+        "symfony/security-csrf": "^3.4|^4.1.1",
         "symfony/templating": "^3.4|^4.1.1",
         "symfony/translation": "^3.4|^4.1.1",
         "symfony/twig-bundle": "^3.4|^4.1.1",
-        "symfony/security-csrf": "^3.4|^4.1.1",
-        "polishsymfonycommunity/symfony-mocker-container": "^1.0"
+        "twig/twig": "^2.0",
+        "proget-hq/phpstan-phpspec": "^0.1.1",
+        "phpstan/phpstan-phpunit": "^0.10"
     },
     "autoload": {
         "psr-4": { "Sylius\\Bundle\\FixturesBundle\\": "src/" }
     },
     "autoload-dev": {
         "psr-4": {
-            "Sylius\\Bundle\\FixturesBundle\\spec\\": "spec/",
+            "spec\\Sylius\\Bundle\\FixturesBundle\\": "spec/",
             "Sylius\\Bundle\\FixturesBundle\\Tests\\": "tests/"
         },
         "classmap": ["test/app/AppKernel.php"]
     },
+    "scripts": {
+        "analyse": [
+            "@php vendor/bin/phpstan analyse --ansi -c phpstan.neon -l max spec src tests"
+        ]
+    },
     "extra": {
         "branch-alias": {
             "dev-master": "1.3-dev"

diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,15 @@
+includes:
+    - vendor/proget-hq/phpstan-phpspec/extension.neon
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+
+    - vendor/phpstan/phpstan-phpunit/rules.neon
+
+parameters:
+    reportUnmatchedIgnoredErrors: false
+    specDir: 'spec/'
+    ignoreErrors:
+        # PHPStan extension bug
+        - '/proget-hq\/phpstan-phpspec\/src\/NodeVisitor\/CollaboratorResolver\.php/'
+
+        # Replaced `'` with `.`, could not figure out how to escape single quotes
+        - '/^Call to function method_exists\(\) with .Symfony\\\\Component…. and .getRootNode. will always evaluate to false\.$/'
diff --git a/src/Command/FixturesListCommand.php b/src/Command/FixturesListCommand.php
@@ -65,11 +65,19 @@ private function listFixtures(OutputInterface $output): void
 
     private function getSuiteRegistry(): SuiteRegistryInterface
     {
-        return $this->getContainer()->get('sylius_fixtures.suite_registry');
+        $suiteRegistry = $this->getContainer()->get('sylius_fixtures.suite_registry');
+
+        assert($suiteRegistry instanceof SuiteRegistryInterface);
+
+        return $suiteRegistry;
     }
 
     private function getFixtureRegistry(): FixtureRegistryInterface
     {
-        return $this->getContainer()->get('sylius_fixtures.fixture_registry');
+        $fixtureRegistry = $this->getContainer()->get('sylius_fixtures.fixture_registry');
+
+        assert($fixtureRegistry instanceof FixtureRegistryInterface);
+
+        return $fixtureRegistry;
     }
 }
diff --git a/src/Command/FixturesLoadCommand.php b/src/Command/FixturesLoadCommand.php
@@ -47,7 +47,7 @@ protected function execute(InputInterface $input, OutputInterface $output): void
 
             $output->writeln(sprintf(
                 "\n<error>Warning! Loading fixtures will purge your database for the %s environment.</error>\n",
-                $input->getOption('env')
+                $this->getEnvironment()
             ));
 
             if (!$questionHelper->ask($input, $output, new ConfirmationQuestion('Continue? (y/N) ', false))) {
@@ -61,18 +61,34 @@ protected function execute(InputInterface $input, OutputInterface $output): void
     private function loadSuites(InputInterface $input): void
     {
         $suiteName = $input->getArgument('suite');
+
+        assert(is_string($suiteName));
+
         $suite = $this->getSuiteRegistry()->getSuite($suiteName);
 
         $this->getSuiteLoader()->load($suite);
     }
 
     private function getSuiteRegistry(): SuiteRegistryInterface
     {
-        return $this->getContainer()->get('sylius_fixtures.suite_registry');
+        $suiteRegistry = $this->getContainer()->get('sylius_fixtures.suite_registry');
+
+        assert($suiteRegistry instanceof SuiteRegistryInterface);
+
+        return $suiteRegistry;
     }
 
     private function getSuiteLoader(): SuiteLoaderInterface
     {
-        return $this->getContainer()->get('sylius_fixtures.suite_loader');
+        $suiteLoader = $this->getContainer()->get('sylius_fixtures.suite_loader');
+
+        assert($suiteLoader instanceof SuiteLoaderInterface);
+
+        return $suiteLoader;
+    }
+
+    private function getEnvironment(): string
+    {
+        return $this->getContainer()->getParameter('kernel.environment');
     }
 }
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -26,10 +26,14 @@ public function getConfigTreeBuilder(): TreeBuilder
     {
         if (method_exists(TreeBuilder::class, 'getRootNode')) {
             $treeBuilder = new TreeBuilder('sylius_fixtures');
+
+            /** @var ArrayNodeDefinition $rootNode */
             $rootNode = $treeBuilder->getRootNode();
         } else {
             // BC layer for symfony/config 4.1 and older
             $treeBuilder = new TreeBuilder();
+
+            /** @var ArrayNodeDefinition $rootNode */
             $rootNode = $treeBuilder->root('sylius_fixtures');
         }
 

diff --git a/src/DependencyInjection/SyliusFixturesExtension.php b/src/DependencyInjection/SyliusFixturesExtension.php
@@ -13,6 +13,7 @@
 
 namespace Sylius\Bundle\FixturesBundle\DependencyInjection;
 
+use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
@@ -21,6 +22,14 @@
 
 final class SyliusFixturesExtension extends Extension implements PrependExtensionInterface
 {
+    /**
+     * {@inheritdoc}
+     */
+    public function getConfiguration(array $config, ContainerBuilder $container): ConfigurationInterface
+    {
+        return new Configuration();
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/Fixture/AbstractFixture.php b/src/Fixture/AbstractFixture.php
@@ -25,10 +25,14 @@ final public function getConfigTreeBuilder(): TreeBuilder
     {
         if (method_exists(TreeBuilder::class, 'getRootNode')) {
             $treeBuilder = new TreeBuilder($this->getName());
+
+            /** @var ArrayNodeDefinition $optionsNode */
             $optionsNode = $treeBuilder->getRootNode();
         } else {
             // BC layer for symfony/config 4.1 and older
             $treeBuilder = new TreeBuilder();
+
+            /** @var ArrayNodeDefinition $optionsNode */
             $optionsNode = $treeBuilder->root($this->getName());
         }
 

diff --git a/src/Listener/AbstractListener.php b/src/Listener/AbstractListener.php
@@ -25,10 +25,14 @@ final public function getConfigTreeBuilder(): TreeBuilder
     {
         if (method_exists(TreeBuilder::class, 'getRootNode')) {
             $treeBuilder = new TreeBuilder($this->getName());
+
+            /** @var ArrayNodeDefinition $optionsNode */
             $optionsNode = $treeBuilder->getRootNode();
         } else {
             // BC layer for symfony/config 4.1 and older
             $treeBuilder = new TreeBuilder();
+
+            /** @var ArrayNodeDefinition $optionsNode */
             $optionsNode = $treeBuilder->root($this->getName());
         }
 

diff --git a/src/Suite/SuiteInterface.php b/src/Suite/SuiteInterface.php
@@ -21,14 +21,14 @@ interface SuiteInterface
     public function getName(): string;
 
     /**
-     * @return iterable|FixtureInterface[] Fixtures as keys, options as values
+     * @return iterable<FixtureInterface, array> Fixtures as keys, options as values
      */
     public function getFixtures(): iterable;
 
     /**
      * @see \Sylius\Bundle\FixturesBundle\Listener\ListenerInterface
      *
-     * @return iterable|ListenerInterface[] Listeners as keys, options as values
+     * @return iterable<ListenerInterface, array> Listeners as keys, options as values
      */
     public function getListeners(): iterable;
 }