qa: fix failing CS checks and prophecy warnings

- Adds the phpspec/prophecy-phpunit package, and updates all tests that use prophecys to use the `ProphecyTrait` from that package. - Corrects all phpcs issues. Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
mezzio · Jan 6, 2021 · f65c4bf · f65c4bf
1 parent 24d175f
commit f65c4bf
Show file tree

Hide file tree

Showing 16 changed files with 47 additions and 40 deletions.
diff --git a/composer.json b/composer.json
@@ -39,6 +39,7 @@
         "laminas/laminas-coding-standard": "~2.1.0",
         "malukenho/docheader": "^0.1.6",
         "phpspec/prophecy": "^1.9",
+        "phpspec/prophecy-phpunit": "^2.0",
         "phpunit/phpunit": "^9.4.1",
         "psalm/plugin-phpunit": "^0.15.0",
         "vimeo/psalm": "^4.3"

diff --git a/src/Test/AbstractImplicitMethodsIntegrationTest.php b/src/Test/AbstractImplicitMethodsIntegrationTest.php
@@ -119,8 +119,6 @@ public function method(): Generator
 
     /**
      * @dataProvider method
-     *
-     * @return void
      */
     public function testExplicitRequest(string $method, array $routes): void
     {
@@ -202,8 +200,6 @@ public function withoutImplicitMiddleware()
      * returned response should be 405: Method Not Allowed - handled by MethodNotAllowedMiddleware.
      *
      * @dataProvider withoutImplicitMiddleware
-     *
-     * @return void
      */
     public function testWithoutImplicitMiddleware(string $requestMethod, array $allowedMethods): void
     {
@@ -252,8 +248,6 @@ abstract public function implicitRoutesAndRequests(): Generator;
 
     /**
      * @dataProvider implicitRoutesAndRequests
-     *
-     * @return void
      */
     public function testImplicitHeadRequest(
         string $routePath,
@@ -334,8 +328,6 @@ public function testImplicitHeadRequest(
 
     /**
      * @dataProvider implicitRoutesAndRequests
-     *
-     * @return void
      */
     public function testImplicitOptionsRequest(
         string $routePath,

diff --git a/test/Middleware/DispatchMiddlewareFactoryTest.php b/test/Middleware/DispatchMiddlewareFactoryTest.php
@@ -13,10 +13,13 @@
 use Mezzio\Router\Middleware\DispatchMiddleware;
 use Mezzio\Router\Middleware\DispatchMiddlewareFactory;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Psr\Container\ContainerInterface;
 
 class DispatchMiddlewareFactoryTest extends TestCase
 {
+    use ProphecyTrait;
+
     public function testFactoryProducesDispatchMiddleware(): void
     {
         $container  = $this->prophesize(ContainerInterface::class)->reveal();

diff --git a/test/Middleware/DispatchMiddlewareTest.php b/test/Middleware/DispatchMiddlewareTest.php
@@ -14,13 +14,16 @@
 use Mezzio\Router\RouteResult;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 
 class DispatchMiddlewareTest extends TestCase
 {
+    use ProphecyTrait;
+
     /** @var RequestHandlerInterface|ObjectProphecy */
     private $handler;
 

diff --git a/test/Middleware/ImplicitHeadMiddlewareFactoryTest.php b/test/Middleware/ImplicitHeadMiddlewareFactoryTest.php
@@ -15,13 +15,16 @@
 use Mezzio\Router\Middleware\ImplicitHeadMiddlewareFactory;
 use Mezzio\Router\RouterInterface;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Container\ContainerInterface;
 use Psr\Http\Message\StreamInterface;
 use Zend\Expressive\Router\RouterInterface as ZendExpressiveRouterInterface;
 
 class ImplicitHeadMiddlewareFactoryTest extends TestCase
 {
+    use ProphecyTrait;
+
     /** @var ContainerInterface|ObjectProphecy */
     private $container;
 

diff --git a/test/Middleware/ImplicitHeadMiddlewareTest.php b/test/Middleware/ImplicitHeadMiddlewareTest.php
@@ -17,6 +17,7 @@
 use Mezzio\Router\RouterInterface;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -26,6 +27,8 @@
 
 class ImplicitHeadMiddlewareTest extends TestCase
 {
+    use ProphecyTrait;
+
     /** @var ImplicitHeadMiddleware */
     private $middleware;
 

diff --git a/test/Middleware/ImplicitOptionsMiddlewareFactoryTest.php b/test/Middleware/ImplicitOptionsMiddlewareFactoryTest.php
@@ -14,12 +14,15 @@
 use Mezzio\Router\Middleware\ImplicitOptionsMiddleware;
 use Mezzio\Router\Middleware\ImplicitOptionsMiddlewareFactory;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Container\ContainerInterface;
 use Psr\Http\Message\ResponseInterface;
 
 class ImplicitOptionsMiddlewareFactoryTest extends TestCase
 {
+    use ProphecyTrait;
+
     /** @var ContainerInterface|ObjectProphecy */
     private $container;
 

diff --git a/test/Middleware/ImplicitOptionsMiddlewareTest.php b/test/Middleware/ImplicitOptionsMiddlewareTest.php
@@ -15,6 +15,7 @@
 use Mezzio\Router\Route;
 use Mezzio\Router\RouteResult;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -24,6 +25,8 @@
 
 class ImplicitOptionsMiddlewareTest extends TestCase
 {
+    use ProphecyTrait;
+
     /** @var ImplicitOptionsMiddleware */
     private $middleware;
 

diff --git a/test/Middleware/MethodNotAllowedMiddlewareFactoryTest.php b/test/Middleware/MethodNotAllowedMiddlewareFactoryTest.php
@@ -14,12 +14,15 @@
 use Mezzio\Router\Middleware\MethodNotAllowedMiddleware;
 use Mezzio\Router\Middleware\MethodNotAllowedMiddlewareFactory;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Container\ContainerInterface;
 use Psr\Http\Message\ResponseInterface;
 
 class MethodNotAllowedMiddlewareFactoryTest extends TestCase
 {
+    use ProphecyTrait;
+
     /** @var ContainerInterface|ObjectProphecy */
     private $container;
 

diff --git a/test/Middleware/MethodNotAllowedMiddlewareTest.php b/test/Middleware/MethodNotAllowedMiddlewareTest.php
@@ -16,13 +16,16 @@
 use Mezzio\Router\RouteResult;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 
 class MethodNotAllowedMiddlewareTest extends TestCase
 {
+    use ProphecyTrait;
+
     /** @var RequestHandlerInterface|ObjectProphecy */
     private $handler;
 

diff --git a/test/Middleware/RouteMiddlewareFactoryTest.php b/test/Middleware/RouteMiddlewareFactoryTest.php
@@ -16,12 +16,15 @@
 use Mezzio\Router\Middleware\RouteMiddlewareFactory;
 use Mezzio\Router\RouterInterface;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Container\ContainerInterface;
 use Zend\Expressive\Router\RouterInterface as ZendExpressiveRouterInterface;
 
 class RouteMiddlewareFactoryTest extends TestCase
 {
+    use ProphecyTrait;
+
     /** @var ContainerInterface|ObjectProphecy */
     private $container;
 

diff --git a/test/Middleware/RouteMiddlewareTest.php b/test/Middleware/RouteMiddlewareTest.php
@@ -15,6 +15,7 @@
 use Mezzio\Router\RouteResult;
 use Mezzio\Router\RouterInterface;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -24,6 +25,8 @@
 
 class RouteMiddlewareTest extends TestCase
 {
+    use ProphecyTrait;
+
     /** @var RouterInterface|ObjectProphecy */
     private $router;
 

diff --git a/test/RouteCollectorFactoryTest.php b/test/RouteCollectorFactoryTest.php
@@ -15,13 +15,16 @@
 use Mezzio\Router\RouteCollectorFactory;
 use Mezzio\Router\RouterInterface;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Container\ContainerInterface;
 use ReflectionProperty;
 use Zend\Expressive\Router\RouterInterface as ZendExpressiveRouterInterface;
 
 class RouteCollectorFactoryTest extends TestCase
 {
+    use ProphecyTrait;
+
     /** @var ContainerInterface|ObjectProphecy */
     private $container;
 

diff --git a/test/RouteCollectorTest.php b/test/RouteCollectorTest.php
@@ -17,6 +17,7 @@
 use Mezzio\Router\RouterInterface;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -31,6 +32,8 @@
 
 class RouteCollectorTest extends TestCase
 {
+    use ProphecyTrait;
+
     /** @var RouterInterface|ObjectProphecy */
     private $router;
 
@@ -73,8 +76,7 @@ public function process(
 
     /**
      * @return string[][]
-     *
-     * @psalm-return array{GET: array{0: string}, POST: array{0: string}, PUT: array{0: string}, PATCH: array{0: string}, DELETE: array{0: string}}
+     * @psalm-return array<array-key, array{0:string}>
      */
     public function commonHttpMethods(): array
     {
@@ -108,10 +110,7 @@ public function testAnyRouteMethod(): void
 
     /**
      * @dataProvider commonHttpMethods
-     *
      * @param string $method
-     *
-     * @return void
      */
     public function testCanCallRouteWithHttpMethods($method): void
     {
@@ -164,10 +163,7 @@ public function invalidPathTypes(): array
 
     /**
      * @dataProvider invalidPathTypes
-     *
      * @param mixed $path
-     *
-     * @return void
      */
     public function testCallingRouteWithAnInvalidPathTypeRaisesAnException($path): void
     {
@@ -177,10 +173,7 @@ public function testCallingRouteWithAnInvalidPathTypeRaisesAnException($path): v
 
     /**
      * @dataProvider commonHttpMethods
-     *
      * @param mixed $method
-     *
-     * @return void
      */
     public function testCommonHttpMethodsAreExposedAsClassMethodsAndReturnRoutes($method): void
     {

diff --git a/test/RouteResultTest.php b/test/RouteResultTest.php
@@ -13,6 +13,8 @@
 use Mezzio\Router\Route;
 use Mezzio\Router\RouteResult;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\RequestHandlerInterface;
@@ -22,6 +24,8 @@
  */
 class RouteResultTest extends TestCase
 {
+    use ProphecyTrait;
+
     public function testRouteNameIsNotRetrievable(): void
     {
         $result = RouteResult::fromRouteFailure([]);
@@ -65,9 +69,8 @@ public function testRouteSuccessMethodFailure(): void
     }
 
     /**
-     * @return (RouteResult|\Prophecy\Prophecy\ObjectProphecy)[]
-     *
-     * @psalm-return array{route: \Prophecy\Prophecy\ObjectProphecy<Route>, result: RouteResult}
+     * @return (RouteResult|ObjectProphecy)[]
+     * @psalm-return array{route: ObjectProphecy<Route>, result: RouteResult}
      */
     public function testFromRouteShouldComposeRouteInResult(): array
     {
@@ -83,8 +86,6 @@ public function testFromRouteShouldComposeRouteInResult(): array
 
     /**
      * @depends testFromRouteShouldComposeRouteInResult
-     *
-     * @return void
      */
     public function testAllAccessorsShouldReturnExpectedDataWhenResultCreatedViaFromRoute(array $data): void
     {
@@ -114,8 +115,6 @@ public function testFailureResultDoesNotIndicateAMethodFailureIfAllMethodsAreAll
 
     /**
      * @depends testFailureResultDoesNotIndicateAMethodFailureIfAllMethodsAreAllowed
-     *
-     * @return void
      */
     public function testAllowedMethodsIncludesASingleWildcardEntryWhenAllMethodsAllowedForFailureResult(
         RouteResult $result