✨ Next.js like route loading

thanks @tobimori for the idea and code

Signed-off-by: bnomei <[email protected]>

Author: bnomei

README.md

@@ -15,7 +15,7 @@ Helper to automatically load various Kirby extensions in a plugin
 > If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?<br><br>
 > Be kind. Share a little. Thanks.<br><br>
 > &dash; Bruno<br>
-> &nbsp; 
+> &nbsp;
 
 | M | O | N | E | Y |
 |---|----|---|---|---|
@@ -46,14 +46,18 @@ The following extensions can be autoloaded:
 - [x] controllers (php)
 - [x] blockModels (php)
 - [x] pageModels (php)
+- [x] routes (php)
+- [x] api/routes (php)
 - [x] userModels (php)
 - [x] snippets (php)
 - [x] templates (php)
 - [X] translations (php or yml or json)
 
-> NOTE: Loading translations from yaml or json files is added by this package and not originally part of kirby core.
+#### Notes
 
-> NOTE: The `classes` autoloader is very basic. Using a custom array with kirby's `load()`-helper or composers psr-4 autoloading is recommended.
+- Loading translations from yaml or json files is added by this package and not originally part of kirby core.
+- The `classes` autoloader is very basic. Using a custom array with kirby's `load()`-helper or composers psr-4 autoloading is recommended.
+- The `routes` and `apiRoutes` autoloader is based on code from @tobimori and needs a file structure similar to Next.js [see examples](https://github.com/bnomei/autoloader-for-kirby/blob/main/tests/site/plugins/routastic).
 
 ## Usage
 
@@ -63,6 +67,25 @@ After requiring it as a dependency in either your project or plugin `composer.js
 ```php
 <?php
 
+// only autoloader
+Kirby::plugin('bnomei/example', autoloader(__DIR__)->toArray());
+```
+
+```php
+<?php
+
+// merge autoloader with custom config
+Kirby::plugin('bnomei/example', autoloader(__DIR__)->toArray([
+    'options' => [
+        // options
+    ],
+    // other extensions
+]));
+```
+
+```php
+<?php
+
 // optionally change some settings
 /*
 autoloader(__DIR__, [
@@ -76,6 +99,7 @@ autoloader(__DIR__)->classes();
 // use a different folder
 // autoloader(__DIR__)->classes('src');
 
+// set each option explicitly without merging
 Kirby::plugin('bnomei/example', [
     'options' => [
         // options
@@ -85,6 +109,7 @@ Kirby::plugin('bnomei/example', [
     'controllers' => autoloader(__DIR__)->controllers(),
     'blockModels' => autoloader(__DIR__)->blockModels(),
     'pageModels' => autoloader(__DIR__)->pageModels(),
+    'routes' => autoloader(__DIR__)->routes(),
     'userModels' => autoloader(__DIR__)->userModels(),
     'snippets' => autoloader(__DIR__)->snippets(),
     'templates' => autoloader(__DIR__)->templates(),

classes/Autoloader.php

@@ -80,6 +80,20 @@ public function __construct(array $options = [])
                 'lowercase' => true,
                 'map' => [],
             ],
+            'routes' => [
+                'folder' => 'routes',
+                'name' => static::ANY_PHP,
+                'key' => 'route',
+                'require' => true,
+                'lowercase' => false,
+            ],
+            'apiroutes' => [
+                'folder' => 'api/routes',
+                'name' => static::ANY_PHP,
+                'key' => 'route',
+                'require' => true,
+                'lowercase' => false,
+            ],
             'usermodels' => [
                 'folder' => 'models',
                 'name' => static::USER_PHP,
@@ -146,7 +160,7 @@ private function registry(string $type): array
             $class = '';
             $split = explode('.', $file->getPathname());
             $extension = array_pop($split);
-            if ($options['key'] === 'relativepath') {
+            if ($options['key'] === 'relativepath' || $options['key'] === 'route') {
                 $key = $file->getRelativePathname();
                 $key = str_replace('.' . $extension, '', $key);
                 $key = str_replace('\\', '/', $key); // windows
@@ -190,6 +204,24 @@ private function registry(string $type): array
 
             if ($options['key'] === 'classname') {
                 $this->registry[$type][$key] = $class;
+            } elseif ($options['key'] === 'route') {
+                // Author: @tobimori
+                $pattern = strtolower($file->getRelativePathname());
+                $pattern = preg_replace('~(.*)' . preg_quote('.php', '~') . '~', '$1' . '', $pattern, 1); // replace extension at end
+                $pattern = preg_replace('~(.*)' . preg_quote('index', '~') . '~', '$1' . '', $pattern, 1); // replace index at end, for root of folder, but not in paths etc.
+
+                $route = require $file->getRealPath();
+
+                // check if return is actually an array (if additional stuff is specified, e.g. method or language) or returns a function
+                if (is_array($route) || $route instanceof \Closure) {
+                    $this->registry[$type][] = array_merge(
+                        [
+                            'pattern' => /*'/' . */ $pattern,
+                            'action' => $route instanceof \Closure ? $route : null
+                        ],
+                        is_array($route) ? $route : []
+                    );
+                }
             } elseif ($options['require'] && $extension && strtolower($extension) === 'php') {
                 $path = $file->getPathname();
                 $this->registry[$type][$key] = require_once $path;
@@ -261,6 +293,16 @@ public function pageModels(): array
         return $this->registry('pagemodels');
     }
 
