Merge pull request #490 from symfony-cmf/cs-fixer

Cs fixer
symfony-cmf · Apr 6, 2024 · d88640b · d88640b
2 parents 389449f + f2ca0bb
commit d88640b
Show file tree

Hide file tree

Showing 53 changed files with 375 additions and 735 deletions.
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -0,0 +1,48 @@
+name: Static analysis
+
+on:
+  push:
+    branches:
+      - '[0-9]+.x'
+      - '[0-9]+.[0-9]+'
+      - '[0-9]+.[0-9]+.x'
+  pull_request:
+
+jobs:
+  phpstan:
+    name: PHPStan
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.3'
+          extensions: "curl,dom,json,xml,dom"
+          coverage: none
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      # have to install phpstan ourselves here, the phpstan-ga fails at composer install with weird errors
+          #          composer require --no-update jackalope/jackalope-doctrine-dbal jackalope/jackalope-jackrabbit phpstan/phpstan
+      - name: Install phpstan
+        run: |
+
+          composer update
+
+      - name: PHPStan
+        run: vendor/bin/phpstan analyze --no-progress
+
+  php-cs-fixer:
+    name: PHP-CS-Fixer
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: PHP-CS-Fixer
+        uses: docker://oskarstark/php-cs-fixer-ga
+        with:
+          args: --dry-run --diff
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,5 @@ phpunit.xml
 composer.lock
 vendor
 tests/Fixtures/App/var/
-.phpunit.result.cache 
+.phpunit.result.cache
+.php-cs-fixer.cache
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -0,0 +1,19 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__.'/src')
+    ->in(__DIR__.'/tests')
+    ->exclude('tests/Fixtures/App/var/')
+    ->name('*.php')
+;
+
+$config = new PhpCsFixer\Config();
+
+return $config
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony' => true,
+        'single_line_throw' => false,
+    ])
+    ->setFinder($finder)
+;
diff --git a/.styleci.yml b/.styleci.yml
diff --git a/composer.json b/composer.json
@@ -26,6 +26,11 @@
         "doctrine/phpcr-bundle": "^3.0",
         "doctrine/phpcr-odm": "^2.0",
         "jackalope/jackalope-doctrine-dbal": "^2.0",
+        "phpstan/phpstan": "^1.10",
+        "phpstan/phpstan-doctrine": "^1.3",
+        "phpstan/phpstan-phpunit": "^1.3",
+        "phpstan/phpstan-symfony": "^1.3",
+        "phpunit/phpunit": "^9.5.28",
         "matthiasnoback/symfony-dependency-injection-test": "^4.1.0 || ^5.1.0",
         "matthiasnoback/symfony-config-test": "^4.1.0 || ^5.1.0",
         "symfony/phpunit-bridge": "^7.0.3",
