#20 - add scheduler (#21)

.gitignore

@@ -22,3 +22,4 @@ junit.xml
 clover.xml
 tests/*.txt
 /test/*/*Success__1.json
+**/__snapshots__/

README.md

@@ -124,6 +124,29 @@ class CreateUserConsoleCommand extends Command
 }
 ```
 
+### Scheduling Commands
+
+To schedule a command, we use the GO\Scheduler class. This class allows us to define the timing and frequency of command execution. Here's an example of how to schedule a command to run daily:
+
+```php
+$scheduler = new GO\Scheduler();
+$scheduler->php('/path/to/command app:user:create')->daily();
+$scheduler->run();
+```
+In this example, the app:user:create command is scheduled to run every day.
+
+#### Running the Scheduler
+The scheduler should be triggered by a system cron job to ensure it runs at regular intervals. Typically, you would set up a cron job to execute a PHP script that initializes and runs the scheduler.
+
+For instance, a cron job running every minute might look like this:
+
+```bash
+* * * * * ./bin/console.php schedule
+```
+
+This setup ensures that your scheduled commands are executed reliably and on time.
+
+
 ### Domain event and event handlers
 
 The framework implements the amqp protocol with handlers that allow events to be easily pushed onto the queue.

composer.json

@@ -31,6 +31,7 @@
         "fakerphp/faker": "^1.23",
         "lcobucci/clock": "^3.1",
         "monolog/monolog": "^2.8",
+        "peppeocchi/php-cron-scheduler": "^4.0",
         "php-amqplib/php-amqplib": "^3.2",
         "php-di/php-di": "^7.0",
         "php-di/slim-bridge": "^3.4",

deptrac.yaml

@@ -31,3 +31,5 @@ deptrac:
       - App\Infrastructure\AMQP\Queue\QueueContainer
       - App\Infrastructure\AMQP\Consumer
       - App\Infrastructure\AMQP\Queue\QueueContainer
+    App\Application\Console\ScheduleConsoleCommand:
+      - App\Infrastructure\Environment\Settings

src/Application/Console/AmqpConsumeConsoleCommand.php

@@ -14,8 +14,10 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 #[AsCommand(name: "app:amqp:consume", description: "Start consuming a given AMQP queue")]
-class AmqpConsumeConsoleCommand extends Command implements SignalableCommandInterface
+class AmqpConsumeConsoleCommand extends ConsoleCommand implements SignalableCommandInterface
 {
+    public static string $signature;
+
     public function __construct(
         private readonly QueueContainer $queueContainer,
         private readonly Consumer $consumer,

src/Application/Console/CacheClearConsoleCommand.php

@@ -11,8 +11,10 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 #[AsCommand(name: "app:cache:clear", description: "Clear all caches")]
-class CacheClearConsoleCommand extends Command
+class CacheClearConsoleCommand extends ConsoleCommand
 {
+    public static string $signature;
+
     public function __construct(
         private readonly Settings $settings,
     ) {
@@ -21,6 +23,8 @@ public function __construct(
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        $output->writeln("<info>Start clear cache</info>");
+
         $cacheDirs = [$this->settings->get("doctrine.cache_dir"), $this->settings->get("slim.cache_dir")];
 
         foreach ($cacheDirs as $cacheDir) {
@@ -31,6 +35,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $this->removeDirectory($cacheDir);
         }
 
+        $output->writeln("<info>Done clear cache</info>");
+
         return Command::SUCCESS;
     }