Merge pull request #17 from php-middleware/psr-15

psr-15

Author: snapshotpl

.travis.yml

@@ -1,20 +1,19 @@
 language: php
 
 php:
-  - 5.5
   - 5.6
   - 7.0
   - 7.1
-  - hhvm
 
 env:
   - DEPS=lowest
   - DEPS=latest
 
 before_script:
+  - phpenv config-rm xdebug.ini
   - composer self-update
-  - if [[ $DEPS == 'lowest' ]]; then travis_retry composer update --prefer-lowest --prefer-stable --no-interaction ; fi
-  - travis_retry composer install --no-interaction
+  - if [[ $DEPS == 'lowest' ]]; then composer update --prefer-stable --no-interaction --prefer-lowest ; fi
+  - if [[ $DEPS == 'latest' ]]; then composer update --prefer-stable --no-interaction ; fi
 
 script:
   - ./vendor/bin/phpunit

README.md

@@ -1,7 +1,7 @@
 # phpdebugbar middleware [![Build Status](https://travis-ci.org/php-middleware/phpdebugbar.svg?branch=master)](https://travis-ci.org/php-middleware/phpdebugbar)
-PHP Debug bar middleware with PSR-7
+PHP Debug bar PSR-15 middleware with PSR-7
 
-This middleware provide framework-agnostic possibility to attach [PHP Debug bar](http://phpdebugbar.com/) to your response (html on non-html!).
+This middleware provide framework-agnostic possibility to attach [PHP Debug Bar](http://phpdebugbar.com/) to your response (html on non-html!).
 
 ## Installation
 
@@ -18,7 +18,7 @@ $middleware = new PhpMiddleware\PhpDebugBar\PhpDebugBarMiddleware($debugbarRende
 
 // OR
 
-$factory = PhpMiddleware\PhpDebugBar\PhpDebugBarMiddlewareFactory();
+$factory = new PhpMiddleware\PhpDebugBar\PhpDebugBarMiddlewareFactory();
 $middleware = $factory();
 
 $app = new MiddlewareRunner();
@@ -61,7 +61,6 @@ $app->add($app->getContainer()->get('debugbar_middleware'));
 Put array with configuration into `config` service in your container:
 
 ```php
-<?php
 return [
     'phpmiddleware' => [
         'phpdebugbar' => [

composer.json

@@ -1,27 +1,30 @@
 {
     "name": "php-middleware/php-debug-bar",
-    "description": "PHP Debug bar middleware with PSR-7",
+    "description": "PHP Debug Bar PSR-15 middleware with PSR-7",
     "type": "library",
     "keywords": [
         "debug",
         "middleware",
         "psr",
-        "psr-7"
+        "psr-7",
+        "psr-15"
     ],
     "require": {
-        "php": "^5.5 || ^7.0",
-        "maximebf/debugbar": "^1.10",
+        "php": ">=5.6",
+        "http-interop/http-middleware": "^0.4.1",
+        "maximebf/debugbar": "^1.4",
+        "php-middleware/double-pass-compatibility": "^1.0",
+        "psr/container": "^1.0",
         "psr/http-message": "^1.0",
-        "container-interop/container-interop": "^1.1",
         "zendframework/zend-diactoros": "^1.1.3"
     },
     "require-dev": {
-        "phpunit/phpunit": "^4.8.6",
-        "mikey179/vfsStream": "^1.6",
+        "phpunit/phpunit": "^5.7.19 || ^6.1.3",
+        "mikey179/vfsStream": "^1.6.4",
         "slim/slim": "^3.0",
-        "zendframework/zend-expressive": "^1.0",
-        "zendframework/zend-expressive-fastroute": "^1.0",
-        "zendframework/zend-servicemanager": "^3.0"
+        "zendframework/zend-expressive": "^1.0 || ^2.0",
+        "zendframework/zend-expressive-fastroute": "^1.0 || ^2.0",
+        "zendframework/zend-servicemanager": "^3.3"
     },
     "autoload": {
         "psr-4": {

phpunit.xml

@@ -2,7 +2,7 @@
 
 <phpunit bootstrap="./vendor/autoload.php" colors="true">
     <testsuites>
-        <testsuite name="PhpMiddleware\\PhpDebugBar Tests">
+        <testsuite>
             <directory>./test</directory>
         </testsuite>
     </testsuites>

src/ConfigCollectorFactory.php

@@ -3,7 +3,7 @@
 namespace PhpMiddleware\PhpDebugBar;
 
 use DebugBar\DataCollector\ConfigCollector;
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 
 final class ConfigCollectorFactory
 {

src/JavascriptRendererFactory.php

@@ -4,7 +4,7 @@
 
 use DebugBar\DebugBar;
 use DebugBar\JavascriptRenderer;
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 
 final class JavascriptRendererFactory
 {

src/PhpDebugBarMiddleware.php

@@ -3,6 +3,9 @@
 namespace PhpMiddleware\PhpDebugBar;
 
 use DebugBar\JavascriptRenderer as DebugBarRenderer;
+use Interop\Http\ServerMiddleware\DelegateInterface;
+use Interop\Http\ServerMiddleware\MiddlewareInterface;
+use PhpMiddleware\DoublePassCompatibilityTrait;
 use Psr\Http\Message\MessageInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -18,64 +21,71 @@
  *
  * @author Witold Wasiczko <[email protected]>
  */
-class PhpDebugBarMiddleware
+class PhpDebugBarMiddleware implements MiddlewareInterface
 {
-    /**
-     * @var DebugBarRenderer
-     */
+    use DoublePassCompatibilityTrait;
+
     protected $debugBarRenderer;
 
-    /**
-     * @param DebugBarRenderer $debugbarRenderer
-     */
     public function __construct(DebugBarRenderer $debugbarRenderer)
     {
         $this->debugBarRenderer = $debugbarRenderer;
     }
 
     /**
-     * @param ServerRequestInterface $request
-     * @param ResponseInterface $response
-     * @param callable $next
-     *
-     * @return ResponseInterface
+     * @inheritDoc
      */
-    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, callable $next)
+    public function process(ServerRequestInterface $request, DelegateInterface $delegate)
     {
         if ($staticFile = $this->getStaticFile($request->getUri())) {
             return $staticFile;
         }
 
-        $outResponse = $next($request, $response);
+        $response = $delegate->process($request);
 
         if (!$this->isHtmlAccepted($request)) {
-            return $outResponse;
+            return $response;
         }
 
-        $debugBarHead = $this->debugBarRenderer->renderHead();
-        $debugBarBody = $this->debugBarRenderer->render();
-
-        if ($this->isHtmlResponse($outResponse)) {
-            $body = $outResponse->getBody();
-            if (! $body->eof() && $body->isSeekable()) {
-                $body->seek(0, SEEK_END);
-            }
-            $body->write($debugBarHead . $debugBarBody);
-
-            return $outResponse;
+        if ($this->isHtmlResponse($response)) {
+            return $this->attachDebugBarToResponse($response);
         }
+        return $this->prepareHtmlResponseWithDebugBar($response);
+    }
 
-        $outResponseBody = Serializer::toString($outResponse);
+    /**
+     * @return HtmlResponse
+     */
+    private function prepareHtmlResponseWithDebugBar(ResponseInterface $response)
+    {
+        $head = $this->debugBarRenderer->renderHead();
+        $body = $this->debugBarRenderer->render();
+        $outResponseBody = Serializer::toString($response);
         $template = '<html><head>%s</head><body><h1>DebugBar</h1><p>Response:</p><pre>%s</pre>%s</body></html>';
         $escapedOutResponseBody = htmlspecialchars($outResponseBody);
-        $result = sprintf($template, $debugBarHead, $escapedOutResponseBody, $debugBarBody);
+        $result = sprintf($template, $head, $escapedOutResponseBody, $body);
 
         return new HtmlResponse($result);
     }
 
     /**
-     * @param UriInterface $uri
-     *
+     * @return ResponseInterface
+     */
+    private function attachDebugBarToResponse(ResponseInterface $response)
+    {
+        $head = $this->debugBarRenderer->renderHead();
+        $body = $this->debugBarRenderer->render();
+        $responseBody = $response->getBody();
+
+        if (! $responseBody->eof() && $responseBody->isSeekable()) {
+            $responseBody->seek(0, SEEK_END);
+        }
+        $responseBody->write($head . $body);
+
+        return $response;
+    }
+
+    /**
      * @return ResponseInterface|null
      */
     private function getStaticFile(UriInterface $uri)
@@ -139,11 +149,7 @@ private function getContentTypeByFileName($filename)
             'woff2' => 'application/font-woff2',
         ];
 
-        if (isset($map[$ext])) {
-            return $map[$ext];
-        }
-
-        return 'text/plain';
+        return isset($map[$ext]) ? $map[$ext] : 'text/plain';
     }
 
     /**

src/PhpDebugBarMiddlewareFactory.php

@@ -3,7 +3,7 @@
 namespace PhpMiddleware\PhpDebugBar;
 
 use DebugBar\JavascriptRenderer;
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 
 final class PhpDebugBarMiddlewareFactory
 {

src/StandardDebugBarFactory.php

@@ -3,7 +3,7 @@
 namespace PhpMiddleware\PhpDebugBar;
 
 use DebugBar\StandardDebugBar;
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 
 final class StandardDebugBarFactory
 {

test/AbstractMiddlewareRunnerTest.php

@@ -2,11 +2,11 @@
 
 namespace PhpMiddlewareTest\PhpDebugBar;
 
-use PHPUnit_Framework_TestCase;
+use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 
-abstract class AbstractMiddlewareRunnerTest extends PHPUnit_Framework_TestCase
+abstract class AbstractMiddlewareRunnerTest extends TestCase
 {
 
     final public function testAppendJsIntoHtmlContent()

test/PhpDebugBarMiddlewareFactoryTest.php

@@ -4,12 +4,12 @@
 
 use PhpMiddleware\PhpDebugBar\PhpDebugBarMiddleware;
 use PhpMiddleware\PhpDebugBar\PhpDebugBarMiddlewareFactory;
-use PHPUnit_Framework_TestCase;
+use PHPUnit\Framework\TestCase;
 
 /**
  * @author Witold Wasiczko <[email protected]>
  */
-class PhpDebugBarMiddlewareFactoryTest extends PHPUnit_Framework_TestCase
+class PhpDebugBarMiddlewareFactoryTest extends TestCase
 {
     public function testFactory()
     {

test/PhpDebugBarMiddlewareTest.php

@@ -5,7 +5,7 @@
 use DebugBar\JavascriptRenderer;
 use org\bovigo\vfs\vfsStream;
 use PhpMiddleware\PhpDebugBar\PhpDebugBarMiddleware;
-use PHPUnit_Framework_TestCase;
+use PHPUnit\Framework\TestCase;
 use Zend\Diactoros\Response;
 use Zend\Diactoros\ServerRequest;
 use Zend\Diactoros\Uri;
@@ -15,7 +15,7 @@
  *
  * @author Witold Wasiczko <[email protected]>
  */
-class PhpDebugBarMiddlewareTest extends PHPUnit_Framework_TestCase
+class PhpDebugBarMiddlewareTest extends TestCase
 {
     protected $debugbarRenderer;
     protected $middleware;

test/ZendExpressiveTest.php

@@ -2,26 +2,17 @@
 
 namespace PhpMiddlewareTest\PhpDebugBar;
 
-use Interop\Container\ContainerInterface;
 use PhpMiddleware\PhpDebugBar\ConfigProvider;
+use Psr\Container\ContainerInterface;
+use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Zend\Diactoros\Response\EmitterInterface;
 use Zend\Diactoros\ServerRequestFactory;
 use Zend\Expressive\Container\ApplicationFactory;
 use Zend\ServiceManager\ServiceManager;
-use Zend\Stratigility\Http\ResponseInterface;
 
 final class ZendExpressiveTest extends AbstractMiddlewareRunnerTest
 {
-    private $testEmitter;
-
-    protected function setUp()
-    {
-        parent::setUp();
-
-        $this->testEmitter = new TestEmitter();
-    }
-
     final public function testContainsConfigCollectorOutput()
     {
         $response = $this->dispatchApplication([
@@ -58,7 +49,7 @@ protected function dispatchApplication(array $server, array $pipe = [])
 
         $app->run($serverRequest);
 
-        return $this->testEmitter->getResponse();
+        return $container->get(EmitterInterface::class)->getResponse();
     }
 
     /**
@@ -71,7 +62,7 @@ private function createContainer()
 
         $serviceManagerConfig = $config['dependencies'];
         $serviceManagerConfig['services']['config'] = $config;
-        $serviceManagerConfig['services'][EmitterInterface::class] = $this->testEmitter;
+        $serviceManagerConfig['services'][EmitterInterface::class] = new TestEmitter();
 
         return new ServiceManager($serviceManagerConfig);
     }