@@ -47,6 +52,7 @@
     "conflict": {
         "doctrine/common": "<3.1.1",
         "doctrine/persistence": "<1.3.0",
+        "doctrine/phpcr-odm": "<2.0",
         "symfony/doctrine-bridge": "<6.4.0",
         "symfony/security-core": "<6.4.0"
     },

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -0,0 +1,15 @@
+includes:
+  - vendor/phpstan/phpstan-doctrine/extension.neon
+  - vendor/phpstan/phpstan-doctrine/rules.neon
+  - vendor/phpstan/phpstan-phpunit/extension.neon
+  - vendor/phpstan/phpstan-symfony/extension.neon
+  - vendor/phpstan/phpstan-symfony/rules.neon
+parameters:
+    level: 2
+    paths:
+        - src/
+        - tests/
+    excludePaths:
+        - tests/Fixtures/App/var/
+        - tests/Fixtures/App/config/
+        - tests/Fixtures/fixtures/config/
diff --git a/src/DependencyInjection/CmfRoutingExtension.php b/src/DependencyInjection/CmfRoutingExtension.php
@@ -27,9 +27,6 @@
  */
 final class CmfRoutingExtension extends Extension
 {
-    /**
-     * {@inheritdoc}
-     */
     public function load(array $configs, ContainerBuilder $container): void
     {
         $config = $this->processConfiguration(new Configuration(), $configs);

diff --git a/src/Doctrine/Orm/ContentRepository.php b/src/Doctrine/Orm/ContentRepository.php
@@ -37,8 +37,6 @@ protected function getModelAndId(string $identifier): array
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @param string $id The ID contains both model name and id, separated by a colon
      */
     public function findById(mixed $id): ?object

diff --git a/src/Doctrine/Orm/RedirectRoute.php b/src/Doctrine/Orm/RedirectRoute.php
@@ -52,9 +52,6 @@ public function setParameters(array $parameters): void
         $this->serialisedParameters = json_encode($parameters, \JSON_THROW_ON_ERROR);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getParameters(): array
     {
         if (!isset($this->serialisedParameters)) {
@@ -65,9 +62,6 @@ public function getParameters(): array
         return \is_array($params) ? $params : [];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getPath(): string
     {
         $pattern = parent::getPath();
@@ -78,9 +72,6 @@ public function getPath(): string
         return $pattern;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     protected function isBooleanOption(string $name): bool
     {
         return 'add_trailing_slash' === $name || parent::isBooleanOption($name);

diff --git a/src/Doctrine/Orm/Route.php b/src/Doctrine/Orm/Route.php
@@ -58,9 +58,6 @@ public function getPosition(): int
         return $this->position;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getRouteKey(): string
     {
         return $this->getName();

diff --git a/src/Doctrine/Orm/RouteProvider.php b/src/Doctrine/Orm/RouteProvider.php
@@ -41,9 +41,6 @@ public function __construct(ManagerRegistry $managerRegistry, CandidatesInterfac
         $this->candidatesStrategy = $candidatesStrategy;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getRouteCollectionForRequest(Request $request): RouteCollection
     {
         $collection = new RouteCollection();
@@ -52,18 +49,15 @@ public function getRouteCollectionForRequest(Request $request): RouteCollection
         if (0 === \count($candidates)) {
             return $collection;
         }
-        $routes = $this->getRouteRepository()->findByStaticPrefix($candidates, ['position' => 'ASC']);
-        /** @var $route Route */
+        $routes = $this->getRouteRepository()->findByStaticPrefix($candidates, ['position' => 'ASC']); /* @phpstan-ignore-line */
+        /** @var Route $route */
         foreach ($routes as $route) {
             $collection->add($route->getName(), $route);
         }
 
         return $collection;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getRouteByName($name): SymfonyRoute
     {
         if (!$this->candidatesStrategy->isCandidate($name)) {
@@ -78,9 +72,6 @@ public function getRouteByName($name): SymfonyRoute
         return $route;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getRoutesByNames($names = null): array
     {
         if (null === $names) {
@@ -90,7 +81,7 @@ public function getRoutesByNames($names = null): array
 
             try {
                 return $this->getRouteRepository()->findBy([], null, $this->routeCollectionLimit ?: null);
-            } catch (TableNotFoundException $e) {
+            } catch (TableNotFoundException) {
                 return [];
             }
         }
@@ -100,7 +91,7 @@ public function getRoutesByNames($names = null): array
             // TODO: if we do findByName with multivalue, we need to filter with isCandidate afterwards
             try {
                 $routes[] = $this->getRouteByName($name);
-            } catch (RouteNotFoundException $e) {
+            } catch (RouteNotFoundException) {
                 // not found
             }
         }

diff --git a/src/Doctrine/Phpcr/ContentRepository.php b/src/Doctrine/Phpcr/ContentRepository.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr;
 
+use Doctrine\ODM\PHPCR\DocumentManagerInterface;
 use Symfony\Cmf\Bundle\RoutingBundle\Doctrine\DoctrineProvider;
 use Symfony\Cmf\Component\Routing\ContentRepositoryInterface;
 
@@ -25,17 +26,11 @@
  */
 class ContentRepository extends DoctrineProvider implements ContentRepositoryInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function findById($id): ?object
     {
         return $this->getObjectManager()->find(null, $id);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getContentId($content): ?string
     {
         if (!\is_object($content)) {
@@ -48,4 +43,17 @@ public function getContentId($content): ?string
             return null;
         }
     }
+
+    /**
+     * Make sure the manager is a PHPCR-ODM manager.
+     */
+    protected function getObjectManager(): DocumentManagerInterface
+    {
+        $dm = parent::getObjectManager();
+        if (!$dm instanceof DocumentManagerInterface) {
+            throw new \LogicException(sprintf('Expected %s, got %s', DocumentManagerInterface::class, get_class($dm)));
+        }
+
+        return $dm;
+    }
 }
diff --git a/src/Doctrine/Phpcr/PrefixCandidates.php b/src/Doctrine/Phpcr/PrefixCandidates.php
@@ -47,7 +47,7 @@ final class PrefixCandidates extends Candidates
      *                                       is using
      * @param int                  $limit    Limit to candidates generated per prefix
      */
-    public function __construct(array $prefixes, array $locales = [], ManagerRegistry $doctrine = null, int $limit = 20)
+    public function __construct(array $prefixes, array $locales = [], ?ManagerRegistry $doctrine = null, int $limit = 20)
     {
         parent::__construct($locales, $limit);
         $this->setPrefixes($prefixes);
@@ -74,8 +74,6 @@ public function isCandidate($name): bool
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @param QueryBuilder $queryBuilder
      */
     public function restrictQuery($queryBuilder): void
@@ -91,9 +89,6 @@ public function restrictQuery($queryBuilder): void
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getCandidates(Request $request): array
     {
         $candidates = [];