Merge pull request #58 from settermjd/refine-routes-list-functionality

Refine routes list functionality

Author: gsteel

README.md

@@ -61,11 +61,24 @@ The command supports several options, listed in the table below.
 | `--format`          | `-f`          | Set the format of the command's output. The supported values are `table`, which is the default, and `json`. If you set the format to json, then we recommend using [jq](https://stedolan.github.io/jq/manual/) to query/filter the command's output.                                                                             |
 | `--sort`            | `-s`          | Sort the command's output. The supported values are `name` and `path`.                                                                                                                                                                                                                                                           |
 | `--supports-method` | `-m`          | Accepts a comma-separated list of one or more HTTP methods, and filters out routes which don't support those methods.                                                                                                                                                                                                            |
-| `--has-path`        | `-p`          | Accepts a comma-separated list of one or more paths, and filters out routes with paths that don't match. The paths can be a regular expression, supported by the `preg_*` functions. For example, "/,/api/ping,*/ping".                                                                                                            |
-| `--has-name`        | `-n`          | Accepts a comma-separated list of one or more names, and filters out routes with names that don't match. The names can be fixed strings, or regular expressions supported by the `preg_*` functions. For example, "user,user.register,*.register,user*".                                                                           |
+| `--has-path`        | `-p`          | Accepts a comma-separated list of one or more paths, and filters out routes with paths that don't match. The paths can be a regular expression, supported by the `preg_*` functions. For example, "/,/api/ping,*/ping".                                                                                                          |
+| `--has-name`        | `-n`          | Accepts a comma-separated list of one or more names, and filters out routes with names that don't match. The names can be fixed strings, or regular expressions supported by the `preg_*` functions. For example, "user,user.register,*.register,user*".                                                                         |
 | `--has-middleware`  | `-w`          | Accepts a comma-separated list of one or more middleware classes, and filters out routes that do not require those classes. The classes can be fully-qualified, unqualified, or a regular expression, supported by the preg_* functions. For example, "\Mezzio\Middleware\LazyLoadingMiddleware,LazyLoadingMiddleware,\Mezzio*". |
 <!-- markdownlint-enable MD037 -->
 
+##### Configuration
+
+By default, `Mezzio\Tooling\Routes\DefaultRoutesConfigLoaderFactory` registers a `ConfigLoaderInterface` service with the application's DI container, which retrieves the application's routes from two sources:
+
+- `config/routes.php`
+- Routes registered by any loaded `ConfigProvider` class
+
+However, this is a default/fallback implementation.
+If you don't store any routes in `config/routes.php` or need a custom implementation, then you need to do two things:
+
+1. Write a custom loader implementation that implements `Mezzio\Tooling\Routes\ConfigLoaderInterface`
+2. Register it with the application's DI container as an alias for `Mezzio\Tooling\Routes\ConfigLoaderInterface`
+
 ##### Usage Example
 
 Here is an example of what you can expect from running the command.

phpunit.xml.dist

@@ -7,7 +7,20 @@
     beStrictAboutOutputDuringTests="true"
     colors="true"
     cacheDirectory=".phpunit.cache"
-    beStrictAboutCoverageMetadata="true">
+    beStrictAboutCoverageMetadata="true"
+    displayDetailsOnPhpunitDeprecations="true"
+    displayDetailsOnTestsThatTriggerDeprecations="true"
+    displayDetailsOnTestsThatTriggerErrors="true"
+    displayDetailsOnTestsThatTriggerNotices="true"
+    displayDetailsOnTestsThatTriggerWarnings="true"
+    displayDetailsOnSkippedTests="true"
+    displayDetailsOnIncompleteTests="true"
+    failOnPhpunitDeprecation="true"
+    failOnEmptyTestSuite="true"
+    failOnWarning="true"
+    failOnNotice="true"
+    failOnDeprecation="true"
+>
     <testsuites>
         <testsuite name="mezzio-tooling">
             <directory>./test</directory>

src/ConfigProvider.php

@@ -25,6 +25,8 @@
 use Mezzio\Tooling\Module\DeregisterCommandFactory;
 use Mezzio\Tooling\Module\RegisterCommand;
 use Mezzio\Tooling\Module\RegisterCommandFactory;
