Files
InvoiceShelf/tests/Feature/Company/Modules/ModuleMakeStubTest.php
Darko Gjorgjijoski 7885bf9d11 feat(menu): priority-sorted menu groups, user-menu items, sidebar appearance toggle
Every main_menu entry moves from numeric group (1/2/3) to string-based group + group_label + priority. Groups now carry their own i18n label and child entries are sorted by an explicit priority field instead of config-array order, so module-contributed menu items can slot into any existing group at any position.

BootstrapController merges module-registered menu items into main_menu (previously they lived in a separate module_menu response key) and introduces a user_menu response key for items modules want to place in the avatar dropdown. The global store follows suit: moduleMenu becomes userMenu, menuGroups is a computed that sorts by priority, and hasActiveModules drops out.

New admin Appearance setting page with a single toggle for whether sidebar group labels render — so instances that prefer a compact sidebar can hide the Documents/Administration/Modules headings without losing the grouping itself. CompanyLayout watches route meta and re-bootstraps when the admin-mode flag flips so the sidebar repaints with the right menu on navigation across the admin boundary.

Test suites updated: module menu merging is asserted against main_menu (name: 'module-{slug}') rather than the old module_menu response; HelloWorldIntegrationTest verifies the schema translation path; CompanyModulesIndexTest covers the display_name attachment.
2026-04-11 00:30:00 +02:00

84 lines
3.4 KiB
PHP

<?php
use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\File;
/**
* Exercises the custom generator stubs shipped from the invoiceshelf/modules
* package. These override nwidart's defaults so that a fresh
* `php artisan module:make` scaffold already includes the Registry boilerplate
* and the starter i18n files that the boilerplate references.
*
* The test generates a throwaway module, inspects the generated files, then
* cleans up (including nwidart's status entry) so the rest of the suite is
* unaffected.
*/
beforeEach(function () {
$this->scaffoldModule = 'ScaffoldProbe';
$this->scaffoldPath = base_path('Modules/'.$this->scaffoldModule);
// Make sure no leftover from a previous crashed test.
if (File::isDirectory($this->scaffoldPath)) {
File::deleteDirectory($this->scaffoldPath);
}
});
afterEach(function () {
if (File::isDirectory($this->scaffoldPath)) {
File::deleteDirectory($this->scaffoldPath);
}
// nwidart writes module activation state to storage/app/modules_statuses.json
// when module:make auto-enables the new module. Remove our scaffold entry
// so the file doesn't accumulate stale test data across runs.
$statusesFile = storage_path('app/modules_statuses.json');
if (File::exists($statusesFile)) {
$statuses = json_decode(File::get($statusesFile), true) ?? [];
unset($statuses[$this->scaffoldModule]);
File::put($statusesFile, json_encode($statuses, JSON_PRETTY_PRINT));
}
});
test('module:make generates a ServiceProvider that uses InvoiceShelf\\Modules\\Registry', function () {
Artisan::call('module:make', ['name' => [$this->scaffoldModule]]);
$providerPath = $this->scaffoldPath.'/app/Providers/'.$this->scaffoldModule.'ServiceProvider.php';
expect(File::exists($providerPath))->toBeTrue();
$contents = File::get($providerPath);
expect($contents)->toContain('use InvoiceShelf\\Modules\\Registry as ModuleRegistry;');
expect($contents)->toContain('use InvoiceShelf\\Modules\\Support\\ModuleServiceProvider;');
expect($contents)->toContain('ModuleRegistry::registerMenu(');
expect($contents)->toContain('ModuleRegistry::registerSettings(');
expect($contents)->toContain("protected string \$name = '{$this->scaffoldModule}';");
expect($contents)->toContain('Str::kebab($this->name)');
});
test('module:make generates a composer.json that requires invoiceshelf/modules', function () {
Artisan::call('module:make', ['name' => [$this->scaffoldModule]]);
$composerPath = $this->scaffoldPath.'/composer.json';
expect(File::exists($composerPath))->toBeTrue();
$manifest = json_decode(File::get($composerPath), true);
expect($manifest['require'] ?? [])->toHaveKey('invoiceshelf/modules');
expect($manifest['require']['invoiceshelf/modules'])->toBe('^3.0');
});
test('module:make generates starter lang files for menu and settings', function () {
Artisan::call('module:make', ['name' => [$this->scaffoldModule]]);
expect(File::exists($this->scaffoldPath.'/lang/en/menu.php'))->toBeTrue();
expect(File::exists($this->scaffoldPath.'/lang/en/settings.php'))->toBeTrue();
$menu = require $this->scaffoldPath.'/lang/en/menu.php';
expect($menu)->toHaveKey('title');
expect($menu['title'])->toBe('ScaffoldProbe');
$settings = require $this->scaffoldPath.'/lang/en/settings.php';
expect($settings)->toHaveKey('general_section');
expect($settings)->toHaveKey('enabled');
});