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

snapshotpl · web-flow · commit 2f59dcae2e28 · 2017-05-12T00:06:08.000+02:00
Psr 15
diff --git a/.travis.yml b/.travis.yml
@@ -1,16 +1,19 @@
 language: php
 
-matrix:
-  fast_finish: true
-  include:
-    - php: 5.5
-    - php: 5.6
-    - php: 7
-    - php: hhvm
+php:
+  - 5.6
+  - 7.0
+  - 7.1
 
-install:
-  - travis_retry composer install --no-interaction --ignore-platform-reqs --prefer-source
-  - composer info -i
+env:
+  - DEPS=lowest
+  - DEPS=latest
+
+before_script:
+  - phpenv config-rm xdebug.ini
+  - composer self-update
+  - 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
diff --git a/composer.json b/composer.json
@@ -9,11 +9,13 @@
         "request-id"
     ],
     "require": {
-        "php": "^5.5 || ^7.0",
-        "psr/http-message": "^1.0"
+        "php": "^5.6 || ^7.0",
+        "psr/http-message": "^1.0",
+        "php-middleware/double-pass-compatibility": "^1.0",
+        "http-interop/http-middleware": "^0.4.1"
     },
     "require-dev": {
-        "phpunit/phpunit": "^4.8.6",
+        "phpunit/phpunit": "^5.6 || ^6.1.3",
         "ramsey/uuid": "^3.0",
         "zendframework/zend-diactoros": "^1.1.3"
     },
diff --git a/phpunit.xml b/phpunit.xml
@@ -2,16 +2,11 @@
 
 <phpunit bootstrap="./vendor/autoload.php" colors="true">
     <testsuites>
-        <testsuite name="PhpMiddleware\\LogHttpMessages Tests">
+        <testsuite>
             <directory>./test</directory>
         </testsuite>
     </testsuites>
 
-    <logging>
-        <log type="coverage-clover" target="tmp/phpunit-coverage-clover.xml"/>
-        <log type="coverage-html" target="tmp/" />
-    </logging>
-
     <filter>
         <whitelist processUncoveredFilesFromWhitelist="true">
             <directory suffix=".php">./src</directory>
diff --git a/src/RequestIdMiddleware.php b/src/RequestIdMiddleware.php
@@ -2,13 +2,18 @@
 
 namespace PhpMiddleware\RequestId;
 
+use Interop\Http\ServerMiddleware\DelegateInterface;
+use Interop\Http\ServerMiddleware\MiddlewareInterface;
+use PhpMiddleware\DoublePassCompatibilityTrait;
 use PhpMiddleware\RequestId\Exception\NotGenerated;
 use PhpMiddleware\RequestId\RequestIdProviderFactoryInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 
-final class RequestIdMiddleware implements RequestIdProviderInterface
+final class RequestIdMiddleware implements RequestIdProviderInterface, MiddlewareInterface
 {
+    use DoublePassCompatibilityTrait;
+
     const DEFAULT_RESPONSE_HEADER = 'X-Request-Id';
     const ATTRIBUTE_NAME = 'request-id';
 
@@ -40,26 +45,45 @@ public function __construct(
     }
 
     /**
-     * @param ServerRequestInterface $request
-     * @param ResponseInterface $response
-     * @param callable $next
-     *
      * @return ResponseInterface
      */
-    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, callable $next)
+    public function process(ServerRequestInterface $request, DelegateInterface $delegate)
     {
-        $requestIdProvider = $this->requestIdProviderFactory->create($request);
+        $requestWithAttribute = $this->attachRequestIdToAttribute($request);
 
+        $response = $delegate->process($requestWithAttribute);
+
+        if ($this->canAttachToResponse()) {
+            return $this->attachRequestIdToResponse($response);
+        }
+        return $response;
+    }
+
+    /**
+     * @return ResponseInterface
+     */
+    private function attachRequestIdToAttribute(ServerRequestInterface $request)
+    {
+        $requestIdProvider = $this->requestIdProviderFactory->create($request);
         $this->requestId = $requestIdProvider->getRequestId();
 
-        $requestWithAttribute = $request->withAttribute(self::ATTRIBUTE_NAME, $this->requestId);
+        return $request->withAttribute(self::ATTRIBUTE_NAME, $this->requestId);
+    }
 
