added phpstan config file, raised phpstan level to 2

heimrichhannot · Nov 18, 2022 · 5c85296 · 5c85296
1 parent 0f3b586
commit 5c85296
Show file tree

Hide file tree

Showing 9 changed files with 37 additions and 29 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -74,4 +74,4 @@ jobs:
         run: composer install --no-interaction
 
       - name: PHPStan
-        run: vendor/bin/phpstan analyse src/ tests/ --level=1
+        run: vendor/bin/phpstan analyse -c phpstan.neon
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![Total Downloads](https://img.shields.io/packagist/dt/heimrichhannot/contao-encore-bundle.svg)](https://packagist.org/packages/heimrichhannot/contao-encore-bundle)
 ![CI](https://github.com/heimrichhannot/contao-encore-bundle/workflows/CI/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/heimrichhannot/contao-encore-bundle/badge.svg?branch=master)](https://coveralls.io/github/heimrichhannot/contao-encore-bundle?branch=master)
-![](https://img.shields.io/badge/PHPStan-level%201-brightgreen.svg?style=flat)
+![](https://img.shields.io/badge/PHPStan-level%202-brightgreen.svg?style=flat)
 
 Use the power and simplicity of symfony webpack encore in contao. This bundle let you decide on layout and page level, which encore entries should be loaded. If you want more, you can prepare your bundles define their own encore entries, so never need to manually add or remove encore entries again.
 

diff --git a/composer.json b/composer.json
@@ -45,7 +45,8 @@
     "php-coveralls/php-coveralls": "^2.0",
     "symfony/phpunit-bridge": "^3.2 || ^4.0 || ^5.0 || ^6.0",
     "heimrichhannot/contao-test-utilities-bundle": "^0.1.4",
-    "phpstan/phpstan": "^1.8"
+    "phpstan/phpstan": "^1.8",
+    "phpstan/phpstan-symfony": "^1.2"
   },
   "autoload": {
     "psr-4": {

diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,19 @@
+parameters:
+  level: 2
+  paths:
+    - src
+    - tests
+  universalObjectCratesClasses:
+    - Contao\LayoutModel
+    - Contao\Model
+    - Contao\Template
+    - PHPUnit\Framework\MockObject\MockObject
+  ignoreErrors:
+    - message: '#^Call to an undefined method PHPUnit\\Framework\\MockObject\\MockObject\:\:setName\(\)\.$#'
+      path: tests/EventListener/Contao/ParseTemplateListenerTest.php
+    - message: '#^Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition\:\:getChildNodeDefinitions\(\)\.$#'
+      path: tests/DependencyInjection/ConfigurationTest.php
+    - message: '#^Call to an undefined method Symfony\\Component\\Config\\Definition\\NodeInterface\:\:getChildren\(\)\.$#'
+      path: tests/DependencyInjection/ConfigurationTest.php
+includes:
+  - vendor/phpstan/phpstan-symfony/extension.neon
diff --git a/src/Asset/EntrypointsJsonLookup.php b/src/Asset/EntrypointsJsonLookup.php
@@ -10,6 +10,7 @@
 
 use Contao\LayoutModel;
 use Psr\Cache\CacheItemPoolInterface;
+use Psr\Cache\InvalidArgumentException;
 
 /**
  * @deprecated Use EntryCollection instead
@@ -39,9 +40,10 @@ public function __construct(array $bundleConfig, CacheItemPoolInterface $cache =
     }
 
     /**
-     * @param array       $entrypointJsonFiles    entrypoint json files
-     * @param array       $bundleConfigEntries    Entries defined by encore bundle config
-     * @param string|null $babelPolyfillEntryName entry name of babel polyfill
+     * @param array $entrypointJsonFiles entrypoint json files
+     * @param array $bundleConfigEntries Entries defined by encore bundle config
+     *
+     * @throws InvalidArgumentException
      */
     public function mergeEntries(array $entrypointJsonFiles, array $bundleConfigEntries, LayoutModel $layout = null): array
     {

diff --git a/src/Collection/EntryCollection.php b/src/Collection/EntryCollection.php
@@ -47,9 +47,10 @@ public function getEntries(): array
     }
 
     /**
-     * @param array       $entrypointJsonFiles    entrypoint json files
-     * @param array       $bundleConfigEntries    Entries defined by encore bundle config
-     * @param string|null $babelPolyfillEntryName entry name of babel polyfill
+     * @param array $entrypointJsonFiles entrypoint json files
+     * @param array $bundleConfigEntries Entries defined by encore bundle config
+     *
+     * @throws NoEntrypointsException
      */
     private function mergeEntries(array $entrypointJsonFiles, array $bundleConfigEntries, LayoutModel $layout = null): array
     {

diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright (c) 2021 Heimrich & Hannot GmbH
+ * Copyright (c) 2022 Heimrich & Hannot GmbH
  *
  * @license LGPL-3.0-or-later
  */
@@ -17,14 +17,7 @@ public function getConfigTreeBuilder()
     {
         $treeBuilder = new TreeBuilder('huh_encore');
 
-        // Keep compatibility with symfony/config < 4.2
-        if (!method_exists($treeBuilder, 'getRootNode')) {
-            $rootNode = $treeBuilder->root('huh_encore');
-        } else {
-            $rootNode = $treeBuilder->getRootNode();
-        }
-
-        $rootNode
+        $treeBuilder->getRootNode()
             ->children()
                 ->booleanNode('use_contao_template_variables')
                     ->defaultFalse()
@@ -110,14 +103,7 @@ public function getConfigTreeBuilder()
     public function addLegacyNode()
     {
         $treeBuilder = new TreeBuilder('encore');
-
-        // Keep compatibility with symfony/config < 4.2
-        if (!method_exists($treeBuilder, 'getRootNode')) {
-            $node = $treeBuilder->root('encore');
-        } else {
-            $node = $treeBuilder->getRootNode();
-        }
-
+        $node = $treeBuilder->getRootNode();
         $node
             ->addDefaultsIfNotSet()
             ->setDeprecated('Configs within encore key are deprecated and will be removed in next major version.')

diff --git a/src/EventListener/Contao/ReplaceDynamicScriptTagsListener.php b/src/EventListener/Contao/ReplaceDynamicScriptTagsListener.php
@@ -66,10 +66,10 @@ public function __invoke(string $buffer): string
 
         $pageModel->loadDetails();
 
-        /** @var LayoutModel|null $layout */
         if (!($layout = $this->contaoFramework->getAdapter(LayoutModel::class)->findByPk(($pageModel->layoutId ?? $pageModel->layout)))) {
             return $buffer;
         }
+        /* @var LayoutModel|null $layout */
 
         if (!isset($this->bundleConfig['use_contao_template_variables']) || true !== $this->bundleConfig['use_contao_template_variables']) {
             $buffer = $this->replaceEncoreTags($buffer, $pageModel, $layout);

diff --git a/src/Helper/ArrayHelper.php b/src/Helper/ArrayHelper.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * Copyright (c) 2021 Heimrich & Hannot GmbH
+ * Copyright (c) 2022 Heimrich & Hannot GmbH
  *
  * @license LGPL-3.0-or-later
  */
@@ -15,7 +15,6 @@ class ArrayHelper
      *
      * @param $array
      * @param $key
-     * @param bool $flip
      *
      * @return array
      */