test: add v5 regression coverage and fix widget access recursion

src/Modules.php

@@ -67,14 +67,20 @@ public function getModuleClusters(string $moduleName)
 
     public function convertPathToNamespace(string $fullPath): string
     {
+        $normalizedPath = str_replace(['/', '\\'], DIRECTORY_SEPARATOR, $fullPath);
         $appFolder = trim(config('modules.paths.app_folder', 'app'), '/\\');
-        $appPath = $appFolder . DIRECTORY_SEPARATOR;
-        $base = str(trim(config('modules.paths.modules', base_path('Modules')), '/\\'));
-        $replacementPath = str_replace(DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR, '/', DIRECTORY_SEPARATOR . $appPath);
-        $relative = str($fullPath)->afterLast($base)->replaceFirst($replacementPath, DIRECTORY_SEPARATOR);
+        $base = str_replace(['/', '\\'], DIRECTORY_SEPARATOR, trim(config('modules.paths.modules', base_path('Modules')), '/\\'));
+        $appSegment = $appFolder . DIRECTORY_SEPARATOR;
+
+        $relative = str($normalizedPath)->afterLast($base)->ltrim(DIRECTORY_SEPARATOR);
+
+        if (str($relative)->startsWith($appSegment)) {
+            $relative = str($relative)->after($appSegment);
+        } else {
+            $relative = str($relative)->replace(DIRECTORY_SEPARATOR . $appSegment, DIRECTORY_SEPARATOR);
+        }
 
         return str($relative)
-            ->ltrim('/\\')
             ->prepend(DIRECTORY_SEPARATOR)
             ->prepend(config('modules.namespace', 'Modules'))
             ->replace(DIRECTORY_SEPARATOR, '\\')

src/ModulesServiceProvider.php

@@ -233,39 +233,55 @@ protected function registerModuleMacros(): void
         NwidartModule::macro('appPath', function (string $relativePath = '') {
             $appPath = $this->getExtraPath(config('modules.paths.app_folder', 'app'));
 
-            return str($appPath . ($relativePath ? DIRECTORY_SEPARATOR . $relativePath : ''))->replace(DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)->toString();
+            return str($appPath . ($relativePath ? DIRECTORY_SEPARATOR . $relativePath : ''))
+                ->replace(['/', '\\'], DIRECTORY_SEPARATOR)
+                ->replace(DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)
+                ->toString();
         });
 
         NwidartModule::macro('databasePath', function (string $relativePath = '') {
             $appPath = $this->getExtraPath('database');
 
-            return str($appPath . ($relativePath ? DIRECTORY_SEPARATOR . $relativePath : ''))->replace(DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)->toString();
+            return str($appPath . ($relativePath ? DIRECTORY_SEPARATOR . $relativePath : ''))
+                ->replace(['/', '\\'], DIRECTORY_SEPARATOR)
+                ->replace(DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)
+                ->toString();
         });
 
         NwidartModule::macro('resourcesPath', function (string $relativePath = '') {
             $appPath = $this->getExtraPath('resources');
 
             return str($appPath . ($relativePath ? DIRECTORY_SEPARATOR . $relativePath : ''))
-                ->replace(DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)->toString();
+                ->replace(['/', '\\'], DIRECTORY_SEPARATOR)
+                ->replace(DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)
+                ->toString();
         });
 
         NwidartModule::macro('migrationsPath', function (string $relativePath = '') {
             $appPath = $this->databasePath('migrations');
 
             return str($appPath . ($relativePath ? DIRECTORY_SEPARATOR . $relativePath : ''))
-                ->replace(DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)->toString();
+                ->replace(['/', '\\'], DIRECTORY_SEPARATOR)
+                ->replace(DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)
+                ->toString();
         });
 
         NwidartModule::macro('seedersPath', function (string $relativePath = '') {
             $appPath = $this->databasePath('seeders');
 
-            return str($appPath . ($relativePath ? DIRECTORY_SEPARATOR . $relativePath : ''))->replace(DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)->toString();
+            return str($appPath . ($relativePath ? DIRECTORY_SEPARATOR . $relativePath : ''))
+                ->replace(['/', '\\'], DIRECTORY_SEPARATOR)
+                ->replace(DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)
+                ->toString();
         });
 
         NwidartModule::macro('factoriesPath', function (string $relativePath = '') {
             $appPath = $this->databasePath('factories');
 
-            return str($appPath . ($relativePath ? DIRECTORY_SEPARATOR . $relativePath : ''))->replace(DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)->toString();
+            return str($appPath . ($relativePath ? DIRECTORY_SEPARATOR . $relativePath : ''))
+                ->replace(['/', '\\'], DIRECTORY_SEPARATOR)
+                ->replace(DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR)
+                ->toString();
         });
     }
 }