-        $nextResponse = $next($requestWithAttribute, $response);
+    /**
+     * @return ResponseInterface
+     */
+    private function attachRequestIdToResponse(ResponseInterface $response)
+    {
+        return $response->withHeader($this->responseHeader, $this->requestId);
+    }
 
-        if (is_string($this->responseHeader)) {
-            return $nextResponse->withHeader($this->responseHeader, $this->requestId);
-        }
-        return $nextResponse;
+    /**
+     * @return bool
+     */
+    private function canAttachToResponse()
+    {
+        return is_string($this->responseHeader) && !empty($this->responseHeader);
     }
 
     /**
diff --git a/test/Generator/Md5GeneratorTest.php b/test/Generator/Md5GeneratorTest.php
@@ -4,15 +4,15 @@
 
 use PhpMiddleware\RequestId\Generator\GeneratorInterface;
 use PhpMiddleware\RequestId\Generator\Md5Generator;
-use PHPUnit_Framework_TestCase;
+use PHPUnit\Framework\TestCase;
 
-class Md5GeneratorTest extends PHPUnit_Framework_TestCase
+class Md5GeneratorTest extends TestCase
 {
     protected $generator;
 
     protected function setUp()
     {
-        $decoratedGenerator = $this->getMock(GeneratorInterface::class);
+        $decoratedGenerator = $this->createMock(GeneratorInterface::class);
         $decoratedGenerator->method('generateRequestId')->willReturn('boo');
 
         $this->generator = new Md5Generator($decoratedGenerator);
diff --git a/test/Generator/PhpUniqidGeneratorTest.php b/test/Generator/PhpUniqidGeneratorTest.php
@@ -3,9 +3,9 @@
 namespace PhpMiddlewareTestTest\RequestId\Generator;
 
 use PhpMiddleware\RequestId\Generator\PhpUniqidGenerator;
-use PHPUnit_Framework_TestCase;
+use PHPUnit\Framework\TestCase;
 
-class PhpUniqidGeneratorTest extends PHPUnit_Framework_TestCase
+class PhpUniqidGeneratorTest extends TestCase
 {
     protected $generator;
 
diff --git a/test/Generator/PrefixedGeneratorTest.php b/test/Generator/PrefixedGeneratorTest.php
@@ -4,15 +4,15 @@
 
 use PhpMiddleware\RequestId\Generator\GeneratorInterface;
 use PhpMiddleware\RequestId\Generator\PrefixedGenerator;
-use PHPUnit_Framework_TestCase;
+use PHPUnit\Framework\TestCase;
 
-class PrefixedGeneratorTest extends PHPUnit_Framework_TestCase
+class PrefixedGeneratorTest extends TestCase
 {
     protected $decoratedGenerator;
 
     protected function setUp()
     {
-        $this->decoratedGenerator = $this->getMock(GeneratorInterface::class);
+        $this->decoratedGenerator = $this->createMock(GeneratorInterface::class);
         $this->decoratedGenerator->method('generateRequestId')->willReturn('boo');
     }
 
diff --git a/test/Generator/RamseyFactoryUuidGeneratorTest.php b/test/Generator/RamseyFactoryUuidGeneratorTest.php
@@ -6,20 +6,20 @@
 use PhpMiddleware\RequestId\Generator\RamseyUuid3Generator;
 use PhpMiddleware\RequestId\Generator\RamseyUuid4Generator;
 use PhpMiddleware\RequestId\Generator\RamseyUuid5Generator;
-use PHPUnit_Framework_TestCase;
+use PHPUnit\Framework\TestCase;
 use Ramsey\Uuid\UuidFactoryInterface;
 use Ramsey\Uuid\UuidInterface;
 
-class RamseyFactoryUuidGeneratorTest extends PHPUnit_Framework_TestCase
+class RamseyFactoryUuidGeneratorTest extends TestCase
 {
     protected $factory;
     protected $uuid;
 
     protected function setUp()
     {
-        $this->factory = $this->getMock(UuidFactoryInterface::class);
+        $this->factory = $this->createMock(UuidFactoryInterface::class);
 
-        $this->uuid = $this->getMock(UuidInterface::class);
+        $this->uuid = $this->createMock(UuidInterface::class);
         $this->uuid->method('toString')->willReturn('uuid');
     }
 
diff --git a/test/Generator/RamseyUuid4StaticGeneratorTest.php b/test/Generator/RamseyUuid4StaticGeneratorTest.php
@@ -3,11 +3,11 @@
 namespace PhpMiddlewareTestTest\RequestId\Generator;
 
 use PhpMiddleware\RequestId\Generator\RamseyUuid4StaticGenerator;
-use PHPUnit_Framework_TestCase;
+use PHPUnit\Framework\TestCase;
 use Ramsey\Uuid\Uuid;
 use Ramsey\Uuid\UuidInterface;
 
-class RamseyUuid4StaticGeneratorTest extends PHPUnit_Framework_TestCase
+class RamseyUuid4StaticGeneratorTest extends TestCase
 {
     protected $generator;
 
diff --git a/test/MonologProcessorTest.php b/test/MonologProcessorTest.php
@@ -5,13 +5,11 @@
 use PhpMiddleware\RequestId\Exception\MissingRequestId;
 use PhpMiddleware\RequestId\MonologProcessor;
 use PhpMiddleware\RequestId\RequestIdProviderInterface;
+use PHPUnit\Framework\TestCase;
 
-class MonologProcessorTest extends \PHPUnit_Framework_TestCase
+class MonologProcessorTest extends TestCase
 {
     protected $processor;
-    /**
-     * @var RequestIdProviderInterface|\PHPUnit_Framework_MockObject_MockObject
-     */
     private $requestIdProvider;
 
     public function testIsRequestIdInRecord()
