Merge pull request #11 from acelaya-forks/feat/php-8

PHP 8 support
mezzio · Jan 24, 2021 · acdca58 · acdca58
2 parents 68dad92 + d5338db
commit acdca58
Show file tree

Hide file tree

Showing 24 changed files with 646 additions and 518 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
+/.phpcs-cache
+/.phpunit.result.cache
 /clover.xml
 /composer.lock
 /coveralls-upload.json

diff --git a/.travis.yml b/.travis.yml
@@ -12,24 +12,24 @@ env:
 matrix:
   fast_finish: true
   include:
-    - php: 7.1
+    - php: 7.3
       env:
         - DEPS=lowest
-    - php: 7.1
+    - php: 7.3
       env:
         - DEPS=latest
-        - CS_CHECK=true
-        - TEST_COVERAGE=true
-    - php: 7.2
+    - php: 7.4
       env:
         - DEPS=lowest
-    - php: 7.2
+    - php: 7.4
       env:
         - DEPS=latest
-    - php: 7.3
+        - CS_CHECK=true
+        - TEST_COVERAGE=true
+    - php: 8.0
       env:
         - DEPS=lowest
-    - php: 7.3
+    - php: 8.0
       env:
         - DEPS=latest
 

diff --git a/composer.json b/composer.json
@@ -22,29 +22,24 @@
         "sort-packages": true
     },
     "extra": {
-        "branch-alias": {
-            "dev-master": "1.1.x-dev",
-            "dev-develop": "1.2.x-dev"
-        },
         "laminas": {
             "config-provider": "Mezzio\\ProblemDetails\\ConfigProvider"
         }
     },
     "require": {
-        "php": "^7.1",
+        "php": "^7.3 || ~8.0.0",
         "ext-json": "*",
         "fig/http-message-util": "^1.1.2",
         "laminas/laminas-zendframework-bridge": "^1.0",
         "psr/container": "^1.0",
         "psr/http-message": "^1.0",
         "psr/http-server-middleware": "^1.0",
         "spatie/array-to-xml": "^2.3",
-        "willdurand/negotiation": "^2.3"
+        "willdurand/negotiation": "^3.0"
     },
     "require-dev": {
-        "laminas/laminas-coding-standard": "~1.0.0",
-        "phpspec/prophecy": "^1.8.0",
-        "phpunit/phpunit": "^7.0.1"
+        "laminas/laminas-coding-standard": "~2.1.0",
+        "phpunit/phpunit": "^9.3"
     },
     "autoload": {
         "psr-4": {

diff --git a/phpcs.xml b/phpcs.xml
@@ -1,8 +1,20 @@
 <?xml version="1.0"?>
-<ruleset name="Laminas Coding Standard">
-    <rule ref="./vendor/laminas/laminas-coding-standard/ruleset.xml"/>
+<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>src</file>
     <file>test</file>
+
+    <!-- Include all rules from the Laminas Coding Standard -->
+    <rule ref="LaminasCodingStandard"/>
 </ruleset>
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="mezzio-problem-details">
-            <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="vendor/phpunit/phpunit/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true">
+  <coverage processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="mezzio-problem-details">
+      <directory>./test</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>
diff --git a/src/ConfigProvider.php b/src/ConfigProvider.php
@@ -10,6 +10,10 @@
 
 namespace Mezzio\ProblemDetails;
 
+use Zend\ProblemDetails\ProblemDetailsMiddleware as LegacyProblemDetailsMiddleware;
+use Zend\ProblemDetails\ProblemDetailsNotFoundHandler as LegacyProblemDetailsNotFoundHandler;
+use Zend\ProblemDetails\ProblemDetailsResponseFactory as LegacyProblemDetailsResponseFactory;
+
 /**
  * Configuration provider for the package.
  *
@@ -20,7 +24,7 @@ class ConfigProvider
     /**
      * Returns the configuration array.
      */
-    public function __invoke() : array
+    public function __invoke(): array
     {
         return [
             'dependencies' => $this->getDependencies(),
@@ -30,17 +34,17 @@ public function __invoke() : array
     /**
      * Returns the container dependencies.
      */
-    public function getDependencies() : array
+    public function getDependencies(): array
     {
         return [
             // Legacy Zend Framework aliases
-            'aliases' => [
-                \Zend\ProblemDetails\ProblemDetailsMiddleware::class => ProblemDetailsMiddleware::class,
-                \Zend\ProblemDetails\ProblemDetailsNotFoundHandler::class => ProblemDetailsNotFoundHandler::class,
-                \Zend\ProblemDetails\ProblemDetailsResponseFactory::class => ProblemDetailsResponseFactory::class,
+            'aliases'   => [
+                LegacyProblemDetailsMiddleware::class      => ProblemDetailsMiddleware::class,
+                LegacyProblemDetailsNotFoundHandler::class => ProblemDetailsNotFoundHandler::class,
+                LegacyProblemDetailsResponseFactory::class => ProblemDetailsResponseFactory::class,
             ],
-            'factories'  => [
-                ProblemDetailsMiddleware::class => ProblemDetailsMiddlewareFactory::class,
+            'factories' => [
+                ProblemDetailsMiddleware::class      => ProblemDetailsMiddlewareFactory::class,
                 ProblemDetailsNotFoundHandler::class => ProblemDetailsNotFoundHandlerFactory::class,
                 ProblemDetailsResponseFactory::class => ProblemDetailsResponseFactoryFactory::class,
             ],

diff --git a/src/Exception/CommonProblemDetailsExceptionTrait.php b/src/Exception/CommonProblemDetailsExceptionTrait.php
@@ -25,52 +25,42 @@
  */
 trait CommonProblemDetailsExceptionTrait
 {
-    /**
-     * @var int
-     */
+    /** @var int */
     private $status;
 
-    /**
-     * @var string
-     */
+    /** @var string */
     private $detail;
 
-    /**
-     * @var string
-     */
+    /** @var string */
     private $title;
 
-    /**
-     * @var string
-     */
+    /** @var string */
     private $type;
 
-    /**
-     * @var array
-     */
+    /** @var array */
     private $additional = [];
 
-    public function getStatus() : int
+    public function getStatus(): int
     {
         return $this->status;
     }
 
-    public function getType() : string
+    public function getType(): string
     {
         return $this->type;
     }
 
-    public function getTitle() : string
+    public function getTitle(): string
     {
         return $this->title;
     }
 
-    public function getDetail() : string
+    public function getDetail(): string
     {
         return $this->detail;
     }
 
-    public function getAdditionalData() : array
+    public function getAdditionalData(): array
     {
         return $this->additional;
     }
@@ -81,7 +71,7 @@ public function getAdditionalData() : array
      * Likely useful for the JsonSerializable implementation, but also
      * for cases where the XML variant is desired.
      */
-    public function toArray() : array
+    public function toArray(): array
     {
         $problem = [
             'status' => $this->status,

diff --git a/src/Exception/ProblemDetailsExceptionInterface.php b/src/Exception/ProblemDetailsExceptionInterface.php
@@ -18,21 +18,21 @@
  */
 interface ProblemDetailsExceptionInterface extends JsonSerializable, Throwable
 {
-    public function getStatus() : int;
+    public function getStatus(): int;
 
-    public function getType() : string;
+    public function getType(): string;
 
-    public function getTitle() : string;
+    public function getTitle(): string;
 
-    public function getDetail() : string;
+    public function getDetail(): string;
 
-    public function getAdditionalData() : array;
+    public function getAdditionalData(): array;
 
     /**
      * Serialize the exception to an array of problem details.
      *
      * Likely useful for the JsonSerializable implementation, but also
      * for cases where the XML variant is desired.
      */
-    public function toArray() : array;
+    public function toArray(): array;
 }
diff --git a/src/ProblemDetailsMiddleware.php b/src/ProblemDetailsMiddleware.php
@@ -30,14 +30,10 @@
  */
 class ProblemDetailsMiddleware implements MiddlewareInterface
 {
-    /**
-     * @var callable[]
-     */
+    /** @var callable[] */
     private $listeners = [];
 
-    /**
-     * @var ProblemDetailsResponseFactory
-     */
+    /** @var ProblemDetailsResponseFactory */
     private $responseFactory;
 
     public function __construct(ProblemDetailsResponseFactory $responseFactory)
@@ -48,7 +44,7 @@ public function __construct(ProblemDetailsResponseFactory $responseFactory)
     /**
      * {@inheritDoc}
      */
-    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface
+    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {
         // If we cannot provide a representation, act as a no-op.
         if (! $this->canActAsErrorHandler($request)) {
@@ -81,7 +77,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
      * listeners are ignored; use listeners for reporting purposes
      * only.
      */
-    public function attachListener(callable $listener) : void
+    public function attachListener(callable $listener): void
     {
         if (in_array($listener, $this->listeners, true)) {
             return;
@@ -95,7 +91,7 @@ public function attachListener(callable $listener) : void
      *
      * Returns a boolean false if negotiation fails.
      */
-    private function canActAsErrorHandler(ServerRequestInterface $request) : bool
+    private function canActAsErrorHandler(ServerRequestInterface $request): bool
     {
         $accept = $request->getHeaderLine('Accept') ?: '*/*';
 
@@ -108,17 +104,16 @@ private function canActAsErrorHandler(ServerRequestInterface $request) : bool
      *
      * Only raises exceptions for errors that are within the error_reporting mask.
      */
-    private function createErrorHandler() : callable
+    private function createErrorHandler(): callable
     {
         /**
          * @param int $errno
          * @param string $errstr
          * @param string $errfile
          * @param int $errline
-         * @return void
          * @throws ErrorException if error is not within the error_reporting mask.
          */
-        return function (int $errno, string $errstr, string $errfile, int $errline) : void {
+        return function (int $errno, string $errstr, string $errfile, int $errline): void {
             if (! (error_reporting() & $errno)) {
                 // error_reporting does not include this error
                 return;
@@ -135,7 +130,7 @@ private function triggerListeners(
         Throwable $error,
         ServerRequestInterface $request,
         ResponseInterface $response
-    ) : void {
+    ): void {
         array_walk($this->listeners, function ($listener) use ($error, $request, $response) {
             $listener($error, $request, $response);
         });

diff --git a/src/ProblemDetailsMiddlewareFactory.php b/src/ProblemDetailsMiddlewareFactory.php
@@ -14,7 +14,7 @@
 
 class ProblemDetailsMiddlewareFactory
 {
-    public function __invoke(ContainerInterface $container) : ProblemDetailsMiddleware
+    public function __invoke(ContainerInterface $container): ProblemDetailsMiddleware
     {
         return new ProblemDetailsMiddleware($container->get(ProblemDetailsResponseFactory::class));
     }

diff --git a/src/ProblemDetailsNotFoundHandler.php b/src/ProblemDetailsNotFoundHandler.php
@@ -20,9 +20,7 @@
 
 class ProblemDetailsNotFoundHandler implements MiddlewareInterface
 {
-    /**
-     * @var ProblemDetailsResponseFactory
-     */
+    /** @var ProblemDetailsResponseFactory */
     private $responseFactory;
 
     /**
@@ -37,7 +35,7 @@ public function __construct(ProblemDetailsResponseFactory $responseFactory)
     /**
      * Creates and returns a 404 response.
      */
-    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface
+    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {
         // If we cannot provide a representation, act as a no-op.
         if (! $this->canActAsErrorHandler($request)) {
@@ -54,7 +52,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
     /**
      * Can the middleware act as an error handler?
      */
-    private function canActAsErrorHandler(ServerRequestInterface $request) : bool
+    private function canActAsErrorHandler(ServerRequestInterface $request): bool
     {
         $accept = $request->getHeaderLine('Accept') ?: '*/*';
 

diff --git a/src/ProblemDetailsNotFoundHandlerFactory.php b/src/ProblemDetailsNotFoundHandlerFactory.php
@@ -14,7 +14,7 @@
 
 class ProblemDetailsNotFoundHandlerFactory
 {
-    public function __invoke(ContainerInterface $container) : ProblemDetailsNotFoundHandler
+    public function __invoke(ContainerInterface $container): ProblemDetailsNotFoundHandler
     {
         return new ProblemDetailsNotFoundHandler($container->get(ProblemDetailsResponseFactory::class));
     }