Merge pull request #76 from sunrise-php/release/v2.10.1

v2.10.1

Author: fenric

.circleci/config.yml

@@ -11,39 +11,39 @@ jobs:
       - checkout
       - run: php -v
       - run: composer install --no-interaction --no-suggest --prefer-source
-      - run: php vendor/bin/phpunit --colors=always
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
   php72:
     docker:
       - image: circleci/php:7.2-cli-node-browsers
     steps:
       - checkout
       - run: php -v
       - run: composer install --no-interaction --no-suggest --prefer-source
-      - run: php vendor/bin/phpunit --colors=always
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
   php73:
     docker:
       - image: circleci/php:7.3-cli-node-browsers
     steps:
       - checkout
       - run: php -v
       - run: composer install --no-interaction --no-suggest --prefer-source
-      - run: php vendor/bin/phpunit --colors=always
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
   php74:
     docker:
       - image: circleci/php:7.4-cli-node-browsers
     steps:
       - checkout
       - run: php -v
       - run: composer install --no-interaction --no-suggest --prefer-source
-      - run: php vendor/bin/phpunit --colors=always
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
   php80:
     docker:
       - image: circleci/php:8.0-cli-node-browsers
     steps:
       - checkout
       - run: php -v
       - run: composer install --no-interaction --no-suggest --prefer-source
-      - run: php vendor/bin/phpunit --colors=always
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
 workflows:
   version: 2
   build:

.gitignore

@@ -1,8 +1,8 @@
-.php_cs.cache
-.phpunit.result.cache
-composer.lock
-coverage.xml
-phpbench.json
-phpcs.xml
-phpunit.xml
-vendor/
+/.php_cs.cache
+/.phpunit.result.cache
+/composer.lock
+/coverage.xml
+/phpbench.json
+/phpcs.xml
+/phpunit.xml
+/vendor/

.scrutinizer.yml

@@ -1,4 +1,7 @@
 build:
+  environment:
+    php:
+      version: '8.0'
   nodes:
     analysis:
       tests:
@@ -7,7 +10,7 @@ build:
     coverage:
       tests:
         override:
-          - command: php vendor/bin/phpunit --coverage-clover coverage.xml
+          - command: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-clover coverage.xml
             coverage:
               file: coverage.xml
               format: clover

README.md

