Raise PHPStan's level from 2 to 3

dkarlovi · dkarlovi · commit 3f5fb52c2161 · 2018-01-31T10:33:01.000+01:00
diff --git a/Document/AuthCodeManager.php b/Document/AuthCodeManager.php
@@ -37,8 +37,12 @@ class AuthCodeManager extends BaseAuthCodeManager
 
     public function __construct(DocumentManager $dm, $class)
     {
+        // NOTE: bug in Doctrine, hinting DocumentRepository|ObjectRepository when only DocumentRepository is expected
+        /** @var DocumentRepository $repository */
+        $repository = $dm->getRepository($class);
+
         $this->dm = $dm;
-        $this->repository = $dm->getRepository($class);
+        $this->repository = $repository;
         $this->class = $class;
     }
 
diff --git a/Document/ClientManager.php b/Document/ClientManager.php
@@ -37,8 +37,12 @@ class ClientManager extends BaseClientManager
 
     public function __construct(DocumentManager $dm, $class)
     {
+        // NOTE: bug in Doctrine, hinting DocumentRepository|ObjectRepository when only DocumentRepository is expected
+        /** @var DocumentRepository $repository */
+        $repository = $dm->getRepository($class);
+
         $this->dm = $dm;
-        $this->repository = $dm->getRepository($class);
+        $this->repository = $repository;
         $this->class = $class;
     }
 
diff --git a/Document/TokenManager.php b/Document/TokenManager.php
@@ -37,8 +37,12 @@ class TokenManager extends BaseTokenManager
 
     public function __construct(DocumentManager $dm, $class)
     {
+        // NOTE: bug in Doctrine, hinting DocumentRepository|ObjectRepository when only DocumentRepository is expected
+        /** @var DocumentRepository $repository */
+        $repository = $dm->getRepository($class);
+
         $this->dm = $dm;
-        $this->repository = $dm->getRepository($class);
+        $this->repository = $repository;
         $this->class = $class;
     }
 
diff --git a/Entity/ClientManager.php b/Entity/ClientManager.php
@@ -13,16 +13,15 @@
 
 namespace FOS\OAuthServerBundle\Entity;
 
