Merge pull request #80 from sunrise-php/release/v2.11.0

v2.11.0

Author: fenric

README.md

@@ -12,7 +12,7 @@
 ## Installation
 
 ```bash
-composer require 'sunrise/http-router:^2.10'
+composer require 'sunrise/http-router:^2.11'
 ```
 
 ## Support for OpenAPI (Swagger) Specification (optional)
@@ -208,6 +208,25 @@ $response = $router->handle($request);
 $response = $router->process($request, $handler);
 ```
 
+```php
+use Sunrise\Http\Router\Annotation as Mapping;
+
+#[Mapping\Prefix('/api/v1')]
+#[Mapping\Middleware(SomeMiddleware::class)]
+class SomeController {
+
+    #[Mapping\Route('foo', path: '/foo')]
+    public function foo() {
+        // will be available at: /api/v1/foo
+    }
+
+    #[Mapping\Route('bar', path: '/bar')]
+    public function bar() {
+        // will be available at: /api/v1/bar
+    }
+}
+```
+
 #### Without loading strategy
 
 ```php

composer.json

@@ -64,6 +64,10 @@
         "test": [
             "phpcs",
             "XDEBUG_MODE=coverage phpunit --coverage-text"
+        ],
+        "build": [
+            "phpdoc -d src/ -t phpdoc/",
+            "XDEBUG_MODE=coverage phpunit --coverage-html coverage/"
         ]
     }
 }

src/Annotation/Host.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types=1);
+
+/**
+ * It's free open-source software released under the MIT License.
+ *
+ * @author Anatoly Fenric <[email protected]>
+ * @copyright Copyright (c) 2018, Anatoly Fenric
+ * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE
+ * @link https://github.com/sunrise-php/http-router
+ */
+
+namespace Sunrise\Http\Router\Annotation;
+
+/**
+ * Import classes
+ */
+use Attribute;
+
+/**
+ * @Annotation
+ *
+ * @Target({"CLASS", "METHOD"})
+ *
+ * @NamedArgumentConstructor
+ *
+ * @Attributes({
+ *   @Attribute("value", type="string", required=true),
+ * })
+ *
+ * @since 2.11.0
+ */
+#[Attribute(Attribute::TARGET_CLASS|Attribute::TARGET_METHOD)]
+final class Host
+{
+
+    /**
+     * The attribute value
+     *
+     * @var string
+     */
+    public $value;
+
+    /**
+     * Constructor of the class
+     *
+     * @param string $value
+     */
+    public function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+}

src/Annotation/Middleware.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types=1);
+
+/**
+ * It's free open-source software released under the MIT License.
+ *
+ * @author Anatoly Fenric <[email protected]>
+ * @copyright Copyright (c) 2018, Anatoly Fenric
+ * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE
+ * @link https://github.com/sunrise-php/http-router
+ */
+
+namespace Sunrise\Http\Router\Annotation;
+
+/**
+ * Import classes
+ */
+use Attribute;
+
+/**
+ * @Annotation
+ *
+ * @Target({"CLASS", "METHOD"})
+ *
+ * @NamedArgumentConstructor
+ *
+ * @Attributes({
+ *   @Attribute("value", type="string", required=true),
+ * })
+ *
+ * @since 2.11.0
+ */
+#[Attribute(Attribute::TARGET_CLASS|Attribute::TARGET_METHOD|Attribute::IS_REPEATABLE)]
+final class Middleware
+{
+
+    /**
+     * The attribute value
+     *
+     * @var string
+     */
+    public $value;
+
+    /**
+     * Constructor of the class
+     *
+     * @param string $value
+     */
+    public function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+}

src/Annotation/Postfix.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types=1);
+
+/**
+ * It's free open-source software released under the MIT License.
+ *
+ * @author Anatoly Fenric <[email protected]>
+ * @copyright Copyright (c) 2018, Anatoly Fenric
+ * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE
+ * @link https://github.com/sunrise-php/http-router
+ */
+
+namespace Sunrise\Http\Router\Annotation;
+
+/**
+ * Import classes
+ */
+use Attribute;
+
+/**
+ * @Annotation
+ *
+ * @Target({"CLASS", "METHOD"})
+ *
+ * @NamedArgumentConstructor
+ *
+ * @Attributes({
+ *   @Attribute("value", type="string", required=true),
+ * })
+ *
+ * @since 2.11.0
+ */
+#[Attribute(Attribute::TARGET_CLASS|Attribute::TARGET_METHOD)]
+final class Postfix
+{
+
+    /**
+     * The attribute value
+     *
+     * @var string
+     */
+    public $value;
+
+    /**
+     * Constructor of the class
+     *
+     * @param string $value
+     */
+    public function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+}