src/Traits/CanAccessTrait.php

@@ -21,9 +21,15 @@ public static function canAccess(): bool
             static::getCurrentModuleName()
         )->isEnabled();
         $parentClass = get_parent_class(static::class);
-        $parentAccess = is_string($parentClass) && method_exists($parentClass, 'canAccess')
-            ? $parentClass::canAccess()
-            : true;
+        $parentAccess = true;
+
+        if (
+            is_string($parentClass)
+            && str_starts_with($parentClass, 'Filament\\')
+            && method_exists($parentClass, 'canAccess')
+        ) {
+            $parentAccess = $parentClass::canAccess();
+        }
 
         if ($isModuleEnabled && $parentAccess) {
             return true;

tests/Support/CreatesTestModules.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace Coolsam\Modules\Tests\Support;
+
+use Nwidart\Modules\Facades\Module;
+use Nwidart\Modules\FileRepository;
+use Nwidart\Modules\Laravel\Module as LaravelModule;
+
+trait CreatesTestModules
+{
+    protected function workbenchPath(string $path = ''): string
+    {
+        $base = dirname(__DIR__, 2) . '/vendor/orchestra/testbench-core/laravel';
+
+        return $path === '' ? $base : $base . '/' . ltrim($path, '/');
+    }
+
+    protected function modulesPath(): string
+    {
+        return $this->workbenchPath('Modules');
+    }
+
+    protected function resetModulesDirectory(): void
+    {
+        $modulesPath = $this->modulesPath();
+
+        if (is_dir($modulesPath)) {
+            $iterator = new \RecursiveIteratorIterator(
+                new \RecursiveDirectoryIterator($modulesPath, \FilesystemIterator::SKIP_DOTS),
+                \RecursiveIteratorIterator::CHILD_FIRST,
+            );
+
+            foreach ($iterator as $file) {
+                $file->isDir() ? rmdir($file->getPathname()) : unlink($file->getPathname());
+            }
+        } else {
+            mkdir($modulesPath, 0755, true);
+        }
+
+        $statusesFile = $this->workbenchPath('modules_statuses.json');
+
+        if (file_exists($statusesFile)) {
+            unlink($statusesFile);
+        }
+
+        $this->clearModuleRepositoryCache();
+    }
+
+    protected function createTestModule(string $name = 'Blog', bool $enabled = true): LaravelModule
+    {
+        $modulePath = $this->modulesPath() . DIRECTORY_SEPARATOR . $name;
+
+        if (! is_dir($modulePath)) {
+            mkdir($modulePath . DIRECTORY_SEPARATOR . 'app', 0755, true);
+            file_put_contents($modulePath . DIRECTORY_SEPARATOR . 'module.json', json_encode([
+                'name' => $name,
+                'alias' => strtolower($name),
+                'description' => '',
+                'keywords' => [],
+                'priority' => 0,
+                'providers' => [],
+                'files' => [],
+            ], JSON_THROW_ON_ERROR));
+        }
+
+        $this->clearModuleRepositoryCache();
+
+        $module = Module::findOrFail($name);
+
+        $enabled ? $module->enable() : $module->disable();
+
+        return $module;
+    }
+
+    protected function clearModuleRepositoryCache(): void
+    {
+        $reflection = new \ReflectionClass(FileRepository::class);
+
+        if ($reflection->hasProperty('modules')) {
+            $property = $reflection->getProperty('modules');
+            $property->setAccessible(true);
+            $property->setValue(null, []);
+        }
+    }
+}

tests/TestCase.php

@@ -5,6 +5,7 @@
 use BladeUI\Heroicons\BladeHeroiconsServiceProvider;
 use BladeUI\Icons\BladeIconsServiceProvider;
 use Coolsam\Modules\ModulesServiceProvider;
+use Coolsam\Modules\Tests\Support\CreatesTestModules;
 use Filament\Actions\ActionsServiceProvider;
 use Filament\FilamentServiceProvider;
 use Filament\Forms\FormsServiceProvider;
@@ -22,10 +23,13 @@
 
 class TestCase extends Orchestra
 {
+    use CreatesTestModules;
     use WithWorkbench;
 
     protected function setUp(): void
     {
+        $this->resetModulesDirectory();
+
         parent::setUp();
 
         Factory::guessFactoryNamesUsing(
@@ -57,9 +61,15 @@ public function getEnvironmentSetUp($app)
     {
         config()->set('database.default', 'testing');
 
-        /*
-        $migration = include __DIR__.'/../database/migrations/create_modules_table.php.stub';
-        $migration->up();
-        */
+        $modulesPath = $app->basePath('Modules');
+
+        if (! is_dir($modulesPath)) {
+            mkdir($modulesPath, 0755, true);
+        }
+
+        config()->set('modules.paths.modules', $modulesPath);
+        config()->set('modules.namespace', 'Modules');
+        config()->set('modules.paths.app_folder', 'app');
+        config()->set('modules.activators.file.statuses-file', $app->basePath('modules_statuses.json'));
     }
 }

tests/Unit/CanAccessTraitTest.php

@@ -0,0 +1,45 @@
+<?php
+
+use Coolsam\Modules\ChartWidget;
+use Modules\Blog\Filament\Widgets\TestChartWidget;
+
+beforeEach(function () {
+    if (! class_exists('Modules\Blog\Filament\Widgets\TestChartWidget', false)) {
+        eval(<<<'PHP'
+            namespace Modules\Blog\Filament\Widgets;
+
+            class TestChartWidget extends \Coolsam\Modules\ChartWidget
+            {
+                protected function getType(): string
+                {
+                    return 'line';
+                }
+            }
+            PHP);
+    }
+});
+
+test('can access trait allows widget access when module is enabled', function () {
+    $this->createTestModule('Blog', enabled: true);
+
+    expect(TestChartWidget::canAccess())->toBeTrue();
+    expect(TestChartWidget::canView())->toBeTrue();
+});
+
+test('can access trait denies widget access when module is disabled', function () {
+    $this->createTestModule('Blog', enabled: false);
+
+    expect(TestChartWidget::canAccess())->toBeFalse();
+    expect(TestChartWidget::canView())->toBeFalse();
+});
+
+test('can access trait does not call parent can access when parent lacks the method', function () {
+    $this->createTestModule('Blog', enabled: true);
+
+    expect(method_exists(ChartWidget::class, 'canAccess'))->toBeTrue();
+    expect(method_exists(Filament\Widgets\ChartWidget::class, 'canAccess'))->toBeFalse();
+});
+
+test('can access trait resolves the module name from the class namespace', function () {
+    expect(TestChartWidget::getCurrentModuleName())->toBe('blog');
+});

tests/Unit/ModuleMacrosTest.php

@@ -0,0 +1,32 @@
+<?php
+
+use Coolsam\Modules\Facades\FilamentModules;
+use Nwidart\Modules\Facades\Module;
+
+test('module macros expose package path helpers', function () {
+    $module = $this->createTestModule('Blog');
+
+    expect($module->namespace(''))->toBe('Modules\\Blog\\');
+    expect($module->getTitle())->toBe('Blog');
+    expect($module->appNamespace('Filament\\Resources'))->toBe('Modules\\Blog\\Filament\\Resources');
+    expect($module->appPath('Filament'))->toEndWith('Blog' . DIRECTORY_SEPARATOR . 'app' . DIRECTORY_SEPARATOR . 'Filament');
+    expect($module->databasePath('migrations'))->toEndWith('Blog' . DIRECTORY_SEPARATOR . 'database' . DIRECTORY_SEPARATOR . 'migrations');
+    expect($module->resourcesPath('views'))->toEndWith('Blog' . DIRECTORY_SEPARATOR . 'resources' . DIRECTORY_SEPARATOR . 'views');
+});
+
+test('module facade can resolve a scanned module without the global alias', function () {
+    expect(class_exists(\Module::class, false))->toBeFalse();
+
+    $this->createTestModule('Blog');
+
+    expect(Module::find('Blog'))->not->toBeNull();
+    expect(Module::isEnabled('Blog'))->toBeTrue();
+});
+
+test('filament modules helper can resolve module panels path via macros', function () {
+    $this->createTestModule('Blog');
+
+    $panels = FilamentModules::getModulePanels('Blog');
+
+    expect($panels)->toBeArray();
+});

tests/Unit/ModulesServiceProviderBootTest.php

@@ -0,0 +1,55 @@
+<?php
+
+use Coolsam\Modules\Facades\FilamentModules;
+use Coolsam\Modules\ModulesServiceProvider;
+use Nwidart\Modules\Facades\Module;
+
+test('modules service provider boots without the removed global module alias', function () {
+    expect(class_exists(\Module::class, false))->toBeFalse();
+    expect($this->app->getProvider(ModulesServiceProvider::class))->toBeInstanceOf(ModulesServiceProvider::class);
+});
+
+test('modules service provider can register enabled module providers discovered on disk', function () {
+    $module = $this->createTestModule('Blog', enabled: true);
+
+    $providerPath = $module->appPath('Providers' . DIRECTORY_SEPARATOR . 'BlogServiceProvider.php');
+    $providerDir = dirname($providerPath);
+
+    if (! is_dir($providerDir)) {
+        mkdir($providerDir, 0755, true);
+    }
+
+    file_put_contents($providerPath, <<<'PHP'
+        <?php
+
+        namespace Modules\Blog\Providers;
+
+        use Illuminate\Support\ServiceProvider;
+
+        class BlogServiceProvider extends ServiceProvider
+        {
+            public function register(): void
+            {
+            }
+        }
+        PHP);
+
+    require_once $providerPath;
+
+    $namespace = FilamentModules::convertPathToNamespace($providerPath);
+
+    expect($namespace)->toBe('Modules\\Blog\\Providers\\BlogServiceProvider');
+    expect(Module::isEnabled('Blog'))->toBeTrue();
+
+    $this->app->register($namespace);
+
+    expect(collect($this->app->getProviders($namespace)))->not->toBeEmpty();
+});
+
+test('modules service provider condition matches module-owned provider class names', function () {
+    $module = $this->createTestModule('Blog', enabled: true);
+
+    expect(str('BlogServiceProvider')->startsWith('Blog'))->toBeTrue();
+    expect(Module::isEnabled('Blog'))->toBeTrue();
+    expect(Module::isEnabled('blog'))->toBeTrue();
+});

tests/Unit/ModulesSingletonTest.php

@@ -7,3 +7,11 @@
     $namespace = FilamentModules::convertPathToNamespace($path);
     expect($namespace)->toBe($expected = 'Modules\\Providers\\TestServiceProvider', "Expected $expected Instead got " . $namespace);
 });
+
+test('can convert windows style module paths to namespaces', function () {
+    $base = str_replace(['/', '\\'], DIRECTORY_SEPARATOR, config('modules.paths.modules'));
+    $path = $base . DIRECTORY_SEPARATOR . 'Blog' . DIRECTORY_SEPARATOR . 'app' . DIRECTORY_SEPARATOR . 'Providers' . DIRECTORY_SEPARATOR . 'BlogServiceProvider.php';
+    $namespace = FilamentModules::convertPathToNamespace($path);
+
+    expect($namespace)->toBe('Modules\\Blog\\Providers\\BlogServiceProvider');
+});