Merge pull request #86 from eimkua1/php-8-support

weierophinney · web-flow · commit e13a1e32da30 · 2021-06-23T11:40:34.000-05:00
PHP 8.0 support
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,5 @@
 /coveralls-upload.json
 /phpunit.xml
 /vendor/
+/.phpunit.result.cache
+/.phpcs-cache
diff --git a/composer.json b/composer.json
@@ -26,17 +26,17 @@
         }
     },
     "require": {
-        "php": "^7.3",
-        "laminas-api-tools/api-tools-api-problem": "^1.2.1",
-        "laminas-api-tools/api-tools-content-negotiation": "^1.2.2",
-        "laminas-api-tools/api-tools-content-validation": "^1.3.3",
+        "php": "^7.3 || ~8.0.0",
+        "laminas-api-tools/api-tools-api-problem": "^1.4",
+        "laminas-api-tools/api-tools-content-negotiation": "^1.5",
+        "laminas-api-tools/api-tools-content-validation": "^1.9",
         "laminas-api-tools/api-tools-hal": "^1.4.1",
-        "laminas-api-tools/api-tools-mvc-auth": "^1.4.1",
-        "laminas-api-tools/api-tools-oauth2": "^1.4",
-        "laminas-api-tools/api-tools-provider": "^1.2",
-        "laminas-api-tools/api-tools-rest": "^1.3.1",
-        "laminas-api-tools/api-tools-rpc": "^1.3",
-        "laminas-api-tools/api-tools-versioning": "^1.2",
+        "laminas-api-tools/api-tools-mvc-auth": "^1.6.0",
+        "laminas-api-tools/api-tools-oauth2": "^1.7",
+        "laminas-api-tools/api-tools-provider": "^1.4",
+        "laminas-api-tools/api-tools-rest": "^1.6.0",
+        "laminas-api-tools/api-tools-rpc": "^1.5",
+        "laminas-api-tools/api-tools-versioning": "^1.4",
         "laminas/laminas-db": "^2.8.1",
         "laminas/laminas-eventmanager": "^2.6.3 || ^3.0.1",
         "laminas/laminas-loader": "^2.5.1",
@@ -49,7 +49,8 @@
     "require-dev": {
         "laminas/laminas-coding-standard": "~2.3.0",
         "laminas/laminas-http": "^2.5.4",
-        "phpunit/phpunit": "^7.1.5"
+        "phpspec/prophecy-phpunit": "^2.0",
+        "phpunit/phpunit": "^9.3"
     },
     "suggest": {
         "alcaeus/mongo-php-adapter": "^1.0.5, if you are using ext/mongodb and wish to use the MongoConnectedListener.",
diff --git a/composer.lock b/composer.lock
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,17 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
-         colors="true">
-    <testsuites>
-        <testsuite name="api-tools Test Suite">
-            <directory>./test</directory>
-        </testsuite>
-    </testsuites>
-
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true">
+  <coverage processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="api-tools Test Suite">
+      <directory>./test</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>
diff --git a/src/DbConnectedResourceAbstractFactory.php b/src/DbConnectedResourceAbstractFactory.php
@@ -5,6 +5,7 @@
 namespace Laminas\ApiTools;
 
 use Interop\Container\ContainerInterface;
+use Laminas\ApiTools\Rest\Resource;
 use Laminas\Db\TableGateway\TableGatewayInterface;
 use Laminas\Paginator\Paginator;
 use Laminas\ServiceManager\AbstractFactoryInterface;
@@ -169,8 +170,7 @@ protected function getIdentifierFromConfig(array $config)
      * @param array $config
      * @param string $requestedName
      * @return string
-     * @throws ServiceNotCreatedException If the discovered collection class
-     *     does not exist.
+     * @throws ServiceNotCreatedException If the discovered collection class does not exist.
      */
     protected function getCollectionFromConfig(array $config, $requestedName)
     {
diff --git a/src/MvcAuth/UnauthenticatedListener.php b/src/MvcAuth/UnauthenticatedListener.php
@@ -6,7 +6,6 @@
 
 use Laminas\ApiTools\ApiProblem\ApiProblem;
 use Laminas\ApiTools\ApiProblem\ApiProblemResponse;
-use Laminas\ApiTools\MvcAuth\MvcAuthEvent;
 
 class UnauthenticatedListener
 {
diff --git a/src/MvcAuth/UnauthorizedListener.php b/src/MvcAuth/UnauthorizedListener.php
@@ -6,7 +6,6 @@
 
 use Laminas\ApiTools\ApiProblem\ApiProblem;
 use Laminas\ApiTools\ApiProblem\ApiProblemResponse;
-use Laminas\ApiTools\MvcAuth\MvcAuthEvent;
 
 class UnauthorizedListener
 {
diff --git a/test/ApplicationTest.php b/test/ApplicationTest.php
@@ -12,13 +12,17 @@
 use Laminas\Mvc\MvcEvent;
 use Laminas\ServiceManager\ServiceManager;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
+use ReflectionException;
 use ReflectionMethod;
 use ReflectionProperty;
 
 class ApplicationTest extends TestCase
 {
-    protected function setUp()
+    use ProphecyTrait;
+
+    protected function setUp(): void
     {
         $events = new EventManager();
 
@@ -86,6 +90,7 @@ public function setUpServices($services, EventManager $events, $request, $respon
     /**
      * @param ObjectProphecy&PhpEnvironment\Request $request
      * @param ObjectProphecy&PhpEnvironment\Response $response
+     * @throws ReflectionException
      */
     public function setUpMvcEvent(Application $app, $request, $response): Application
     {
diff --git a/test/AutoloaderTest.php b/test/AutoloaderTest.php
@@ -13,6 +13,7 @@
 
 class AutoloaderTest extends TestCase
 {
+    /** @psalm-return array<string, array{0: class-string}> */
     public function classesToAutoload(): array
     {
         return [
diff --git a/test/DbConnectedResourceAbstractFactoryTest.php b/test/DbConnectedResourceAbstractFactoryTest.php
@@ -9,10 +9,13 @@
 use Laminas\ApiTools\DbConnectedResourceAbstractFactory;
 use Laminas\Db\TableGateway\TableGateway;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 
 class DbConnectedResourceAbstractFactoryTest extends TestCase
 {
-    protected function setUp()
+    use ProphecyTrait;
+
+    protected function setUp(): void
     {
         $this->services = $this->prophesize(ContainerInterface::class);
         $this->factory  = new DbConnectedResourceAbstractFactory();
@@ -69,6 +72,7 @@ public function invalidConfig(): array
     }
 
     /**
+     * @param array $configForDbConnected
      * @dataProvider invalidConfig
      */
     public function testWillNotCreateServiceIfDbConnectedSegmentIsInvalidConfiguration(
@@ -93,6 +97,7 @@ public function testWillNotCreateServiceIfDbConnectedSegmentIsInvalidConfigurati
         $this->assertFalse($this->factory->canCreate($this->services->reveal(), 'Foo'));
     }
 
+    /** @psalm-return array<string, array{0: array<string, string>, 1: string}> */
     public function validConfig(): array
     {
         return [
@@ -123,6 +128,7 @@ public function testWillCreateServiceIfDbConnectedSegmentIsValid(
     }
 
     /**
+     * @param array $configForDbConnected
      * @dataProvider validConfig
      */
     public function testFactoryReturnsResourceBasedOnConfiguration(
diff --git a/test/DbConnectedResourceTest.php b/test/DbConnectedResourceTest.php
@@ -10,16 +10,23 @@
 use Laminas\Db\TableGateway\TableGateway;
 use Laminas\InputFilter\InputFilter;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
+use ReflectionException;
 use ReflectionObject;
 
 class DbConnectedResourceTest extends TestCase
 {
-    protected function setUp()
+    use ProphecyTrait;
+
+    protected function setUp(): void
     {
         $this->table    = $this->prophesize(TableGateway::class);
         $this->resource = new DbConnectedResource($this->table->reveal(), 'id', ArrayObject::class);
     }
 
+    /**
+     * @throws ReflectionException
+     */
     protected function setInputFilter(
         DbConnectedResource $resource,
         InputFilter $inputFilter
diff --git a/test/Model/MongoConnectedListenerTest.php b/test/Model/MongoConnectedListenerTest.php
@@ -21,7 +21,7 @@ class MongoConnectedListenerTest extends TestCase
     /** @var MongoDB */
     protected static $mongoDb;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         if (
             ! (extension_loaded('mongodb') || extension_loaded('mongo'))
@@ -40,14 +40,17 @@ protected function setUp()
         $this->mongoListener = new MongoConnectedListener($collection);
     }
 
-    public static function tearDownAfterClass()
+    public static function tearDownAfterClass(): void
     {
         if (static::$mongoDb instanceof MongoDB) {
             static::$mongoDb->drop();
         }
     }
 
-    public function testCreate(): string
+    /**
+     * @return null|string|int
+     */
+    public function testCreate()
     {
         $data   = ['foo' => 'bar'];
         $result = $this->mongoListener->create($data);
@@ -56,6 +59,8 @@ public function testCreate(): string
     }
 
     /**
+     * @param mixed $lastId
+     * @return mixed
      * @depends testCreate
      */
     public function testFetch(string $lastId): string
@@ -73,6 +78,8 @@ public function testFetch(string $lastId): string
     }
 
     /**
+     * @param mixed $lastId
+     * @return mixed
      * @depends testFetch
      */
     public function testPatch(string $lastId): string
@@ -88,6 +95,7 @@ public function testPatch(string $lastId): string
     }
 
     /**
+     * @param mixed $lastId
      * @depends testPatch
      */
     public function testDelete(string $lastId): void
diff --git a/test/TableGatewayAbstractFactoryTest.php b/test/TableGatewayAbstractFactoryTest.php
@@ -15,14 +15,19 @@
 use Laminas\Hydrator\ClassMethodsHydrator;
 use Laminas\Hydrator\HydratorPluginManager;
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
+use ReflectionException;
+use ReflectionProperty;
 use Zend\Db\Adapter\Adapter;
 use Zend\Db\Adapter\AdapterInterface;
 
 use function class_exists;
 
 class TableGatewayAbstractFactoryTest extends TestCase
 {
-    protected function setUp()
+    use ProphecyTrait;
+
+    protected function setUp(): void
     {
         $this->services = $this->prophesize(ContainerInterface::class);
         $this->factory  = new TableGatewayAbstractFactory();
@@ -137,6 +142,7 @@ public function testWillCreateServiceIfConfigContainsValidTableNameNoAdapterName
         $this->assertTrue($this->factory->canCreate($this->services->reveal(), 'Foo\Table'));
     }
 
+    /** @psalm-return array<string, array{0: class-string}> */
     public function validConfig(): array
     {
         return [
@@ -193,7 +199,8 @@ public function testFactoryReturnsTableGatewayInstanceBasedOnConfiguration(strin
         $resultSet = $gateway->getResultSetPrototype();
         $this->assertInstanceOf(HydratingResultSet::class, $resultSet);
         $this->assertSame($hydrator, $resultSet->getHydrator());
-        $this->assertAttributeInstanceOf(TestAsset\Foo::class, 'objectPrototype', $resultSet);
+
+        $this->assertObjectPrototypeProperty($resultSet, TestAsset\Foo::class);
     }
 
     /**
@@ -241,7 +248,8 @@ public function testFactoryReturnsTableGatewayInstanceBasedOnConfigurationWithou
         $resultSet = $gateway->getResultSetPrototype();
         $this->assertInstanceOf(HydratingResultSet::class, $resultSet);
         $this->assertInstanceOf($this->getClassMethodsHydratorClassName(), $resultSet->getHydrator());
-        $this->assertAttributeInstanceOf(TestAsset\Bar::class, 'objectPrototype', $resultSet);
+
+        $this->assertObjectPrototypeProperty($resultSet, TestAsset\Bar::class);
     }
 
     /**
@@ -258,4 +266,14 @@ private function getClassMethodsHydratorClassName()
 
         return ClassMethods::class;
     }
+
+    /**
+     * @throws ReflectionException
+     */
+    private function assertObjectPrototypeProperty(HydratingResultSet $resultSet, string $expectedClassName): void
+    {
+        $objectPrototypeProperty = new ReflectionProperty($resultSet, 'objectPrototype');
+        $objectPrototypeProperty->setAccessible(true);
+        $this->assertInstanceOf($expectedClassName, $objectPrototypeProperty->getValue($resultSet));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,6 @@`
`6`	`6`
`7`	`7`	`use Laminas\ApiTools\ApiProblem\ApiProblem;`
`8`	`8`	`use Laminas\ApiTools\ApiProblem\ApiProblemResponse;`
`9`		`-use Laminas\ApiTools\MvcAuth\MvcAuthEvent;`
`10`	`9`
`11`	`10`	`class UnauthenticatedListener`
`12`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`
`14`	`14`	`class AutoloaderTest extends TestCase`
`15`	`15`	`{`
	`16`	`+ /** @psalm-return array<string, array{0: class-string}> */`
`16`	`17`	`public function classesToAutoload(): array`
`17`	`18`	`{`
`18`	`19`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -9,10 +9,13 @@`
`9`	`9`	`use Laminas\ApiTools\DbConnectedResourceAbstractFactory;`
`10`	`10`	`use Laminas\Db\TableGateway\TableGateway;`
`11`	`11`	`use PHPUnit\Framework\TestCase;`
	`12`	`+use Prophecy\PhpUnit\ProphecyTrait;`
`12`	`13`
`13`	`14`	`class DbConnectedResourceAbstractFactoryTest extends TestCase`
`14`	`15`	`{`
`15`		`- protected function setUp()`
	`16`	`+ use ProphecyTrait;`
	`17`	`+`
	`18`	`+ protected function setUp(): void`
`16`	`19`	`{`
`17`	`20`	`$this->services = $this->prophesize(ContainerInterface::class);`
`18`	`21`	`$this->factory = new DbConnectedResourceAbstractFactory();`
`@@ -69,6 +72,7 @@ public function invalidConfig(): array`
`69`	`72`	`}`
`70`	`73`
`71`	`74`	`/**`
	`75`	`+ * @param array $configForDbConnected`
`72`	`76`	`* @dataProvider invalidConfig`
`73`	`77`	`*/`
`74`	`78`	`public function testWillNotCreateServiceIfDbConnectedSegmentIsInvalidConfiguration(`
`@@ -93,6 +97,7 @@ public function testWillNotCreateServiceIfDbConnectedSegmentIsInvalidConfigurati`
`93`	`97`	`$this->assertFalse($this->factory->canCreate($this->services->reveal(), 'Foo'));`
`94`	`98`	`}`
`95`	`99`
	`100`	`+ /** @psalm-return array<string, array{0: array<string, string>, 1: string}> */`
`96`	`101`	`public function validConfig(): array`
`97`	`102`	`{`
`98`	`103`	`return [`
`@@ -123,6 +128,7 @@ public function testWillCreateServiceIfDbConnectedSegmentIsValid(`
`123`	`128`	`}`
`124`	`129`
`125`	`130`	`/**`
	`131`	`+ * @param array $configForDbConnected`
`126`	`132`	`* @dataProvider validConfig`
`127`	`133`	`*/`
`128`	`134`	`public function testFactoryReturnsResourceBasedOnConfiguration(`