Route interfaces refactoring + fix psalm errors (#112)

composer.json

@@ -29,12 +29,12 @@
     },
     "require-dev": {
         "nyholm/psr7": "^1.3",
-        "phpunit/phpunit": "^9.4",
+        "phpunit/phpunit": "^9.5",
         "psr/event-dispatcher": "^1.0",
-        "roave/infection-static-analysis-plugin": "^1.5",
+        "roave/infection-static-analysis-plugin": "^1.8",
         "spatie/phpunit-watcher": "^1.23",
-        "vimeo/psalm": "^4.2",
-        "yiisoft/router-fastroute": "^3.0@dev"
+        "vimeo/psalm": "^4.8",
+        "yiisoft/dummy-provider": "^1.0.0"
     },
     "autoload": {
         "psr-4": {

psalm.xml

@@ -1,15 +1,11 @@
 <?xml version="1.0"?>
 <psalm
     errorLevel="5"
-    resolveFromConfigFile="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
 >
     <projectFiles>
         <directory name="src" />
-        <ignoreFiles>
-            <directory name="vendor" />
-        </ignoreFiles>
     </projectFiles>
 </psalm>

src/Group.php

@@ -16,7 +16,7 @@
 final class Group implements RouteCollectorInterface
 {
     /**
-     * @var Group[]|RouteParametersInterface[]
+     * @var Group[]|Route[]
      */
     protected array $items = [];
     protected ?string $prefix;
@@ -56,7 +56,7 @@ public function routes(...$routes): self
         } elseif (is_array($routes)) {
             $callback = static function (self $group) use (&$routes) {
                 foreach ($routes as $route) {
-                    if ($route instanceof RouteInterface) {
+                    if ($route instanceof Route) {
                         $group->addRoute($route);
                     } elseif ($route instanceof self) {
                         $group->addGroup($route);
@@ -97,7 +97,7 @@ public function hasDispatcher(): bool
         return $this->dispatcher !== null;
     }
 
-    public function addRoute(RouteInterface $route): self
+    public function addRoute(Route $route): self
     {
         if (!$route->hasDispatcher() && $this->hasDispatcher()) {
             $route->injectDispatcher($this->dispatcher);
@@ -166,7 +166,7 @@ public function disableMiddleware($middlewareDefinition): self
     }
 
     /**
-     * @return Group[]|RouteParametersInterface[]
+     * @return Group[]|Route[]
      */
     public function getItems(): array
     {

src/MatchingResult.php

@@ -14,7 +14,7 @@
 final class MatchingResult implements MiddlewareInterface
 {
     private bool $success;
-    private RouteParametersInterface $route;
+    private Route $route;
     private array $parameters = [];
     private array $methods = [];
     private ?MiddlewareDispatcher $dispatcher = null;
@@ -30,7 +30,7 @@ public function withDispatcher(MiddlewareDispatcher $dispatcher): self
         return $new;
     }
 
-    public static function fromSuccess(RouteParametersInterface $route, array $parameters): self
+    public static function fromSuccess(Route $route, array $parameters): self
     {
         $new = new self();
         $new->success = true;

src/Route.php

@@ -35,6 +35,9 @@ public function injectDispatcher(MiddlewareDispatcher $dispatcher): void
         $this->dispatcher = $dispatcher;
     }
 
+    /**
+     * @return self
+     */
     public function withDispatcher(MiddlewareDispatcher $dispatcher): RouteInterface
     {
         $route = clone $this;
@@ -158,41 +161,59 @@ public static function methods(
         return $route;
     }
 
+    /**
+     * @return self
+     */
     public function name(string $name): RouteInterface
     {
         $route = clone $this;
         $route->name = $name;
         return $route;
     }
 
+    /**
+     * @return self
+     */
     public function pattern(string $pattern): RouteInterface
     {
         $new = clone $this;
         $new->pattern = $pattern;
         return $new;
     }
 
+    /**
+     * @return self
+     */
     public function host(string $host): RouteInterface
     {
         $route = clone $this;
         $route->host = rtrim($host, '/');
         return $route;
     }
 
+    /**
+     * @return self
+     */
     public function override(): RouteInterface
     {
         $route = clone $this;
         $route->override = true;
         return $route;
     }
 
+    /**
+     * @return self
+     */
     public function defaults(array $defaults): RouteInterface
     {
         $route = clone $this;
         $route->defaults = $defaults;
         return $route;
     }
 
+    /**
+     * @return self
+     */
     public function middleware($middlewareDefinition): RouteInterface
     {
         if ($this->actionAdded) {
@@ -203,6 +224,9 @@ public function middleware($middlewareDefinition): RouteInterface
         return $route;
     }
 
+    /**
+     * @return self
+     */
     public function prependMiddleware($middlewareDefinition): RouteInterface
     {
         if (!$this->actionAdded) {
@@ -213,6 +237,9 @@ public function prependMiddleware($middlewareDefinition): RouteInterface
         return $route;
     }
 
+    /**
+     * @return self
+     */
     public function action($middlewareDefinition): RouteInterface
     {
         $route = clone $this;
@@ -221,6 +248,9 @@ public function action($middlewareDefinition): RouteInterface
         return $route;
     }
 
+    /**
+     * @return self
+     */
     public function disableMiddleware($middlewareDefinition): RouteInterface
     {
         $route = clone $this;

src/RouteCollection.php

@@ -15,7 +15,7 @@ final class RouteCollection implements RouteCollectionInterface
     /**
      * All attached routes as Route instances
      *
-     * @var RouteParametersInterface[]
+     * @var Route[]
      */
     private array $routes = [];
 
@@ -25,7 +25,7 @@ public function __construct(RouteCollectorInterface $collector)
     }
 
     /**
-     * @return RouteParametersInterface[]
+     * @return Route[]
      */
     public function getRoutes(): array
     {
@@ -36,9 +36,9 @@ public function getRoutes(): array
     /**
      * @param string $name
      *
-     * @return RouteParametersInterface
+     * @return Route
      */
-    public function getRoute(string $name): RouteParametersInterface
+    public function getRoute(string $name): Route
     {
         $this->ensureItemsInjected();
         if (!array_key_exists($name, $this->routes)) {
@@ -71,7 +71,7 @@ private function ensureItemsInjected(): void
     /**
      * Build routes array
      *
-     * @param Group[]|RouteCollectorInterface[]|RouteParametersInterface[] $items
+     * @param Group[]|Route[]|RouteCollectorInterface[] $items
      */
     private function injectItems(array $items): void
     {
@@ -83,7 +83,7 @@ private function injectItems(array $items): void
     /**
      * Add an item into routes array
      *
-     * @param Group|RouteParametersInterface $route
+     * @param Group|Route $route
      */
     private function injectItem($route): void
     {
@@ -106,7 +106,6 @@ private function injectItem($route): void
     private function injectGroup(Group $group, array &$tree, string $prefix = ''): void
     {
         $prefix .= $group->getPrefix();
-        /** @var $items Group[]|Route[] */
         $items = $group->getItems();
         foreach ($items as $item) {
             if ($item instanceof Group || $item->hasMiddlewares()) {

src/RouteCollectionInterface.php

@@ -7,16 +7,16 @@
 interface RouteCollectionInterface
 {
     /**
-     * @return RouteParametersInterface[]
+     * @return Route[]
      */
     public function getRoutes(): array;
 
     /**
      * @param string $name
      *
-     * @return RouteParametersInterface
+     * @return Route
      */
-    public function getRoute(string $name): RouteParametersInterface;
+    public function getRoute(string $name): Route;
 
     /**
      * Returns routes tree array

src/RouteCollectorInterface.php

@@ -9,11 +9,11 @@ interface RouteCollectorInterface
     /**
      * Add a route
      *
-     * @param RouteInterface $route
+     * @param Route $route
      *
      * @return self
      */
-    public function addRoute(RouteInterface $route): self;
+    public function addRoute(Route $route): self;
 
     /**
      * Add a group of routes
@@ -35,7 +35,7 @@ public function addRoute(RouteInterface $route): self;
     public function addGroup(Group $group): self;
 
     /**
-     * @return Group[]|RouteParametersInterface[]
+     * @return Group[]|Route[]
      */
     public function getItems(): array;
 

src/RouteParametersInterface.php

@@ -21,4 +21,6 @@ public function getHost(): ?string;
     public function isOverride(): bool;
 
     public function getDefaults(): array;
+
+    public function __toString(): string;
 }