src/Annotation/Prefix.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types=1);
+
+/**
+ * It's free open-source software released under the MIT License.
+ *
+ * @author Anatoly Fenric <[email protected]>
+ * @copyright Copyright (c) 2018, Anatoly Fenric
+ * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE
+ * @link https://github.com/sunrise-php/http-router
+ */
+
+namespace Sunrise\Http\Router\Annotation;
+
+/**
+ * Import classes
+ */
+use Attribute;
+
+/**
+ * @Annotation
+ *
+ * @Target({"CLASS", "METHOD"})
+ *
+ * @NamedArgumentConstructor
+ *
+ * @Attributes({
+ *   @Attribute("value", type="string", required=true),
+ * })
+ *
+ * @since 2.11.0
+ */
+#[Attribute(Attribute::TARGET_CLASS|Attribute::TARGET_METHOD)]
+final class Prefix
+{
+
+    /**
+     * The attribute value
+     *
+     * @var string
+     */
+    public $value;
+
+    /**
+     * Constructor of the class
+     *
+     * @param string $value
+     */
+    public function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+}

src/Annotation/Route.php

@@ -44,8 +44,6 @@ final class Route
     /**
      * The descriptor holder
      *
-     * Don't use the property outside of the package.
-     *
      * @var mixed
      *
      * @internal
@@ -154,6 +152,12 @@ public function __construct(
             $methods[] = $method;
         }
 
+        // if no methods are specified,
+        // such a route is a GET route.
+        if (empty($methods)) {
+            $methods[] = 'GET';
+        }
+
         $this->name = $name;
         $this->host = $host;
         $this->path = $path;

src/Command/RouteListCommand.php

@@ -14,6 +14,7 @@
 /**
  * Import classes
  */
+use RuntimeException;
 use Sunrise\Http\Router\Router;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\Table;
@@ -23,39 +24,79 @@
 /**
  * Import functions
  */
-use function Sunrise\Http\Router\path_plain;
 use function join;
+use function sprintf;
+use function Sunrise\Http\Router\path_plain;
 
 /**
- * RouteListCommand
+ * This command will list all routes in your application
+ *
+ * If you cannot pass the router to the constructor
+ * or your architecture has problems with autowiring,
+ * then just inherit this class and override the getRouter method.
  *
  * @since 2.9.0
  */
-final class RouteListCommand extends Command
+class RouteListCommand extends Command
 {
 
     /**
-     * @var Router
+     * {@inheritdoc}
      */
-    private $router;
+    protected static $defaultName = 'router:route-list';
 
     /**
      * {@inheritdoc}
+     */
+    protected static $defaultDescription = 'Lists all routes in your application';
+
+    /**
+     * The router instance populated with routes
      *
-     * @param Router $router
-     * @param string|null $name
+     * @var Router|null
      */
-    public function __construct(Router $router, ?string $name = null)
+    private $router;
+
+    /**
+     * Constructor of the class
+     *
+     * @param Router|null $router
+     */
+    public function __construct(?Router $router = null)
     {
+        parent::__construct();
+
         $this->router = $router;
+    }
+
+    /**
+     * Gets the router instance populated with routes
+     *
+     * @return Router
+     *
+     * @throws RuntimeException
+     *         If the command doesn't contain the router instance.
+     *
+     * @since 2.11.0
+     */
+    protected function getRouter() : Router
+    {
+        if (null === $this->router) {
+            throw new RuntimeException(sprintf(
+                'The %2$s() method MUST return the %1$s class instance. ' .
+                'Pass the %1$s class instance to the constructor, or override the %2$s() method.',
+                Router::class,
+                __METHOD__
+            ));
+        }
 
-        parent::__construct($name ?? 'router:route-list');
+        return $this->router;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function execute(InputInterface $input, OutputInterface $output) : int
+    final protected function execute(InputInterface $input, OutputInterface $output) : int
     {
         $table = new Table($output);
 
@@ -66,7 +107,7 @@ public function execute(InputInterface $input, OutputInterface $output) : int
             'Verb',
         ]);
 
-        foreach ($this->router->getRoutes() as $route) {
+        foreach ($this->getRouter()->getRoutes() as $route) {
             $table->addRow([
                 $route->getName(),
                 $route->getHost() ?? 'ANY',