qa: update to laminas-coding-standard 2.3

- Fixes deprecation notices, which in turn fixes CI errors.
- Apply all rules.

Signed-off-by: Matthew Weier O'Phinney <[email protected]>

Author: weierophinney

.gitignore

@@ -1,3 +1,4 @@
+/.phpcs-cache
 /clover.xml
 /coveralls-upload.json
 /phpunit.xml

composer.json

@@ -47,9 +47,9 @@
         "laminas/laminas-zendframework-bridge": "^1.0"
     },
     "require-dev": {
-        "laminas/laminas-coding-standard": "~1.0.0",
+        "laminas/laminas-coding-standard": "~2.3.0",
         "laminas/laminas-http": "^2.5.4",
-        "phpunit/phpunit": "^5.7.27 || ^6.5.8 || ^7.1.5"
+        "phpunit/phpunit": "^7.1.5"
     },
     "suggest": {
         "alcaeus/mongo-php-adapter": "^1.0.5, if you are using ext/mongodb and wish to use the MongoConnectedListener.",

composer.lock

@@ -1,29 +1,27 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools/blob/master/LICENSE.md New BSD License
- */
+declare(strict_types=1);
 
 namespace Laminas\ApiTools;
 
 use Laminas\Db\Adapter\AdapterAbstractServiceFactory as DbAdapterAbstractServiceFactory;
 use Laminas\ServiceManager\Factory\InvokableFactory;
+use ZF\Apigility\MvcAuth\UnauthenticatedListener;
+use ZF\Apigility\MvcAuth\UnauthorizedListener;
 
 return [
-    'asset_manager' => [
+    'asset_manager'   => [
         'resolver_configs' => [
             'paths' => [
                 __DIR__ . '/../asset',
             ],
         ],
     ],
-    'router' => [
+    'router'          => [
         'routes' => [
             'api-tools' => [
-                'type' => 'literal',
-                'options' => [
+                'type'          => 'literal',
+                'options'       => [
                     'route' => '/api-tools',
                 ],
                 'may_terminate' => false,
@@ -32,21 +30,21 @@
     ],
     'service_manager' => [
         // Legacy Zend Framework aliases
-        'aliases' => [
-            \ZF\Apigility\MvcAuth\UnauthenticatedListener::class => MvcAuth\UnauthenticatedListener::class,
-            \ZF\Apigility\MvcAuth\UnauthorizedListener::class => MvcAuth\UnauthorizedListener::class,
+        'aliases'            => [
+            UnauthenticatedListener::class => MvcAuth\UnauthenticatedListener::class,
+            UnauthorizedListener::class    => MvcAuth\UnauthorizedListener::class,
         ],
-        'factories' => [
+        'factories'          => [
             MvcAuth\UnauthenticatedListener::class => InvokableFactory::class,
-            MvcAuth\UnauthorizedListener::class => InvokableFactory::class,
+            MvcAuth\UnauthorizedListener::class    => InvokableFactory::class,
         ],
         'abstract_factories' => [
             DbAdapterAbstractServiceFactory::class, // so that db-connected works "out-of-the-box"
             DbConnectedResourceAbstractFactory::class,
             TableGatewayAbstractFactory::class,
         ],
     ],
-    'api-tools' => [
+    'api-tools'       => [
         'db-connected' => [
         // @codingStandardsIgnoreStart
         /*

config/module.config.php

@@ -0,0 +1,22 @@
+<?xml version="1.0"?>
+<ruleset
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="./vendor/squizlabs/php_codesniffer/phpcs.xsd">
+
+    <arg name="basepath" value="."/>
+    <arg name="cache" value=".phpcs-cache"/>
+    <arg name="colors"/>
+    <arg name="extensions" value="php"/>
+    <arg name="parallel" value="80"/>
+
+    <!-- Show progress -->
+    <arg value="p"/>
+
+    <!-- Paths to check -->
+    <file>config</file>
+    <file>src</file>
+    <file>test</file>
+
+    <!-- Include all rules from Laminas Coding Standard -->
+    <rule ref="LaminasCodingStandard"/>
+</ruleset>

phpcs.xml

@@ -1,10 +1,6 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools/blob/master/LICENSE.md New BSD License
- */
+declare(strict_types=1);
 
 namespace Laminas\ApiTools;
 

phpcs.xml.dist

@@ -1,10 +1,6 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools/blob/master/LICENSE.md New BSD License
- */
+declare(strict_types=1);
 
 namespace Laminas\ApiTools;
 
@@ -62,8 +58,6 @@ public function run()
             $result = $events->triggerEventUntil($shortCircuit, $event);
         } catch (Throwable $e) {
             return $this->handleException($e, $event, $events);
-        } catch (Exception $e) {
-            return $this->handleException($e, $event, $events);
         }
 
         if ($result->stopped()) {
@@ -110,8 +104,6 @@ public function run()
      * Handle an exception/throwable.
      *
      * @param Throwable|Exception $exception
-     * @param MvcEvent $event
-     * @param EventManagerInterface $events
      * @return self
      */
     private function handleException($exception, MvcEvent $event, EventManagerInterface $events)

src/ApiToolsModuleInterface.php

@@ -1,15 +1,14 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools/blob/master/LICENSE.md New BSD License
- */
+declare(strict_types=1);
 
 namespace Laminas\ApiTools;
 
 use Laminas\Loader\StandardAutoloader;
 
+use function preg_match;
+use function str_replace;
+
 /**
  * Extends StandardAutoloader to remove "_" as a directory separator
  */
@@ -33,8 +32,8 @@ protected function transformClassNameToFilename($class, $directory)
         $matches = [];
         preg_match('/(?P<namespace>.+\\\)?(?P<class>[^\\\]+$)/', $class, $matches);
 
-        $class     = (isset($matches['class'])) ? $matches['class'] : '';
-        $namespace = (isset($matches['namespace'])) ? $matches['namespace'] : '';
+        $class     = $matches['class'] ?? '';
+        $namespace = $matches['namespace'] ?? '';
 
         return $directory
              . str_replace(self::NS_SEPARATOR, '/', $namespace)

src/Application.php

@@ -1,37 +1,27 @@
 <?php
 
-/**
- * @see       https://github.com/laminas-api-tools/api-tools for the canonical source repository
- * @copyright https://github.com/laminas-api-tools/api-tools/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas-api-tools/api-tools/blob/master/LICENSE.md New BSD License
- */
+declare(strict_types=1);
 
 namespace Laminas\ApiTools;
 
 use Laminas\ApiTools\ApiProblem\Exception\DomainException;
 use Laminas\ApiTools\Rest\AbstractResourceListener;
 use Laminas\Db\TableGateway\TableGatewayInterface as TableGateway;
 use Laminas\Paginator\Adapter\DbTableGateway as TableGatewayPaginator;
+use Laminas\Paginator\Paginator;
 
 class DbConnectedResource extends AbstractResourceListener
 {
-    /**
-     * @var string Name of collection class
-     */
+    /** @var string Name of collection class */
     protected $collectionClass;
 
-    /**
-     * @var string Name of identifier field
-     */
+    /** @var string Name of identifier field */
     protected $identifierName;
 
-    /**
-     * @var TableGateway
-     */
+    /** @var TableGateway */
     protected $table;
 
     /**
-     * @param TableGateway $table
      * @param string $identifierName
      * @param string $collectionClass
      */
@@ -91,15 +81,15 @@ public function patch($id, $data)
     public function delete($id)
     {
         $item = $this->table->delete([$this->identifierName => $id]);
-        return ($item > 0);
+        return $item > 0;
     }
 
     /**
      * Fetch an existing resource.
      *
      * @param int|string $id Identifier of resource.
      * @return array|object Resource.
-     * @throws DomainException if the resource is not found.
+     * @throws DomainException If the resource is not found.
      */
     public function fetch($id)
     {
@@ -114,7 +104,7 @@ public function fetch($id)
      * Fetch a paginated set of resources.
      *
      * @param array|object $data Ignored.
-     * @return \Laminas\Paginator\Paginator
+     * @return Paginator
      */
     public function fetchAll($data = [])
     {