Custom namespace support (#549)

* Add support to use restify in different directory and namespace

* Make sure we can resolve repositories from any path

* allow dev branches

* revert config changes

* repositoriesFrom now supports passing namespace

* Register in default app now requires to pass default namespace

* Trait which is used to load repositories from any service provider

* Remove unused RestifyApi

* Setup fixtures + test namespaces

* Data provider trait to use with testing fixtures

* Unit test to resolve repositories from namespace

* Tests all repositories are loaded from service provider with valid json

* Document repository registration

Author: adam-code-labx

composer.json

@@ -49,7 +49,9 @@
     "autoload-dev": {
         "psr-4": {
             "Binaryk\\LaravelRestify\\Tests\\": "tests",
-            "Binaryk\\LaravelRestify\\Tests\\Database\\Factories\\": "tests/database/factories"
+            "Binaryk\\LaravelRestify\\Tests\\Database\\Factories\\": "tests/database/factories",
+            "App\\": "tests/Fixtures/App",
+            "CustomNamespace\\": "tests/Fixtures/CustomNamespace"
         }
     },
     "scripts": {
@@ -72,5 +74,6 @@
                 "Restify": "Binaryk\\LaravelRestify\\RestifyFacade"
             }
         }
-    }
+    },
+    "minimum-stability": "dev"
 }

config/restify.php

