Merge pull request #13 from acelaya/develop

Develop

Author: acelaya

.gitattributes

@@ -0,0 +1,11 @@
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/.phpstorm.meta.php export-ignore
+/.scrutinizer.yml export-ignore
+/.travis.yml export-ignore
+/phpcs.xml export-ignore
+/phpunit.xml.dist export-ignore
+/composer.lock export-ignore
+/infection.json export-ignore
+/CHANGELOG.md export-ignore
+/test export-ignore

.travis.yml

@@ -2,23 +2,37 @@ language: php
 
 branches:
   only:
-    - master
-    - develop
+    - /.*/
 
-php:
-  - 7.1
-  - 7.2
+matrix:
+  include:
+    - php: 7.1
+      env:
+        - DEPS=lowest
+    - php: 7.1
+      env:
+        - DEPS=latest
+    - php: 7.2
+      env:
+        - DEPS=lowest
+    - php: 7.2
+      env:
+        - DEPS=latest
 
 before_script:
   - composer self-update
   - composer install --no-interaction
+  - if [[ $DEPS == 'latest' ]]; then composer update --no-interaction ; fi
+  - if [[ $DEPS == 'lowest' ]]; then composer update --no-interaction --prefer-lowest --prefer-stable ; fi
+  - composer show
 
 script:
   - mkdir build
-  - composer check
+  - if [[ $DEPS == 'latest' ]]; then composer ac:ci ; fi
+  - if [[ $DEPS == 'lowest' ]]; then composer ac:test ; fi
 
 after_script:
-  - wget https://scrutinizer-ci.com/ocular.phar
-  - php ocular.phar code-coverage:upload --format=php-clover build/clover.xml
+  - if [[ $DEPS == 'latest' ]]; then wget https://scrutinizer-ci.com/ocular.phar ; fi
+  - if [[ $DEPS == 'latest' ]]; then php ocular.phar code-coverage:upload --format=php-clover build/clover.xml ; fi
 
 sudo: false

CHANGELOG.md

@@ -1,5 +1,16 @@
 ## CHANGELOG
 