-use Doctrine\Common\Persistence\ObjectManager;
-use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\EntityRepository;
 use FOS\OAuthServerBundle\Model\ClientInterface;
 use FOS\OAuthServerBundle\Model\ClientManager as BaseClientManager;
 
 class ClientManager extends BaseClientManager
 {
     /**
-     * @var EntityManager
+     * @var EntityManagerInterface
      */
     protected $em;
 
@@ -36,10 +35,14 @@ class ClientManager extends BaseClientManager
      */
     protected $class;
 
-    public function __construct(ObjectManager $em, $class)
+    public function __construct(EntityManagerInterface $em, $class)
     {
+        // NOTE: bug in Doctrine, hinting EntityRepository|ObjectRepository when only EntityRepository is expected
+        /** @var EntityRepository $repository */
+        $repository = $em->getRepository($class);
+
         $this->em = $em;
-        $this->repository = $em->getRepository($class);
+        $this->repository = $repository;
         $this->class = $class;
     }
 
diff --git a/Entity/TokenManager.php b/Entity/TokenManager.php
@@ -13,16 +13,15 @@
 
 namespace FOS\OAuthServerBundle\Entity;
 
-use Doctrine\Common\Persistence\ObjectManager;
-use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\EntityRepository;
 use FOS\OAuthServerBundle\Model\TokenInterface;
 use FOS\OAuthServerBundle\Model\TokenManager as BaseTokenManager;
 
 class TokenManager extends BaseTokenManager
 {
     /**
-     * @var EntityManager
+     * @var EntityManagerInterface
      */
     protected $em;
 
@@ -36,10 +35,14 @@ class TokenManager extends BaseTokenManager
      */
     protected $class;
 
-    public function __construct(ObjectManager $em, $class)
+    public function __construct(EntityManagerInterface $em, $class)
     {
+        // NOTE: bug in Doctrine, hinting EntityRepository|ObjectRepository when only EntityRepository is expected
+        /** @var EntityRepository $repository */
+        $repository = $em->getRepository($class);
+
         $this->em = $em;
-        $this->repository = $em->getRepository($class);
+        $this->repository = $repository;
         $this->class = $class;
     }
 
diff --git a/Makefile b/Makefile
@@ -6,7 +6,7 @@ ci: cs-full-check phpstan phpunit-coverage
 lint: cs-full-check phpstan
 
 phpstan:
-	sh -c "${QA_DOCKER_COMMAND} phpstan analyse --configuration phpstan.neon --level 2 ."
+	sh -c "${QA_DOCKER_COMMAND} phpstan analyse --configuration phpstan.neon --level 3 ."
 
 cs:
 	sh -c "${QA_DOCKER_COMMAND} php-cs-fixer fix -vvv --diff"
diff --git a/Model/ClientManager.php b/Model/ClientManager.php
@@ -31,7 +31,7 @@ public function createClient()
     public function findClientByPublicId($publicId)
     {
         if (false === $pos = mb_strpos($publicId, '_')) {
-            return;
+            return null;
         }
 
         $id = mb_substr($publicId, 0, $pos);
diff --git a/Model/ClientManagerInterface.php b/Model/ClientManagerInterface.php
@@ -26,14 +26,14 @@ public function createClient();
     public function getClass();
 
     /**
-     * @return ClientInterface
+     * @return null|ClientInterface
      */
     public function findClientBy(array $criteria);
 
     /**
      * @param mixed $publicId
      *
-     * @return ClientInterface
+     * @return null|ClientInterface
      */
     public function findClientByPublicId($publicId);
 
diff --git a/Security/Authentication/Provider/OAuthProvider.php b/Security/Authentication/Provider/OAuthProvider.php
@@ -59,12 +59,15 @@ public function __construct(UserProviderInterface $userProvider, OAuth2 $serverS
     /**
      * @param OAuthToken&TokenInterface $token
      *
-     * @return OAuthToken
+     * @return null|OAuthToken
      */
     public function authenticate(TokenInterface $token)
     {
         if (!$this->supports($token)) {
-            return;
+            // note: since strict types in PHP 7, return; and return null; are not the same
+            // Symfony's interface says to "never return null", but return; is still technically null
+            // PHPStan treats return; as return (void);
+            return null;
         }
 
         try {
diff --git a/Tests/Entity/TokenManagerTest.php b/Tests/Entity/TokenManagerTest.php
@@ -14,6 +14,7 @@
 namespace FOS\OAuthServerBundle\Tests\Entity;
 
 use Doctrine\ORM\AbstractQuery;
+use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\EntityRepository;
 use Doctrine\ORM\QueryBuilder;
@@ -53,11 +54,11 @@ class TokenManagerTest extends \PHPUnit\Framework\TestCase
     public function setUp()
     {
         $this->className = AccessToken::class;
-        $this->repository = $this->getMockBuilder('Doctrine\ORM\EntityRepository')
+        $this->repository = $this->getMockBuilder(EntityRepository::class)
             ->disableOriginalConstructor()
             ->getMock()
         ;
-        $this->entityManager = $this->getMockBuilder('Doctrine\ORM\EntityManager')
+        $this->entityManager = $this->getMockBuilder(EntityManager::class)
             ->disableOriginalConstructor()
             ->getMock()
         ;
diff --git a/Tests/Form/Handler/AuthorizeFormHandlerTest.php b/Tests/Form/Handler/AuthorizeFormHandlerTest.php
@@ -89,6 +89,8 @@ public function setUp()
         $this->instance = new AuthorizeFormHandler($this->form, $this->request);
         $this->instance->setContainer($this->container);
 
+        $_GET = [];
+
         parent::setUp();
     }
 
diff --git a/Tests/Functional/BootTest.php b/Tests/Functional/BootTest.php
@@ -24,7 +24,7 @@ public function testBoot($env)
     {
         $this->markTestIncomplete('Issue with Stopwatch component');
 
-        $kernel = $this->createKernel(['env' => $env]);
+        $kernel = static::createKernel(['env' => $env]);
         $kernel->boot();
     }
 
diff --git a/Tests/Functional/TestCase.php b/Tests/Functional/TestCase.php
@@ -15,9 +15,15 @@
 
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\HttpKernel\KernelInterface;
 
 abstract class TestCase extends WebTestCase
 {
+    /**
+     * @var null|KernelInterface
+     */
+    protected static $kernel;
+
     protected function setUp()
     {
         $fs = new Filesystem();
diff --git a/Tests/Security/Authentication/Provider/OAuthProviderTest.php b/Tests/Security/Authentication/Provider/OAuthProviderTest.php
@@ -35,7 +35,7 @@ class OAuthProviderTest extends \PHPUnit\Framework\TestCase
     protected $userProvider;
 
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject|OAuthProvider
+     * @var OAuthProvider
      */
     protected $provider;
 
diff --git a/composer.json b/composer.json
@@ -17,26 +17,29 @@
     ],
     "require": {
         "php": "^7.1",
+        "alcaeus/mongo-php-adapter": "^1.1",
         "friendsofsymfony/oauth2-php": "~1.1",
-        "symfony/framework-bundle": "~3.0|^4.0",
-        "symfony/security-bundle": "~3.0|^4.0",
-        "symfony/dependency-injection": "^2.8|~3.0|^4.0"
+        "symfony/dependency-injection": "~3.0|~4.0",
+        "symfony/framework-bundle": "~3.0|~4.0",
+        "symfony/security-bundle": "~3.0|~4.0"
     },
     "require-dev": {
         "doctrine/doctrine-bundle": "~1.0",
         "doctrine/mongodb-odm": "~1.0",
         "doctrine/orm": "~2.2",
         "phing/phing": "~2.4",
-        "php-mock/php-mock-phpunit": "^1.1",
-        "phpunit/phpunit": "~4.8|~5.0",
-        "propel/propel1": "^1.6.5",
-        "symfony/class-loader": "~3.0|^4.0",
-        "symfony/console": "~3.0|^4.0",
-        "symfony/form": "~3.0|^4.0",
-        "symfony/phpunit-bridge": "~3.0|^4.0",
-        "symfony/templating": "~3.0|^4.0",
-        "symfony/yaml": "~3.0|^4.0",
-        "willdurand/propel-typehintable-behavior": "^1.0.4"
+        "php-mock/php-mock-phpunit": "~1.0|~2.0",
+        "phpstan/phpstan-phpunit": "~0.9",
+        "phpstan/phpstan-shim": "~0.9",
+        "phpunit/phpunit": "~5.0|~6.0",
+        "propel/propel1": "~1.6",
+        "symfony/class-loader": "~3.0|~4.0",
+        "symfony/console": "~3.0|~4.0",
+        "symfony/form": "~3.0|~4.0",
+        "symfony/phpunit-bridge": "~3.0|~4.0",
+        "symfony/templating": "~3.0|~4.0",
+        "symfony/yaml": "~3.0|~4.0",
+        "willdurand/propel-typehintable-behavior": "~1.0"
     },
     "suggest": {
         "doctrine/doctrine-bundle": "*",
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,3 +1,5 @@
+includes:
+    - vendor/phpstan/phpstan-phpunit/extension.neon
 parameters:
     autoload_files:
         - vendor/autoload.php

Original file line number	Diff line number	Diff line change
`@@ -37,8 +37,12 @@ class AuthCodeManager extends BaseAuthCodeManager`
`37`	`37`
`38`	`38`	`public function __construct(DocumentManager $dm, $class)`
`39`	`39`	`{`
	`40`	`+ // NOTE: bug in Doctrine, hinting DocumentRepository\|ObjectRepository when only DocumentRepository is expected`
	`41`	`+ /** @var DocumentRepository $repository */`
	`42`	`+ $repository = $dm->getRepository($class);`
	`43`	`+`
`40`	`44`	`$this->dm = $dm;`
`41`		`- $this->repository = $dm->getRepository($class);`
	`45`	`+ $this->repository = $repository;`
`42`	`46`	`$this->class = $class;`
`43`	`47`	`}`
`44`	`48`
Original file line number	Diff line number	Diff line change
`@@ -37,8 +37,12 @@ class ClientManager extends BaseClientManager`
`37`	`37`
`38`	`38`	`public function __construct(DocumentManager $dm, $class)`
`39`	`39`	`{`
	`40`	`+ // NOTE: bug in Doctrine, hinting DocumentRepository\|ObjectRepository when only DocumentRepository is expected`
	`41`	`+ /** @var DocumentRepository $repository */`
	`42`	`+ $repository = $dm->getRepository($class);`
	`43`	`+`
`40`	`44`	`$this->dm = $dm;`
`41`		`- $this->repository = $dm->getRepository($class);`
	`45`	`+ $this->repository = $repository;`
`42`	`46`	`$this->class = $class;`
`43`	`47`	`}`
`44`	`48`
Original file line number	Diff line number	Diff line change
`@@ -37,8 +37,12 @@ class TokenManager extends BaseTokenManager`
`37`	`37`
`38`	`38`	`public function __construct(DocumentManager $dm, $class)`
`39`	`39`	`{`
	`40`	`+ // NOTE: bug in Doctrine, hinting DocumentRepository\|ObjectRepository when only DocumentRepository is expected`
	`41`	`+ /** @var DocumentRepository $repository */`
	`42`	`+ $repository = $dm->getRepository($class);`
	`43`	`+`
`40`	`44`	`$this->dm = $dm;`
`41`		`- $this->repository = $dm->getRepository($class);`
	`45`	`+ $this->repository = $repository;`
`42`	`46`	`$this->class = $class;`
`43`	`47`	`}`
`44`	`48`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public function createClient()`
`31`	`31`	`public function findClientByPublicId($publicId)`
`32`	`32`	`{`
`33`	`33`	`if (false === $pos = mb_strpos($publicId, '_')) {`
`34`		`- return;`
	`34`	`+ return null;`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`$id = mb_substr($publicId, 0, $pos);`
Original file line number	Diff line number	Diff line change
`@@ -59,12 +59,15 @@ public function __construct(UserProviderInterface $userProvider, OAuth2 $serverS`
`59`	`59`	`/**`
`60`	`60`	`* @param OAuthToken&TokenInterface $token`
`61`	`61`	`*`
`62`		`- * @return OAuthToken`
	`62`	`+ * @return null\|OAuthToken`
`63`	`63`	`*/`
`64`	`64`	`public function authenticate(TokenInterface $token)`
`65`	`65`	`{`
`66`	`66`	`if (!$this->supports($token)) {`
`67`		`- return;`
	`67`	`+ // note: since strict types in PHP 7, return; and return null; are not the same`
	`68`	`+ // Symfony's interface says to "never return null", but return; is still technically null`
	`69`	`+ // PHPStan treats return; as return (void);`
	`70`	`+ return null;`
`68`	`71`	`}`
`69`	`72`
`70`	`73`	`try {`