@@ -1,4 +1,4 @@
-# HTTP router for PHP 7.1+ (incl. PHP 8 with attributes) based on PSR-7 and PSR-15 with support for annotations and OpenApi (Swagger)
+# HTTP router for PHP 7.1+ (incl. PHP 8 with attributes) based on PSR-7 and PSR-15 with support for annotations and OpenAPI (Swagger) Specification
 
 [![Build Status](https://circleci.com/gh/sunrise-php/http-router.svg?style=shield)](https://circleci.com/gh/sunrise-php/http-router)
 [![Code Coverage](https://scrutinizer-ci.com/g/sunrise-php/http-router/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/sunrise-php/http-router/?branch=master)
@@ -15,17 +15,24 @@
 composer require 'sunrise/http-router:^2.10'
 ```
 
+## Support for OpenAPI (Swagger) Specification (optional)
+
+```bash
+composer require 'sunrise/http-router-openapi:^2.0'
+```
+
+More details can be found here: [sunrise/http-router-openapi](https://github.com/sunrise-php/http-router-openapi).
+
 ## QuickStart
 
-The example uses other sunrise packages, but you can use, for example, `zend/diactoros` or any other.
+This example uses other sunrise packages, but you can use e.g. `zend/diactoros` or any other.
 
 ```bash
 composer require sunrise/http-message sunrise/http-server-request
 ```
 
 ```php
 use Sunrise\Http\Message\ResponseFactory;
-use Sunrise\Http\Router\RequestHandler\CallableRequestHandler;
 use Sunrise\Http\Router\RouteCollector;
 use Sunrise\Http\Router\Router;
 use Sunrise\Http\ServerRequest\ServerRequestFactory;
@@ -34,14 +41,24 @@ use function Sunrise\Http\Router\emit;
 
 $collector = new RouteCollector();
 
-// set container if necessary...
-$collector->setContainer($container);
+// PSR-15 request handler (optimal performance):
+$collector->get('home', '/', new HomeRequestHandler());
 
-$collector->get('home', '/', new CallableRequestHandler(function ($request) {
-    return (new ResponseFactory)->createJsonResponse(200, [
-        'status' => 'ok',
-    ]);
-}));
+// or you can use an anonymous function as your request handler:
+$collector->get('home', '/', function ($request) {
+    return (new ResponseFactory)->createResponse(200);
+});
+
+// or you can use the name of a class that implements PSR-15:
+$collector->get('home', '/', HomeRequestHandler::class);
+
+// or you can use a class method name as your request handler:
+// (note that such a class mayn't implement PSR-15)
+$collector->get('home', '/', [HomeRequestHandler::class, 'index']);
+
+// most likely you will need to use PSR-11 container:
+// (note that only named classes will be pulled from such a container)
+$collector->setContainer($container);
 
 $router = new Router();
 $router->addRoute(...$collector->getCollection()->all());
@@ -412,48 +429,6 @@ final class EntryUpdateRequestHandler implements RequestHandlerInterface
 
 ## Useful to know
 
-### OpenApi (Swagger)
-
-```bash
-composer require 'sunrise/http-router-openapi:^1.1'
-```
-
-#### Generation documentation for Swagger (OAS)
-
-```php
-use Sunrise\Http\Router\OpenApi\Object\Info;
-use Sunrise\Http\Router\OpenApi\OpenApi;
-
-$openApi = new OpenApi(new Info('0.0.1', 'API'));
-
-$openApi->addRoute(...$router->getRoutes());
-
-$openApi->toArray();
-```
-
-#### Validation a request body via Swagger documentation
-
-```php
-use Sunrise\Http\Router\OpenApi\Middleware\RequestBodyValidationMiddleware;
-
-$route->addMiddleware(new RequestBodyValidationMiddleware());
-```
-
-or using annotations:
-
-```php
-/**
- * @Route(
- *   name="foo",
- *   path="/foo",
- *   methods={"post"},
- *   middlewares={
- *     "Sunrise\Http\Router\OpenApi\Middleware\RequestBodyValidationMiddleware",
- *   },
- * )
- */
-```
-
 ### Generation a route URI
 
 ```php

composer.json

@@ -57,13 +57,13 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Sunrise\\Http\\Router\\Test\\Fixture\\": "tests/fixtures/"
+            "Sunrise\\Http\\Router\\Tests\\Fixtures\\": "tests/fixtures/"
         }
     },
     "scripts": {
         "test": [
             "phpcs",
-            "XDEBUG_MODE=coverage phpunit --colors=always --coverage-text"
+            "XDEBUG_MODE=coverage phpunit --coverage-text"
         ]
     }
 }

phpunit.xml.dist

@@ -6,7 +6,7 @@
         </include>
     </coverage>
     <testsuites>
-        <testsuite name="Sunrise HTTP Router Test Suite">
+        <testsuite name="sunrise.http.router.testSuite">
             <directory>./tests/</directory>
         </testsuite>
     </testsuites>

tests/Command/RouteListCommandTest.php

@@ -1,14 +1,14 @@
 <?php declare(strict_types=1);
 
-namespace Sunrise\Http\Router\Test\Command;
+namespace Sunrise\Http\Router\Tests\Command;
 
 /**
  * Import classes
  */
 use PHPUnit\Framework\TestCase;
 use Sunrise\Http\Router\Command\RouteListCommand;
 use Sunrise\Http\Router\Router;
-use Sunrise\Http\Router\Test\Fixture;
+use Sunrise\Http\Router\Tests\Fixtures;
 use Symfony\Component\Console\Tester\CommandTester;
 
 /**
@@ -23,9 +23,9 @@ class RouteListCommandTest extends TestCase
     public function testRun() : void
     {
         $routes = [
-            new Fixture\Route(),
-            new Fixture\Route(),
-            new Fixture\Route(),
+            new Fixtures\Route(),
+            new Fixtures\Route(),
+            new Fixtures\Route(),
         ];
 
         $router = new Router();

tests/Exception/BadRequestExceptionTest.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Sunrise\Http\Router\Test\Exception;
+namespace Sunrise\Http\Router\Tests\Exception;
 
 /**
  * Import classes

tests/Exception/ExceptionTest.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Sunrise\Http\Router\Test\Exception;
+namespace Sunrise\Http\Router\Tests\Exception;
 
 /**
  * Import classes

tests/Exception/InvalidArgumentExceptionTest.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Sunrise\Http\Router\Test\Exception;
+namespace Sunrise\Http\Router\Tests\Exception;
 
 /**
  * Import classes