@@ -135,6 +135,7 @@
     ],
 
     'repositories' => [
+
         /*
         | Specify either to serialize index meta (policy) information or not. For performance reasons we recommend disabling it.
         */

docs-v2/content/en/api/repositories-advanced.md

@@ -146,6 +146,33 @@ public static function collectMiddlewares(RestifyRequest $request): ?Collection
 }
 ```
 
+## Repository registration
+
+Laravel Restify registers all repositories automatically in the App namespace. However, you can register your own repositories from any service provider using the InteractsWithRestifyRepositories trait. Here's an example:
+
+```php
+<?php
+
+namespace MyPackage\Cart;
+
+use Binaryk\LaravelRestify\Traits\InteractsWithRestifyRepositories;
+use Illuminate\Support\ServiceProvider;
+
+class MyPackageCart extends ServiceProvider
+{
+    use InteractsWithRestifyRepositories;
+
+    public function register(): void
+    {
+        $this->loadRestifyFrom(__DIR__.'/Restify', __NAMESPACE__.'\\Restify\\');
+        
+        // The rest of your package's registration code goes here.
+    }
+}
+```
+
+If you want to load Restify from your own service provider, you must use the InteractsWithRestifyRepositories trait in the service provider class. The loadRestifyFrom method takes the path to the directory containing the repositories and the namespace under which the repositories will be registered.
+
 ## Dependency injection
 
 The Laravel [service container](https://laravel.com/docs/7.x/container) is used to resolve all the Laravel Restify

src/Restify.php

@@ -136,15 +136,13 @@ public static function repositories(array $repositories)
     }
 
     /**
-     * Register all of the repository classes in the given directory.
-     *
+     * Register all repository classes in the given directory and namespace.
      *
      * @throws ReflectionException
      */
-    public static function repositoriesFrom(string $directory): void
+    public static function repositoriesFrom(string $directory, string $namespace): void
     {
-        $namespace = app()->getNamespace();
-
+        $basePath = $namespace === 'App\\' ? app_path() : $directory;
         $repositories = [];
 
         if (! is_dir($directory)) {
@@ -155,7 +153,7 @@ public static function repositoriesFrom(string $directory): void
             $repository = $namespace.str_replace(
                 ['/', '.php'],
                 ['\\', ''],
-                Str::after($repository->getPathname(), app_path().DIRECTORY_SEPARATOR)
+                Str::after($repository->getPathname(), $basePath.DIRECTORY_SEPARATOR)
             );
 
             if (is_subclass_of(
@@ -280,7 +278,7 @@ public static function isRestify(Request $request): bool
     public static function ensureRepositoriesLoaded(): void
     {
         if (empty(static::$repositories)) {
-            static::repositoriesFrom(app_path('Restify'));
+            static::repositoriesFrom(app_path('Restify'), app()->getNamespace());
         }
     }
 }

src/RestifyApplicationServiceProvider.php

@@ -39,7 +39,7 @@ public function boot()
      */
     protected function repositories(): void
     {
-        Restify::repositoriesFrom(app_path('Restify'));
+        Restify::repositoriesFrom(app_path('Restify'), app()->getNamespace());
     }
 
     /**

src/Traits/InteractsWithRestifyRepositories.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Binaryk\LaravelRestify\Traits;
+
+use Binaryk\LaravelRestify\Restify;
+use ReflectionException;
+
+trait InteractsWithRestifyRepositories
+{
+     /**
+     * Register the application's Rest resources.
+     *
+     * @throws ReflectionException
+     */
+    protected function loadRestifyFrom(string $directory, string $namespace): void
+    {
+        Restify::repositoriesFrom(
+            directory: $directory,
+            namespace: $namespace,
+        );
+    }
+}

tests/Concerns/WithRepositoriesDataProvider.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Binaryk\LaravelRestify\Tests\Concerns;
+
+trait WithRepositoriesDataProvider
+{
+    public static function repositoryPathsFromFixtures(): array
+    {
+        return [
+            [
+                'directory' => realpath(__DIR__.'/../Fixtures/CustomNamespace/PackageA/Restify'),
+                'namespace' => 'CustomNamespace\\PackageA\\Restify\\',
+                'serviceProvider' => 'CustomNamespace\\PackageA\\PackageAServiceProvider',
+            ],
+            [
+                'directory' => realpath(__DIR__.'/../Fixtures/CustomNamespace/PackageB/Restify'),
+                'namespace' => 'CustomNamespace\\PackageB\\Restify\\',
+                'serviceProvider' => 'CustomNamespace\\PackageB\\PackageBServiceProvider',
+            ],
+            [
+                'directory' => realpath(__DIR__.'/../Fixtures/CustomNamespace/PackageC/Restify'),
+                'namespace' => 'CustomNamespace\\PackageC\\Restify\\',
+                'serviceProvider' => 'CustomNamespace\\PackageC\\PackageCServiceProvider',
+            ],
+        ];
+    }
+}

tests/Controllers/RepositoryLoadedFromServiceProviderTest.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Binaryk\LaravelRestify\Tests\Controllers;
+
+use Binaryk\LaravelRestify\Restify;
+use Binaryk\LaravelRestify\Tests\Concerns\WithRepositoriesDataProvider;
+use Binaryk\LaravelRestify\Tests\IntegrationTestCase;
+
+class RepositoryLoadedFromServiceProviderTest extends IntegrationTestCase
+{
+    use WithRepositoriesDataProvider;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        Restify::$repositories = [];
+    }
+
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+    }
+
+    /** @dataProvider repositoryPathsFromFixtures */
+    public function test_repositories_can_be_loaded_with_service_provider_register_method(
+        string $directory,
+        string $namespace,
+        ?string $serviceProvider = null,
+    ): void
+    {
+        if (!$serviceProvider) {
+            $this->markTestSkipped('No service provider was found in directory '.$directory.' skipping this iteration.');
+        }
+
+        $this->app->register($serviceProvider);
+
+        foreach (Restify::$repositories as $repository) {
+            $route = $repository::route();
+            $this->getJson($route)->assertOk();
+        }
+
+        // Clears repositories so it does not affect other tests.
+        Restify::$repositories = [];
+    }
+}

tests/Fixtures/App/Restify/UserRepository.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Restify;
+
+use App\User;
+
+class UserRepository extends \Binaryk\LaravelRestify\Tests\Fixtures\User\UserRepository
+{
+    public static string $model = User::class;
+}

tests/Fixtures/App/User.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace App;
+
+class User extends \Binaryk\LaravelRestify\Tests\Fixtures\User\User
+{
+
+}