+### 2.2.0
+
+**Enhancements:**
+
+* [9: Add compatibility with expressive 3](https://github.com/acelaya/ze-content-based-error-handler/issues/9)
+
+**Tasks:**
+
+* [10: Add infection to the CI pipeline](https://github.com/acelaya/ze-content-based-error-handler/issues/10)
+* [11: Improve build matrix so that it passes build for lowest and latest supported dependencies](https://github.com/acelaya/ze-content-based-error-handler/issues/11)
+
 ### 2.1.1
 
 **Enhancements:**

composer.json

@@ -12,12 +12,13 @@
     "require": {
         "php": "^7.1",
         "psr/log": "^1.0",
-        "zendframework/zend-expressive": "^2.1",
+        "zendframework/zend-expressive": "^3.0 || ^2.1",
         "zendframework/zend-servicemanager": "^3.0"
     },
     "require-dev": {
+        "infection/infection": "^0.8.1",
         "phpstan/phpstan": "^0.9.1",
-        "phpunit/phpunit": "^6.0",
+        "phpunit/phpunit": "^7.0",
         "slevomat/coding-standard": "^4.1",
         "squizlabs/php_codesniffer": "^3.1"
     },
@@ -39,16 +40,20 @@
         }
     },
     "scripts": {
-        "check": [
-            "@cs",
-            "@stan",
-            "@test"
+        "ac:ci": [
+            "@ac:cs",
+            "@ac:stan",
+            "@ac:test",
+            "@ac:infection"
         ],
-        "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"
+
+        "ac:cs": "phpcs",
+        "ac:cs-fix": "phpcbf",
+        "ac:stan": "phpstan analyse src/ --level=6",
+        "ac:test": "phpunit --coverage-clover build/clover.xml --colors=always",
+        "ac:pretty-test": "phpunit --coverage-html build/coverage",
+        "ac:infection": "infection --threads=4 --min-msi=90 --log-verbosity=2 --only-covered",
+        "ac:infection-show": "infection --threads=4 --min-msi=90 --log-verbosity=2 --only-covered --show-mutations"
     },
     "extra": {
         "zf": {

infection.json

@@ -0,0 +1,16 @@
+{
+    "source": {
+        "directories": [
+            "src"
+        ]
+    },
+    "timeout": 10,
+    "logs": {
+        "text": "build/infection/infection-log.txt",
+        "summary": "build/infection/summary-log.txt",
+        "debug": "build/infection/debug-log.txt"
+    },
+    "phpUnit": {
+        "configDir": "."
+    }
+}

src/ConfigProvider.php

@@ -16,15 +16,15 @@
 
 class ConfigProvider
 {
-    public function __invoke()
+    public function __invoke(): array
     {
         return [
             'dependencies' => $this->createDependenciesConfig(),
             'error_handler' => $this->createErrorHandlerConfig(),
         ];
     }
 
-    private function createDependenciesConfig()
+    private function createDependenciesConfig(): array
     {
         return [
             'factories' => [
@@ -39,7 +39,7 @@ private function createDependenciesConfig()
         ];
     }
 
-    private function createErrorHandlerConfig()
+    private function createErrorHandlerConfig(): array
     {
         return [
             'default_content_type' => 'text/html',

src/ErrorHandler/ContentBasedErrorResponseGenerator.php

@@ -73,12 +73,12 @@ public function __invoke(?\Throwable $e, Request $request, Response $response):
      * @return callable
      * @throws InvalidArgumentException
      */
-    protected function resolveErrorHandlerFromAcceptHeader(Request $request): callable
+    private function resolveErrorHandlerFromAcceptHeader(Request $request): callable
     {
         // Try to find an error handler for one of the accepted content types
         $accepts = $request->hasHeader('Accept') ? $request->getHeaderLine('Accept') : $this->defaultContentType;
         /** @var array $accepts */
-        $accepts = explode(',', $accepts);
+        $accepts = \explode(',', $accepts);
         foreach ($accepts as $accept) {
             if (! $this->errorHandlerManager->has($accept)) {
                 continue;
@@ -93,10 +93,10 @@ protected function resolveErrorHandlerFromAcceptHeader(Request $request): callab
         }
 
         // It wasn't possible to find an error handler
-        throw new InvalidArgumentException(sprintf(
+        throw new InvalidArgumentException(\sprintf(
             'It wasn\'t possible to find an error handler for ["%s"] content types. '
             . 'Make sure you have registered at least the default "%s" content type',
-            implode('", "', $accepts),
+            \implode('", "', $accepts),
             $this->defaultContentType
         ));
     }

src/ErrorHandler/ErrorResponseGeneratorManager.php

@@ -8,16 +8,20 @@
 
 class ErrorResponseGeneratorManager extends AbstractPluginManager implements ErrorResponseGeneratorManagerInterface
 {
+    /**
+     * @param mixed $instance
+     * @throws InvalidServiceException
+     */
     public function validate($instance)
     {
-        if (is_callable($instance)) {
+        if (\is_callable($instance)) {
             return;
         }
 
-        throw new InvalidServiceException(sprintf(
-            'Only callables are valid plugins for "%s". "%s" provided',
+        throw new InvalidServiceException(\sprintf(
+            'Only callables are valid plugins for "%s", but "%s" was provided',
             __CLASS__,
-            is_object($instance) ? get_class($instance) : gettype($instance)
+            \is_object($instance) ? \get_class($instance) : \gettype($instance)
         ));
     }
 }

src/ErrorHandler/Factory/ContentBasedErrorResponseGeneratorFactory.php

@@ -28,7 +28,7 @@ class ContentBasedErrorResponseGeneratorFactory
     public function __invoke(ContainerInterface $container)
     {
         $config = $container->has('config') ? $container->get('config') : [];
-        $ehConfig = isset($config['error_handler']) ? $config['error_handler'] : [];
+        $ehConfig = $config['error_handler'] ?? [];
 
         $errorHandlerManager = $container->get(ErrorResponseGeneratorManager::class);
         $logger = $container->has(LoggerInterface::class) ? $container->get(LoggerInterface::class) : new NullLogger();
@@ -38,7 +38,7 @@ public function __invoke(ContainerInterface $container)
             $errorHandlerManager,
             $logger,
             $logMessageBuilder,
-            isset($ehConfig['default_content_type']) ? $ehConfig['default_content_type'] : 'text/html'
+            $ehConfig['default_content_type'] ?? 'text/html'
         );
     }
 }

src/ErrorHandler/Factory/ErrorHandlerManagerFactory.php

@@ -24,8 +24,7 @@ class ErrorHandlerManagerFactory
     public function __invoke(ContainerInterface $container)
     {
         $config = $container->has('config') ? $container->get('config') : [];
-        $errorHandlerConfig = isset($config['error_handler']) ? $config['error_handler'] : [];
-        $plugins = isset($errorHandlerConfig['plugins']) ? $errorHandlerConfig['plugins'] : [];
+        $plugins = $config['error_handler']['plugins'] ?? [];
         return new ErrorResponseGeneratorManager($container, $plugins);
     }
 }

src/Exception/InvalidArgumentException.php

@@ -5,5 +5,4 @@
 
 class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
 {
-
 }

src/Log/BasicLogMessageBuilder.php

@@ -23,6 +23,6 @@ public function buildMessage(Request $request, Response $response, \Throwable $e
             return $base;
         }
 
-        return $base . ': ' . PHP_EOL . $err;
+        return \sprintf('%s:%s%s', $base, PHP_EOL, $err);
     }
 }

test/ConfigProviderTest.php

@@ -24,6 +24,7 @@ public function setUp()
     public function configIsCorrect()
     {
         $config = $this->configProvider->__invoke();
+        $this->assertCount(2, $config);
         $this->assertArrayHasKey('dependencies', $config);
         $this->assertArrayHasKey('error_handler', $config);
     }

test/ErrorHandler/Factory/PlainTextResponseGeneratorFactoryTest.php

@@ -22,10 +22,30 @@ public function setUp()
 
     /**
      * @test
+     * @dataProvider provideDebugs
+     * @param array $config
+     * @param bool $expectedIsDev
      */
-    public function serviceIsCreated()
+    public function serviceIsCreated(array $config, bool $expectedIsDev)
     {
-        $instance = $this->factory->__invoke(new ServiceManager([]));
+        $instance = $this->factory->__invoke(new ServiceManager(['services' => [
+            'config' => $config,
+        ]]));
+
+        $ref = new \ReflectionObject($instance);
+        $isDev = $ref->getProperty('isDevelopmentMode');
+        $isDev->setAccessible(true);
+
         $this->assertInstanceOf(ErrorResponseGenerator::class, $instance);
+        $this->assertEquals($expectedIsDev, $isDev->getValue($instance));
+    }
+
+    public function provideDebugs(): array
+    {
+        return [
+            [[], false],
+            [['debug' => true], true],
+            [['debug' => false], false],
+        ];
     }
 }

test/Log/BasicLogMessageBuilderTest.php

@@ -36,6 +36,6 @@ public function errorIsIncludedWhenProvided()
     {
         $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);
+        $this->assertEquals('Error occurred while dispatching request:' . PHP_EOL . $err, $message);
     }
 }