Merge pull request #74 from sunrise-php/release/v2.9.0

v2.9.0

Author: fenric

.circleci/config.yml

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

.editorconfig

@@ -11,8 +11,5 @@ indent_size = 4
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.md]
-trim_trailing_whitespace = false
-
 [*.yml]
 indent_size = 2

README.md

@@ -12,7 +12,7 @@
 ## Installation
 
 ```bash
-composer require 'sunrise/http-router:^2.8'
+composer require 'sunrise/http-router:^2.9'
 ```
 
 ## QuickStart
@@ -103,6 +103,12 @@ $this->get('home', '/', new CallableRequestHandler(function ($request) {
 
 #### Strategy loading routes from descriptors (annotations or attributes)
 
+Install the [doctrine/annotations](https://github.com/doctrine/annotations) package if you will be use annotations:
+
+```bash
+composer require doctrine/annotations
+```
+
 ```php
 use Doctrine\Common\Annotations\AnnotationRegistry;
 use Sunrise\Http\Router\Loader\DescriptorDirectoryLoader;
@@ -199,6 +205,64 @@ $router->addMiddleware(new CallableMiddleware(function ($request, $handler) {
 emit($router->run(ServerRequestFactory::fromGlobals()));
 ```
 
+#### Work with PSR-11 container
+
+##### Collector
+
+```php
+$collector = new RouteCollector();
+
+/** @var \Psr\Container\ContainerInterface $container */
+
+// Pass DI container to the collector...
+$collector->setContainer($container);
+
+// Objects passed as strings will be initialized through the DI container...
+$route = $collector->get('home', '/', HomeController::class, [
+    FooMiddleware::class,
+    BarMiddleware::class,
+]);
+```
+
+##### Config loader
+
+```php
+$loader = new CollectableFileLoader();
+
+/** @var \Psr\Container\ContainerInterface $container */
+
+// Pass DI container to the loader...
+$loader->setContainer($container);
+
+// All found objects which has been passed as strings will be initialized through the DI container...
+$routes = $loader->load();
+```
+
+##### Descriptor loader
+
+```php
+$loader = new DescriptorDirectoryLoader();
+
+/** @var \Psr\Container\ContainerInterface $container */
+
+// Pass DI container to the loader...
+$loader->setContainer($container);
+
+// All found objects will be initialized through the DI container...
+$routes = $loader->load();
+```
+
+#### Descriptors cache (PSR-16)
+
+```php
+$loader = new DescriptorDirectoryLoader();
+
+/** @var \Psr\SimpleCache\CacheInterface $cache */
+
+// Pass a cache to the loader...
+$loader->setCache($cache);
+```
+
 #### Route Annotation Example
 
 ##### Minimal annotation view
@@ -239,6 +303,18 @@ final class EntryUpdateRequestHandler implements RequestHandlerInterface
 final class EntryUpdateRequestHandler implements RequestHandlerInterface
 ```
 
+##### One method only
+
+```php
+/**
+ * @Route(
+ *   name="home",
+ *   path="/",
+ *   method="GET",
+ * )
+ */
+```
+
 #### Route Attribute Example
 
 ##### Minimal attribute view
@@ -349,13 +425,13 @@ $collector->group(function ($collector) {
                 ->addMiddleware(...); // add the middleware(s) to the route...
         })
         ->addPrefix('/entry') // add the prefix to the group...
-        ->unshiftMiddleware(...); // add the middleware(s) to the group...
+        ->prependMiddleware(...); // add the middleware(s) to the group...
     })
     ->addPrefix('/v1') // add the prefix to the group...
-    ->unshiftMiddleware(...); // add the middleware(s) to the group...
+    ->prependMiddleware(...); // add the middleware(s) to the group...
 })
 ->addPrefix('/api') // add the prefix to the group...
-->unshiftMiddleware(...); // add the middleware(s) to the group...
+->prependMiddleware(...); // add the middleware(s) to the group...
 ```
 
 ### Route patterns
@@ -364,6 +440,22 @@ $collector->group(function ($collector) {
 $collector->get('api.entry.read', '/api/v1/entry/{id<\d+>}(/{optional<\w+>})');
 ```
 
+##### Global route patterns
+
+```php
+// @uuid pattern
+$collector->get('api.entry.read', '/api/v1/entry/{id<@uuid>}');
+
+// @slug pattern
+$collector->get('api.entry.read', '/api/v1/entry/{slug<@slug>}');
+
+// Custom patterns (available from version 2.9.0):
+\Sunrise\Http\Router\Route::$patterns['@id'] = '[1-9][0-9]*';
+
+// Just use the custom pattern...
+$collector->get('api.entry.read', '/api/v1/entry/{id<@id>}');
+```
+
 ### Hosts (available from version 2.6.0)
 
 > Note: if you don't assign a host for a route, it will be available on any hosts!
@@ -384,6 +476,14 @@ $collector->group(function ($collector) {
 ->setHost('admin.host');
 ```
 
+### CLI commands
+
+```php
+use Sunrise\Http\Router\Command\RouteListCommand;
+
+new RouteListCommand($router);
+```
+
 ---
 
 ## Test run

composer.json

@@ -16,7 +16,8 @@
         "php7",
         "php8",
         "attributes",
-        "php-attributes"
+        "php-attributes",
+        "swagger"
     ],
     "authors": [
         {
@@ -32,13 +33,14 @@
         "psr/http-server-handler": "^1.0",
         "psr/http-server-middleware": "^1.0",
         "psr/simple-cache": "^1.0",
-        "fig/http-message-util": "^1.1",
-        "doctrine/annotations": "^1.6"
+        "fig/http-message-util": "^1.1"
     },
     "require-dev": {
         "phpunit/phpunit": "7.5.20|9.5.0",
         "sunrise/coding-standard": "1.0.0",
-        "sunrise/http-factory": "1.1.0"
+        "sunrise/http-factory": "1.1.0",
+        "doctrine/annotations": "^1.6",
+        "symfony/console": "^4.4"
     },
     "autoload": {
         "files": [

functions/path_parse.php

@@ -52,16 +52,6 @@
     '_' => 1,
 ];
 
-/**
- * Named patters
- *
- * @var array
- */
-const NAMED_PATTERNS = [
-    '@slug' => '[\da-z-]+',
-    '@uuid' => '[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}',
-];
-
 /**
  * Parses the given path
  *
@@ -179,8 +169,8 @@ function path_parse(string $path) : array
                 );
             }
 
-            if (isset(NAMED_PATTERNS[$attributes[$attributeIndex]['pattern']])) {
-                $attributes[$attributeIndex]['pattern'] = NAMED_PATTERNS[$attributes[$attributeIndex]['pattern']];
+            if (isset(Route::$patterns[$attributes[$attributeIndex]['pattern']])) {
+                $attributes[$attributeIndex]['pattern'] = Route::$patterns[$attributes[$attributeIndex]['pattern']];
             }
 
             $cursorInPattern = false;