@@ -38,7 +36,7 @@ public function testIsMissingRequestIdExceptionHandledProperly()
 
     protected function setUp()
     {
-        $this->requestIdProvider = $this->getMock(RequestIdProviderInterface::class);
+        $this->requestIdProvider = $this->createMock(RequestIdProviderInterface::class);
         $this->processor         = new MonologProcessor($this->requestIdProvider);
     }
 }
diff --git a/test/RequestDecoratorTest.php b/test/RequestDecoratorTest.php
@@ -4,24 +4,25 @@
 
 use PhpMiddleware\RequestId\RequestDecorator;
 use PhpMiddleware\RequestId\RequestIdProviderInterface;
+use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\RequestInterface;
 
-class RequestDecoratorTest extends \PHPUnit_Framework_TestCase
+class RequestDecoratorTest extends TestCase
 {
     const CUSTOM_HEADER_NAME = 'custom-header-name';
 
     protected $decorator;
 
     protected function setUp()
     {
-        $requestIdProvider = $this->getMock(RequestIdProviderInterface::class);
+        $requestIdProvider = $this->createMock(RequestIdProviderInterface::class);
         $requestIdProvider->expects($this->once())->method('getRequestId')->willReturn('boo');
         $this->decorator = new RequestDecorator($requestIdProvider, self::CUSTOM_HEADER_NAME);
     }
 
     public function testIsRequestDecorated()
     {
-        $request = $this->getMock(RequestInterface::class);
+        $request = $this->createMock(RequestInterface::class);
         $request->expects($this->once())->method('withHeader')->willReturnCallback(function($name, $value) use ($request) {
             $this->assertSame(self::CUSTOM_HEADER_NAME, $name);
             $this->assertSame('boo', $value);
diff --git a/test/RequestIdMiddlewareTest.php b/test/RequestIdMiddlewareTest.php
@@ -7,17 +7,17 @@
 use PhpMiddleware\RequestId\RequestIdProvider;
 use PhpMiddleware\RequestId\RequestIdProviderFactoryInterface;
 use PhpMiddleware\RequestId\RequestIdProviderInterface;
-use PHPUnit_Framework_TestCase;
+use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\ServerRequestInterface;
 use Zend\Diactoros\Response;
 use Zend\Diactoros\ServerRequest;
 
-class RequestIdMiddlewareTest extends PHPUnit_Framework_TestCase
+class RequestIdMiddlewareTest extends TestCase
 {
     public function testEmmitRequestIdToResponse()
     {
-        $requestIdProviderFactory = $this->getMock(RequestIdProviderFactoryInterface::class);
-        $requestIdProvider = $this->getMock(RequestIdProviderInterface::class);
+        $requestIdProviderFactory = $this->createMock(RequestIdProviderFactoryInterface::class);
+        $requestIdProvider = $this->createMock(RequestIdProviderInterface::class);
 
         $requestIdProviderFactory->method('create')->willReturn($requestIdProvider);
         $requestIdProvider->method('getRequestId')->willReturn('123456789');
@@ -45,8 +45,8 @@ public function testEmmitRequestIdToResponse()
 
     public function testNotEmmitRequestIdToResponse()
     {
-        $requestIdProviderFactory = $this->getMock(RequestIdProviderFactoryInterface::class);
-        $requestIdProvider = $this->getMock(RequestIdProviderInterface::class);
+        $requestIdProviderFactory = $this->createMock(RequestIdProviderFactoryInterface::class);
+        $requestIdProvider = $this->createMock(RequestIdProviderInterface::class);
 
         $requestIdProviderFactory->method('create')->willReturn($requestIdProvider);
         $requestIdProvider->method('getRequestId')->willReturn('123456789');
@@ -74,11 +74,12 @@ public function testNotEmmitRequestIdToResponse()
 
     public function testTryToGetRequestIdBeforeRunMiddleware()
     {
-        $this->setExpectedException(MissingRequestId::class);
-
-        $requestIdProviderFactory = $this->getMock(RequestIdProviderFactoryInterface::class);
+        $requestIdProviderFactory = $this->createMock(RequestIdProviderFactoryInterface::class);
 
         $middleware = new RequestIdMiddleware($requestIdProviderFactory);
+
+        $this->expectException(MissingRequestId::class);
+
         $middleware->getRequestId();
     }
 }
diff --git a/test/RequestIdProviderTest.php b/test/RequestIdProviderTest.php

Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,9 @@`
`3`	`3`	`namespace PhpMiddlewareTestTest\RequestId\Generator;`
`4`	`4`
`5`	`5`	`use PhpMiddleware\RequestId\Generator\PhpUniqidGenerator;`
`6`		`-use PHPUnit_Framework_TestCase;`
	`6`	`+use PHPUnit\Framework\TestCase;`
`7`	`7`
`8`		`-class PhpUniqidGeneratorTest extends PHPUnit_Framework_TestCase`
	`8`	`+class PhpUniqidGeneratorTest extends TestCase`
`9`	`9`	`{`
`10`	`10`	`protected $generator;`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -4,15 +4,15 @@`
`4`	`4`
`5`	`5`	`use PhpMiddleware\RequestId\Generator\GeneratorInterface;`
`6`	`6`	`use PhpMiddleware\RequestId\Generator\PrefixedGenerator;`
`7`		`-use PHPUnit_Framework_TestCase;`
	`7`	`+use PHPUnit\Framework\TestCase;`
`8`	`8`
`9`		`-class PrefixedGeneratorTest extends PHPUnit_Framework_TestCase`
	`9`	`+class PrefixedGeneratorTest extends TestCase`
`10`	`10`	`{`
`11`	`11`	`protected $decoratedGenerator;`
`12`	`12`
`13`	`13`	`protected function setUp()`
`14`	`14`	`{`
`15`		`- $this->decoratedGenerator = $this->getMock(GeneratorInterface::class);`
	`15`	`+ $this->decoratedGenerator = $this->createMock(GeneratorInterface::class);`
`16`	`16`	`$this->decoratedGenerator->method('generateRequestId')->willReturn('boo');`
`17`	`17`	`}`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -5,13 +5,11 @@`
`5`	`5`	`use PhpMiddleware\RequestId\Exception\MissingRequestId;`
`6`	`6`	`use PhpMiddleware\RequestId\MonologProcessor;`
`7`	`7`	`use PhpMiddleware\RequestId\RequestIdProviderInterface;`
	`8`	`+use PHPUnit\Framework\TestCase;`
`8`	`9`
`9`		`-class MonologProcessorTest extends \PHPUnit_Framework_TestCase`
	`10`	`+class MonologProcessorTest extends TestCase`
`10`	`11`	`{`
`11`	`12`	`protected $processor;`
`12`		`- /**`
`13`		`- * @var RequestIdProviderInterface\|\PHPUnit_Framework_MockObject_MockObject`
`14`		`- */`
`15`	`13`	`private $requestIdProvider;`
`16`	`14`
`17`	`15`	`public function testIsRequestIdInRecord()`
`@@ -38,7 +36,7 @@ public function testIsMissingRequestIdExceptionHandledProperly()`
`38`	`36`
`39`	`37`	`protected function setUp()`
`40`	`38`	`{`
`41`		`- $this->requestIdProvider = $this->getMock(RequestIdProviderInterface::class);`
	`39`	`+ $this->requestIdProvider = $this->createMock(RequestIdProviderInterface::class);`
`42`	`40`	`$this->processor = new MonologProcessor($this->requestIdProvider);`
`43`	`41`	`}`
`44`	`42`	`}`