Infra-Mirrors/BookStack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-10-01 05:36:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added test for logical-theme-system command registration

Browse Source 
Changed how the command registration was handled due to complications of
action order found during testing. Now the theme service will resolve
and directly register the command on the Kernel instead of them being
fetched from the ThemeService from within Kernel.
More direct, Seems to work.
This commit is contained in:
Dan Brown 2021-11-22 19:03:04 +00:00
parent cdaad2f40e
commit cb30c258df
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
3 changed files with 23 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
app/Console/Kernel.php
View File

@ -2,11 +2,8 @@
namespace BookStack\Console;
use BookStack\Facades\Theme;
use BookStack\Theming\ThemeService;
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
use Symfony\Component\Console\Command\Command;
class Kernel extends ConsoleKernel
{
@ -38,13 +35,6 @@ class Kernel extends ConsoleKernel
*/
protected function commands()
{
// Default framework command loading from 'Commands' directory
$this->load(__DIR__ . '/Commands');
// Load any user commands that have been registered via the theme system.
$themeService = $this->app->make(ThemeService::class);
foreach ($themeService->getRegisteredCommands() as $command) {
$this->registerCommand($command);
}
}
}

18
app/Theming/ThemeService.php
View File

@ -3,17 +3,13 @@
namespace BookStack\Theming;
use BookStack\Auth\Access\SocialAuthService;
use Illuminate\Contracts\Console\Kernel;
use Symfony\Component\Console\Command\Command;
class ThemeService
{
protected $listeners = [];
/**
* @var Command[]
*/
protected $commands = [];
/**
* Listen to a given custom theme event,
* setting up the action to be ran when the event occurs.
@ -54,15 +50,9 @@ class ThemeService
*/
public function registerCommand(Command $command)
{
$this->commands[] = $command;
}
/**
* Get the custom commands that have been registered.
*/
public function getRegisteredCommands(): array
{
return $this->commands;
/** @var \Illuminate\Foundation\Console\Kernel $consoleKernel */
$consoleKernel = app()->make(Kernel::class);
$consoleKernel->registerCommand($command);
}
/**

19
tests/ThemeTest.php
View File

@ -7,8 +7,10 @@ use BookStack\Entities\Models\Page;
use BookStack\Entities\Tools\PageContent;
use BookStack\Facades\Theme;
use BookStack\Theming\ThemeEvents;
use Illuminate\Console\Command;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\File;
use League\CommonMark\ConfigurableEnvironmentInterface;
@ -206,6 +208,16 @@ class ThemeTest extends TestCase
$this->assertStringContainsString('donkey=donut', $redirect);
}
public function test_register_command_allows_provided_command_to_be_usable_via_artisan()
{
Theme::registerCommand(new MyCustomCommand);
Artisan::call('bookstack:test-custom-command', []);
$output = Artisan::output();
$this->assertStringContainsString('Command ran!', $output);
}
protected function usingThemeFolder(callable $callback)
{
// Create a folder and configure a theme
@ -220,3 +232,10 @@ class ThemeTest extends TestCase
File::deleteDirectory($themeFolderPath);
}
}
class MyCustomCommand extends Command {
protected $signature = 'bookstack:test-custom-command';
public function handle() {
$this->line('Command ran!');
}
}