Merge pull request #8 from acelaya/develop

Develop

Author: acelaya

CHANGELOG.md

@@ -1,5 +1,16 @@
 ## CHANGELOG
 
+### 2.1.1
+
+**Enhancements:**
+
+* [6: Improve coding styles using slevomat/coding-standard package](https://github.com/acelaya/ze-content-based-error-handler/issues/6)
+* [7: Add phpstan to build matrix](https://github.com/acelaya/ze-content-based-error-handler/issues/7)
+
+**Bugs:**
+
+* [6: Make ExceptionInterface extend Throwable ](https://github.com/acelaya/ze-content-based-error-handler/issues/6)
+
 ### 2.1.0
 
 **Enhancements:**

README.md

@@ -1,11 +1,11 @@
 # Zend Expressive ContentBasedErrorResponseGenerator
 
-[![Build Status](https://travis-ci.org/acelaya/ze-content-based-error-handler.svg?branch=master)](https://travis-ci.org/acelaya/ze-content-based-error-handler)
-[![Code Coverage](https://scrutinizer-ci.com/g/acelaya/ze-content-based-error-handler/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/acelaya/ze-content-based-error-handler/?branch=master)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/acelaya/ze-content-based-error-handler/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/acelaya/ze-content-based-error-handler/?branch=master)
-[![Latest Stable Version](https://poser.pugx.org/acelaya/ze-content-based-error-handler/v/stable.png)](https://packagist.org/packages/acelaya/ze-content-based-error-handler)
-[![Total Downloads](https://poser.pugx.org/acelaya/ze-content-based-error-handler/downloads.png)](https://packagist.org/packages/acelaya/ze-content-based-error-handler)
-[![License](https://poser.pugx.org/acelaya/ze-content-based-error-handler/license.png)](https://packagist.org/packages/acelaya/ze-content-based-error-handler)
+[![Build Status](https://img.shields.io/travis/acelaya/ze-content-based-error-handler/master.svg?style=flat-square)](https://travis-ci.org/acelaya/ze-content-based-error-handler)
+[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/acelaya/ze-content-based-error-handler.svg?style=flat-square)](https://scrutinizer-ci.com/g/acelaya/ze-content-based-error-handler/?branch=master)
+[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/acelaya/ze-content-based-error-handler.svg?style=flat-square)](https://scrutinizer-ci.com/g/acelaya/ze-content-based-error-handler/?branch=master)
+[![Latest Stable Version](https://poser.pugx.org/acelaya/ze-content-based-error-handler/v/stable?format=flat-square)](https://packagist.org/packages/acelaya/ze-content-based-error-handler)
+[![Total Downloads](https://poser.pugx.org/acelaya/ze-content-based-error-handler/downloads?format=flat-square)](https://packagist.org/packages/acelaya/ze-content-based-error-handler)
+[![License](https://poser.pugx.org/acelaya/ze-content-based-error-handler/license?format=flat-square)](LICENSE)
 
 A Zend Expressive error response generator which allows to implement different strategies to render error responses based on the accepted content-types.
 

composer.json

@@ -11,14 +11,15 @@
     ],
     "require": {
         "php": "^7.1",
-        "zendframework/zend-servicemanager": "^3.0",
-        "zendframework/zend-expressive": "^2.0",
         "psr/log": "^1.0",
-        "http-interop/http-middleware": "^0.4.1"
+        "zendframework/zend-expressive": "^2.1",
+        "zendframework/zend-servicemanager": "^3.0"
     },
     "require-dev": {
+        "phpstan/phpstan": "^0.9.1",
         "phpunit/phpunit": "^6.0",
-        "squizlabs/php_codesniffer": "^2.3"
+        "slevomat/coding-standard": "^4.1",
+        "squizlabs/php_codesniffer": "^3.1"
     },
     "license": "MIT",
     "authors": [
@@ -40,16 +41,21 @@
     "scripts": {
         "check": [
             "@cs",
+            "@stan",
             "@test"
         ],
         "cs": "phpcs",
         "cs-fix": "phpcbf",
+        "stan": "phpstan analyse src/ --level=6",
         "test": "phpunit --coverage-clover build/clover.xml --colors=always",
         "pretty-test": "phpunit --coverage-html build/coverage"
     },
     "extra": {
         "zf": {
             "config-provider": "Acelaya\\ExpressiveErrorHandler\\ConfigProvider"
         }
+    },
+    "config": {
+        "sort-packages": true
     }
 }

phpcs.xml

@@ -1,6 +1,7 @@
 <?xml version="1.0"?>
 <ruleset name="Coding standard">
-    <description>Coding standard</description>
+    <description>Coding standard specification</description>
+    <config name="installed_paths" value="../../slevomat/coding-standard"/>
 
     <!-- display progress -->
     <arg value="p"/>
@@ -9,11 +10,35 @@
     <!-- inherit rules from: -->
     <rule ref="PSR2"/>
     <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
+    <!-- Make sure string concatenations use 1 space between every element -->
+    <rule ref="Squiz.Strings.ConcatenationSpacing">
+        <properties>
+            <property name="spacing" value="1"/>
+            <property name="ignoreNewlines" value="true"/>
+        </properties>
+    </rule>
     <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace">
         <properties>
             <property name="ignoreBlankLines" value="false"/>
         </properties>
     </rule>
+    <rule ref="Squiz.Strings.DoubleQuoteUsage"/>
+    <rule ref="SlevomatCodingStandard.TypeHints.DeclareStrictTypes">
+        <properties>
+            <property name="newlinesCountBetweenOpenTagAndDeclare" value="1"/>
+            <property name="spacesCountAroundEqualsSign" value="0"/>
+        </properties>
+    </rule>
+    <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
+        <properties>
+            <property name="searchAnnotations" value="true"/>
+        </properties>
+    </rule>
+    <!-- Force strict comparison with === or !== instead of == or != -->
+    <rule ref="SlevomatCodingStandard.ControlStructures.DisallowEqualOperators"/>
+    <rule ref="SlevomatCodingStandard.Arrays.TrailingArrayComma"/>
+    <rule ref="SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses"/>
+    <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing"/>
 
     <!-- Paths to check -->
     <file>src</file>

src/ConfigProvider.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace Acelaya\ExpressiveErrorHandler;
 
 use Acelaya\ExpressiveErrorHandler\ErrorHandler\ContentBasedErrorResponseGenerator;

src/ErrorHandler/ContentBasedErrorResponseGenerator.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace Acelaya\ExpressiveErrorHandler\ErrorHandler;
 
 use Acelaya\ExpressiveErrorHandler\Exception\InvalidArgumentException;
@@ -50,13 +52,13 @@ public function __construct(
     /**
      * Final handler for an application.
      *
-     * @param \Throwable $e
+     * @param \Throwable|null $e
      * @param Request $request
      * @param Response $response
      * @return Response
      * @throws InvalidArgumentException
      */
-    public function __invoke($e, Request $request, Response $response): Response
+    public function __invoke(?\Throwable $e, Request $request, Response $response): Response
     {
         // Try to get an error handler for provided request accepted type
         $errorHandler = $this->resolveErrorHandlerFromAcceptHeader($request);

src/ErrorHandler/ErrorResponseGeneratorInterface.php

@@ -1,18 +1,20 @@
 <?php
+declare(strict_types=1);
+
 namespace Acelaya\ExpressiveErrorHandler\ErrorHandler;
 
-use Psr\Http\Message\ServerRequestInterface as Request;
 use Psr\Http\Message\ResponseInterface as Response;
+use Psr\Http\Message\ServerRequestInterface as Request;
 
 interface ErrorResponseGeneratorInterface
 {
     /**
      * Final handler for an application.
      *
-     * @param \Throwable $e
+     * @param \Throwable|null $e
      * @param Request $request
      * @param Response $response
      * @return Response
      */
-    public function __invoke($e, Request $request, Response $response);
+    public function __invoke(?\Throwable $e, Request $request, Response $response);
 }

src/ErrorHandler/ErrorResponseGeneratorManager.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace Acelaya\ExpressiveErrorHandler\ErrorHandler;
 
 use Zend\ServiceManager\AbstractPluginManager;

src/ErrorHandler/ErrorResponseGeneratorManagerInterface.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace Acelaya\ExpressiveErrorHandler\ErrorHandler;
 
 use Interop\Container\ContainerInterface;

src/ErrorHandler/Factory/ContentBasedErrorResponseGeneratorFactory.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace Acelaya\ExpressiveErrorHandler\ErrorHandler\Factory;
 
 use Acelaya\ExpressiveErrorHandler\ErrorHandler\ContentBasedErrorResponseGenerator;

src/ErrorHandler/Factory/ErrorHandlerManagerFactory.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace Acelaya\ExpressiveErrorHandler\ErrorHandler\Factory;
 
 use Acelaya\ExpressiveErrorHandler\ErrorHandler\ErrorResponseGeneratorManager;

src/Exception/ExceptionInterface.php

@@ -1,7 +1,8 @@
 <?php
+declare(strict_types=1);
+
 namespace Acelaya\ExpressiveErrorHandler\Exception;
 
-interface ExceptionInterface
+interface ExceptionInterface extends \Throwable
 {
-
 }

src/Exception/InvalidArgumentException.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace Acelaya\ExpressiveErrorHandler\Exception;
 
 class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface

src/Log/BasicLogMessageBuilder.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace Acelaya\ExpressiveErrorHandler\Log;
 
 use Psr\Http\Message\ResponseInterface as Response;
@@ -11,13 +13,13 @@ class BasicLogMessageBuilder implements LogMessageBuilderInterface
      *
      * @param Request $request
      * @param Response $response
-     * @param null $err
+     * @param \Throwable|null $err
      * @return string
      */
-    public function buildMessage(Request $request, Response $response, $err = null)
+    public function buildMessage(Request $request, Response $response, \Throwable $err = null): string
     {
         $base = 'Error occurred while dispatching request';
-        if (! isset($err)) {
+        if ($err === null) {
             return $base;
         }
 

src/Log/LogMessageBuilderInterface.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace Acelaya\ExpressiveErrorHandler\Log;
 
 use Psr\Http\Message\ResponseInterface as Response;
@@ -11,8 +13,8 @@ interface LogMessageBuilderInterface
      *
      * @param Request $request
      * @param Response $response
-     * @param null $err
+     * @param \Throwable|null $err
      * @return string
      */
-    public function buildMessage(Request $request, Response $response, $err = null);
+    public function buildMessage(Request $request, Response $response, \Throwable $err = null): string;
 }

test/ConfigProviderTest.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace AcelayaTest\ExpressiveErrorHandler;
 
 use Acelaya\ExpressiveErrorHandler\ConfigProvider;

test/ErrorHandler/ContentBasedErrorHandlerTest.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace AcelayaTest\ExpressiveErrorHandler\ErrorHandler;
 
 use Acelaya\ExpressiveErrorHandler\ErrorHandler\ContentBasedErrorResponseGenerator;

test/ErrorHandler/ErrorHandlerManagerTest.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace AcelayaTest\ExpressiveErrorHandler\ErrorHandler;
 
 use Acelaya\ExpressiveErrorHandler\ErrorHandler\ErrorResponseGeneratorManager;
@@ -21,7 +23,7 @@ public function setUp()
             ],
             'invokables' => [
                 'invalid' => \stdClass::class,
-            ]
+            ],
         ]);
     }
 

test/ErrorHandler/Factory/ContentBasedErrorHandlerFactoryTest.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace AcelayaTest\ExpressiveErrorHandler\ErrorHandler\Factory;
 
 use Acelaya\ExpressiveErrorHandler\ErrorHandler\ContentBasedErrorResponseGenerator;

test/ErrorHandler/Factory/ErrorHandlerManagerFactoryTest.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace AcelayaTest\ExpressiveErrorHandler\ErrorHandler\Factory;
 
 use Acelaya\ExpressiveErrorHandler\ErrorHandler\ErrorResponseGeneratorManager;

test/Log/BasicLogMessageBuilderTest.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace AcelayaTest\ExpressiveErrorHandler\Log;
 
 use Acelaya\ExpressiveErrorHandler\Log\BasicLogMessageBuilder;
@@ -32,7 +34,7 @@ public function onlyBaseIsProvidedWithNoError()
      */
     public function errorIsIncludedWhenProvided()
     {
-        $err = 'A super critical error';
+        $err = new \Exception('A super critical error');
         $message = $this->messageBuilder->buildMessage(ServerRequestFactory::fromGlobals(), new Response(), $err);
         $this->assertEquals('Error occurred while dispatching request: ' . PHP_EOL . $err, $message);
     }