wip

- Added the ability to disable route discovery at controller level

Author: johntrickett86

src/Concerns/DisableRouteDiscovery.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Orion\Concerns;
+
+trait DisableRouteDiscovery
+{
+    /**
+     * @var bool $routeDiscoveryDisabled
+     */
+    protected $routeDiscoveryDisabled = true;
+}

src/Concerns/HandlesRouteDiscovery.php

@@ -27,6 +27,16 @@ trait HandlesRouteDiscovery
     protected static $routeMiddleware = [];
     protected static $withoutRouteMiddleware = [];
 
+    /**
+     * Determine whether route auto discovery is enabled.
+     *
+     * @return bool
+     */
+    public function routeDiscoveryEnabled(): bool
+    {
+        return !property_exists($this, 'routeDiscoveryDisabled');
+    }
+
     public static function registerRoutes(): void
     {
         if (static::isRelationController()) {
@@ -59,7 +69,7 @@ protected static function registerRelationRoutes(): void
         $controller = static::class;
         $instance = app($controller);
 
-        $model = isset($instance->model) ? $instance->model : null;
+        $model = $instance->model ?? null;
         $relation = isset($instance->relation) ? $instance->relation : null;
         $type = isset($instance->resourceType) ? $instance->resourceType : static::detectRelationType($model, $relation);
 
@@ -74,7 +84,6 @@ protected static function registerRelationRoutes(): void
             ->prefix(static::getRoutePrefix())
             ->name(static::getRouteNamePrefix() . '.')
             ->group(function () use ($type, $parentSlug, $relation, $controller, $instance) {
-                $route = null;
 
                 switch ($type) {
                     case 'hasOne':

src/Http/Controllers/BaseController.php

@@ -15,6 +15,7 @@
 use Illuminate\Support\Facades\Auth;
 use Orion\Concerns\BuildsResponses;
 use Orion\Concerns\HandlesAuthorization;
+use Orion\Concerns\HandlesRouteDiscovery;
 use Orion\Concerns\HandlesTransactions;
 use Orion\Concerns\InteractsWithBatchResources;
 use Orion\Concerns\InteractsWithHooks;
@@ -39,6 +40,7 @@ abstract class BaseController extends \Illuminate\Routing\Controller
         InteractsWithSoftDeletes,
         InteractsWithBatchResources,
         BuildsResponses,
+        HandlesRouteDiscovery,
         HandlesTransactions;
 
     /**

src/OrionServiceProvider.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\ServiceProvider;
+use Illuminate\Support\Str;
 use Orion\Commands\BuildSpecsCommand;
 use Orion\Contracts\ComponentsResolver;
 use Orion\Contracts\KeyResolver;
@@ -12,6 +13,8 @@
 use Orion\Contracts\QueryBuilder;
 use Orion\Contracts\RelationsResolver;
 use Orion\Contracts\SearchBuilder;
+use Orion\Http\Controllers\Controller;
+use Orion\Http\Controllers\RelationController;
 use Orion\Http\Middleware\EnforceExpectsJson;
 use Orion\Specs\ResourcesCacheStore;
 
@@ -70,28 +73,46 @@ public function boot()
     protected function discoverAndRegisterControllers(): void
     {
         $paths = config('orion.route_discovery.paths', []);
-        $baseNamespace = trim(config('orion.namespaces.controllers', 'App\\Http\\Controllers\\'), '\\');
 
         foreach ($paths as $path) {
             if (! is_dir($path)) {
                 continue;
             }
 
-            foreach (File::allFiles($path) as $file) {
-                $relativePath = str($file->getRelativePathname())
-                    ->replace(DIRECTORY_SEPARATOR, '\\')
-                    ->replace('.php', '')
-                    ->value();
+            $namespace = $this->pathToNamespace($path);
 
-                $class = "$baseNamespace\\$relativePath";
+            foreach (File::allFiles($path) as $file) {
+                $class = $namespace . '\\' . str_replace(
+                        ['/', '.php'],
+                        ['\\', ''],
+                        $file->getRelativePathname()
+                    );
 
                 if (
                     class_exists($class) &&
-                    method_exists($class, 'registerRoutes')
+                    (
+                        is_subclass_of($class, Controller::class) ||
+                        is_subclass_of($class, RelationController::class)
+                    )
                 ) {
+                    $instance = app($class);
+
+                    if (method_exists($instance, 'routeDiscoveryEnabled') && !$instance->routeDiscoveryEnabled()) {
+                        continue;
+                    }
+
                     $class::registerRoutes();
                 }
             }
         }
     }
+
+    protected function pathToNamespace(string $path): string
+    {
+        return Str::of($path)
+            ->after(base_path('app'))
+            ->replace('/', '\\')
+            ->prepend('App')
+            ->__toString();
+    }
 }