+    public function routes(): array
+    {
+        return $this->registry('routes');
+    }
+
+    public function apiRoutes(): array
+    {
+        return $this->registry('apiroutes');
+    }
+
     public function userModels(): array
     {
         return $this->registry('usermodels');
@@ -281,6 +323,26 @@ public function translations(): array
         return $this->registry('translations');
     }
 
+    public function toArray(array $merge = []): array
+    {
+        $this->classes();
+
+        return array_merge_recursive([
+            'blueprints' => $this->blueprints(),
+            'collections' => $this->collections(),
+            'controllers' => $this->controllers(),
+            'blockModels' => $this->blockModels(),
+            'pageModels' => $this->pageModels(),
+            'userModels' => $this->userModels(),
+            'snippets' => $this->snippets(),
+            'templates' => $this->templates(),
+            'translations' => $this->translations(),
+
+            'api' => ['routes' => $this->routes('api')],
+            'routes' => $this->routes(),
+        ], $merge);
+    }
+
     public static function singleton(array $options = []): self
     {
         if (self::$singleton && self::$singleton->dir() === $options['dir']) {

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "bnomei/autoloader-for-kirby",
     "type": "project",
-    "version": "1.5.0",
+    "version": "1.6.0",
     "license": "MIT",
     "description": "Helper to automatically load various Kirby extensions in a plugin",
     "authors": [
@@ -25,7 +25,12 @@
         "controllers",
         "snippets",
         "templates",
-        "routes"
+        "routes",
+        "languages",
+        "translations",
+        "blockmodels",
+        "pagemodels",
+        "usermodels"
     ],
     "autoload": {
         "psr-4": {
@@ -43,7 +48,7 @@
         }
     },
     "require": {
-        "php": ">=7.3.0",
+        "php": ">=7.4.0",
         "mustangostang/spyc": "^0.6.3",
         "symfony/finder": "^5.4"
     },

composer.lock

@@ -16,6 +16,7 @@ public function setUp(): void
     {
         $this->dir = __DIR__ . '/site/plugins/example';
         $this->dir2 = __DIR__ . '/site/plugins/another';
+        $this->dir3 = __DIR__ . '/site/plugins/routastic';
     }
 
     public function testSingleton()
@@ -134,6 +135,26 @@ public function testUserModels()
         $this->assertTrue(class_exists('EditorUser'));
     }
 
+    public function testRoutes()
+    {
+        $autoloader = autoloader($this->dir3);
+        $routes = $autoloader->routes();
+
+        $this->assertIsArray($routes);
+        $this->assertCount(3, $routes);
+        $this->assertEquals('routastic/(:any)/register', $routes[0]['pattern']);
+        $this->assertEquals('register', $routes[0]['action']());
+        $this->assertEquals('routastic/(:any)/unregister', $routes[1]['pattern']);
+        $this->assertEquals('unregister', $routes[1]['action']());
+        $this->assertEquals('routastic', $routes[2]['pattern']);
+        $this->assertEquals('index', $routes[2]['action']());
+
+        $apiRoutes = $autoloader->apiRoutes();
+        $this->assertCount(1, $apiRoutes);
+        $this->assertEquals('routastic/(:any)', $apiRoutes[0]['pattern']);
+        $this->assertEquals('api.index.hello', $apiRoutes[0]['action']('hello'));
+    }
+
     public function testSnippets()
     {
         $autoloader = autoloader($this->dir);

tests/AutoloaderTest.php

@@ -0,0 +1,8 @@
+<?php
+
+return [
+    'pattern' => 'routastic/(:any)',
+    'action' => function (string $any) {
+        return 'api.index.' . $any;
+    }
+];

tests/site/plugins/routastic/api/routes/index.php

@@ -0,0 +1,21 @@
+<?php
+
+// The following line is just necessary in this test setup.
+// the classes and helpers will be available from composer autoload in a production setup.
+@include_once __DIR__ . '/../../../vendor/autoload.php';
+
+use Kirby\Cms\App as Kirby;
+
+Kirby::plugin('bnomei/routastic', autoloader(__DIR__)->toArray([
+    'options' => [
+        'merged' => true,
+    ],
+    'routes' => [
+        [
+            'pattern' => 'merged',
+            'action' => function () {
+                return [];
+            },
+        ],
+    ],
+]));

tests/site/plugins/routastic/index.php

@@ -0,0 +1,5 @@
+<?php
+
+return function () {
+    return 'register';
+};

tests/site/plugins/routastic/routes/routastic/(:any)/register.php

@@ -0,0 +1,5 @@
+<?php
+
+return function () {
+    return 'unregister';
+};

tests/site/plugins/routastic/routes/routastic/(:any)/unregister.php

@@ -0,0 +1,8 @@
+<?php
+
+return [
+    'pattern' => 'routastic',
+    'action' => function () {
+        return 'index';
+    }
+];