Skip to content

Refactoring DemoCommand to Use Task-Based Step System #159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
armanist merged 1 commit into from
Oct 31, 2025
Merged

Refactoring DemoCommand to Use Task-Based Step System #159

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
171 changes: 110 additions & 61 deletions shared/Commands/DemoCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,16 @@ class DemoCommand extends QtCommand
*/
protected $faker;

/**
* @var array
*/
private $generatedUsers = [];

/**
* @var array
*/
private $generatedPosts = [];

/**
* Default password for generated users
*/
Expand Down Expand Up @@ -130,17 +140,64 @@ public function exec()
}
}

$progress = $this->initProgressBar(6);
$steps = $this->getSteps();
$progress = $this->initProgressBar(count($steps));

$this->createModules($progress);
$this->resetDatabase($progress);
$this->generateDemoData($progress);
foreach ($steps as $step) {
$this->updateProgress($progress, $step['message']);
$step['action']();
}

$progress->finish();

$this->info(PHP_EOL . "Demo project created successfully");
}

/**
* Provides the sequence of defined tasks to be executed.
* @return array[]
*/
private function getSteps(): array
{
return [
[
'message' => 'Creating API module',
'action' => function() {
$this->createModule('Api', 'DemoApi', false);
}
],
[
'message' => 'Creating Web module',
'action' => function() {
$this->createModule('Web', 'DemoWeb', true);
}
],
[
'message' => 'Cleaning up uploads & rebuilding database',
'action' => function() {
$this->resetDatabase();
}
],
[
'message' => 'Generating users',
'action' => function() {
$this->generatedUsers = $this->generateUsers();
}
],
[
'message' => 'Generating posts',
'action' => function() {
$this->generatedPosts = $this->generatePosts($this->generatedUsers);
}
],
[
'message' => 'Generating comments',
'action' => function() {
$this->generateComments($this->generatedUsers, $this->generatedPosts);
}
],
];
}

/**
* Initializes a progress bar.
* @param int $steps
Expand All @@ -150,39 +207,34 @@ private function initProgressBar(int $steps): ProgressBar
{
$progress = new ProgressBar($this->output, $steps);
$progress->setFormat(sprintf('%s <info>%%item%%</info>', $progress->getFormatDefinition('verbose')));
$progress->setBarCharacter('■');
$progress->setEmptyBarCharacter('-');
$progress->setProgressCharacter('►');
$progress->start();
return $progress;
}

/**
* Creates demo modules.
* @param ProgressBar $progress
* Creates module
* @param string $moduleName
* @param string $template
* @param bool $withAssets
* @return void
* @throws ExceptionInterface
*/
private function createModules(ProgressBar $progress): void
private function createModule(string $moduleName, string $template, bool $withAssets): void
{
$this->updateProgress($progress, "Creating demo api module...");

$this->runExternalCommand(self::COMMANDS['module_generate'], [
'module' => 'Api',
'module' => $moduleName,
'--yes' => true,
'--template' => 'DemoApi',
'--with-assets' => false
]);

$this->updateProgress($progress, "Creating demo web module...");

$this->runExternalCommand(self::COMMANDS['module_generate'], [
'module' => 'Web',
'--yes' => true,
'--template' => 'DemoWeb',
'--with-assets' => true
'--template' => $template,
'--with-assets' => $withAssets
]);
}

/**
* Generates demo users and posts.
* @param ProgressBar $progress
* Generate demo users.
* @return array
* @throws BaseException
* @throws ConfigException
* @throws DiException
Expand All @@ -191,24 +243,6 @@ private function createModules(ProgressBar $progress): void
* @throws HttpClientException
* @throws ReflectionException
*/
private function generateDemoData(ProgressBar $progress): void
{
$this->updateProgress($progress, "Generating demo users...");
$createdUsers = $this->generateUsers();

$this->updateProgress($progress, "Generating demo posts...");
$createdPosts = $this->generatePosts($createdUsers);

$this->updateProgress($progress, "Generating demo comments...");
$this->generateComments($createdUsers, $createdPosts);
}

/**
* Generate demo users.
* @param ProgressBar $progress
* @return array
* @throws ExceptionInterface
*/
private function generateUsers(): array
{
$users = [];
Expand All @@ -224,24 +258,35 @@ private function generateUsers(): array
* Generate demo posts for each user.
* @param array $users
* @return array
* @throws BaseException
* @throws ConfigException
* @throws DiException
* @throws ErrorException
* @throws ExceptionInterface
* @throws HttpClientException
* @throws ReflectionException
*/
private function generatePosts(array $users): array
{
$posts = [];

foreach ($users as $user) {
for ($i = 0; $i < self::COUNTS['posts_per_user']; $i++) {
$post = $this->generatePostData($user);
$this->runExternalCommand(self::COMMANDS['post_create'], $post);
$posts[] = $post;
}
}

return $posts;
}

/**
* Generate demo comments for each post.
* @param array $users
* @param array $posts
* @return void
* @throws ExceptionInterface
*/
private function generateComments(array $users, array $posts): void
{
Expand All @@ -261,6 +306,12 @@ private function generateComments(array $users, array $posts): void
/**
* Generates data for user
* @return array
* @throws BaseException
* @throws ConfigException
* @throws DiException
* @throws ErrorException
* @throws HttpClientException
* @throws ReflectionException
*/
private function generateUserData(): array
{
Expand Down Expand Up @@ -318,6 +369,7 @@ private function generatePostData($user): array
}

/**
* Get random user for comment except post owner
* @param array $users
* @param string $excludeUuid
* @return array
Expand All @@ -333,21 +385,15 @@ private function getRandomUserExcept(array $users, string $excludeUuid): array
}

/**
* Cleans the uploads and resets the database.
* Generates demo users and posts.
* @param ProgressBar $progress
* @return void
* @throws BaseException
* @throws ConfigException
* @throws DiException
* @throws ExceptionInterface
* @throws ReflectionException
* @throws ServiceException
* @param string $message
*/
private function resetDatabase(ProgressBar $progress): void
private function updateProgress(ProgressBar $progress, string $message): void
{
$this->updateProgress($progress, "Cleaning up the database");
$this->removeUploads();
$this->rebuildDatabase();
$progress->setMessage($message, 'item');
$progress->display();
$progress->advance();
}

/**
Expand Down Expand Up @@ -391,15 +437,18 @@ private function removeUploads(): void
}

/**
* Generates demo users and posts.
* @param ProgressBar $progress
* @param string $message
* Cleans the uploads and resets the database.
* @return void
* @throws BaseException
* @throws ConfigException
* @throws DiException
* @throws ExceptionInterface
* @throws ReflectionException
*/
private function updateProgress(ProgressBar $progress, string $message): void
private function resetDatabase(): void
{
$progress->setMessage($message, 'item');
$progress->display();
$progress->advance();
$this->removeUploads();
$this->rebuildDatabase();
}

/**
Expand Down