+use Mezzio\Tooling\Routes\ConfigLoaderInterface;
+use Mezzio\Tooling\Routes\DefaultRoutesConfigLoaderFactory;
 use Mezzio\Tooling\Routes\ListRoutesCommand;
 use Mezzio\Tooling\Routes\ListRoutesCommandFactory;
 
@@ -66,6 +68,7 @@ public function getDependencies(): array
     {
         return [
             'factories' => [
+                ConfigLoaderInterface::class                    => DefaultRoutesConfigLoaderFactory::class,
                 Create::class                                   => CreateFactory::class,
                 CreateActionCommand::class                      => CreateActionCommandFactory::class,
                 CreateCommand::class                            => CreateCommandFactory::class,

src/Routes/DefaultRoutesConfigLoaderFactory.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mezzio\Tooling\Routes;
+
+use Mezzio\Application;
+use Mezzio\MiddlewareFactory;
+use Psr\Container\ContainerInterface;
+
+/**
+ * This class provides a default factory implementation for retrieving an app's routes
+
+ * The assumption with this "default" config loader factory is that you're
+ * loading routes from config/routes.php in your Mezzio application. So, if
+ * that's not the case in your application, create a custom loader
+ * implementation and override the alias in the DiC.
+ */
+final class DefaultRoutesConfigLoaderFactory
+{
+    public function __invoke(ContainerInterface $container): ConfigLoaderInterface
+    {
+        /** @var Application $application */
+        $application = $container->get(Application::class);
+
+        /** @var MiddlewareFactory $factory */
+        $factory = $container->get(MiddlewareFactory::class);
+
+        return new RoutesFileConfigLoader(
+            'config/routes.php',
+            $application,
+            $factory,
+            $container
+        );
+    }
+}

src/Routes/Filter/RouteFilterOptions.php

@@ -4,85 +4,30 @@
 
 namespace Mezzio\Tooling\Routes\Filter;
 
-use function get_object_vars;
-use function in_array;
-use function is_array;
-use function is_string;
+use function array_map;
+use function strtoupper;
 
+/** @internal */
 final class RouteFilterOptions
 {
-    private string $middleware;
-    private string $name;
-    private string $path;
-
-    /** @var array<array-key,string> */
-    private array $methods = [];
+    /** @var list<non-empty-string> */
+    public readonly array $methods;
 
     /**
-     * @param string|array<array-key,string> $methods
+     * @param non-empty-string|null $middleware
+     * @param non-empty-string|null $name
+     * @param non-empty-string|null $path
+     * @param list<non-empty-string> $methods
      */
     public function __construct(
-        string $middleware = '',
-        string $name = '',
-        string $path = '',
-        $methods = []
+        public readonly string|null $middleware,
+        public readonly string|null $name,
+        public readonly string|null $path,
+        array $methods
     ) {
-        if (is_string($methods)) {
-            $this->methods = [$methods];
-        }
-        if (is_array($methods)) {
-            $this->methods = $methods;
-        }
-        $this->middleware = $middleware;
-        $this->name       = $name;
-        $this->path       = $path;
-    }
-
-    public function has(string $filterOption): bool
-    {
-        if (in_array($filterOption, ['middleware', 'name', 'path'])) {
-            return $this->$filterOption !== null;
-        }
-
-        if ($filterOption === 'methods') {
-            return [] !== $this->methods;
-        }
-
-        return false;
-    }
-
-    public function getMiddleware(): string
-    {
-        return $this->middleware;
-    }
-
-    public function getName(): string
-    {
-        return $this->name;
-    }
-
-    public function getPath(): string
-    {
-        return $this->path;
-    }
-
-    /**
-     * @return array<array-key,string>
-     */
-    public function getMethods(): array
-    {
-        return $this->methods;
-    }
-
-    public function toArray(): array
-    {
-        $values = [];
-        foreach (get_object_vars($this) as $key => $value) {
-            if (! empty($value)) {
-                $values[$key] = $value;
-            }
-        }
-
-        return $values;
+        /** Psalm does not like a first-class callable here */
+        $this->methods = array_map(static function (string $method): string {
+            return strtoupper($method);
+        }, $methods);
     }
 }