Merge pull request #355 from bowphp/refactor/code-base

Refactoring queue and add should queue support

Author: papac

src/Console/Command.php

@@ -29,7 +29,7 @@
 use Bow\Console\Command\Generator\GenerateNotificationCommand;
 use Bow\Console\Command\Generator\GenerateConfigurationCommand;
 use Bow\Console\Command\Generator\GenerateEventListenerCommand;
-use Bow\Console\Command\Generator\GenerateJobCommand;
+use Bow\Console\Command\Generator\GenerateTaskCommand;
 use Bow\Console\Command\Generator\GenerateRouterResourceCommand;
 
 class Command extends AbstractCommand
@@ -57,7 +57,7 @@ class Command extends AbstractCommand
         "add:validation" => GenerateValidationCommand::class,
         "add:event" => GenerateAppEventCommand::class,
         "add:listener" => GenerateEventListenerCommand::class,
-        "add:job" => GenerateJobCommand::class,
+        "add:task" => GenerateTaskCommand::class,
         "add:command" => GenerateConsoleCommand::class,
         "add:notifier" => GenerateNotifierCommand::class,
         "run:console" => ReplCommand::class,

src/Console/Command/Generator/GenerateJobCommand.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bow\Console\Command\Generator;
+
+use Bow\Console\AbstractCommand;
+use Bow\Console\Color;
+use Bow\Console\Generator;
+
+class GenerateTaskCommand extends AbstractCommand
+{
+    /**
+     * Add task
+     *
+     * @param  string $task
+     * @return void
+     */
+    public function run(string $task): void
+    {
+        $generator = new Generator(
+            $this->setting->getTaskDirectory(),
+            $task
+        );
+
+        if ($generator->fileExists()) {
+            echo Color::red("The task already exists");
+            exit(1);
+        }
+
+        $generator->write('task', [
+            'baseNamespace' => $this->namespaces['task'] ?? 'App\\Tasks'
+        ]);
+
+        echo Color::green("The task has been well created.");
+        exit(0);
+    }
+}

src/Console/Command/Generator/GenerateTaskCommand.php

@@ -60,7 +60,7 @@ class Console
         'service',
         'exception',
         'event',
-        'job',
+        'task',
         'command',
         'listener',
         'notifier'
@@ -540,7 +540,7 @@ private function help(?string $command = null): int
    \033[0;33madd:migration\033[00m       Create a new migration
    \033[0;33madd:event\033[00m           Create a new event
    \033[0;33madd:listener\033[00m        Create a new event listener
-   \033[0;33madd:job\033[00m             Create a new job
+   \033[0;33madd:task\033[00m             Create a new task
    \033[0;33madd:command\033[00m         Create a new console command
    \033[0;33madd:notifier\033[00m         Create a new messaging handler
 
@@ -564,7 +564,7 @@ private function help(?string $command = null): int
  \033[0;32mRUN\033[00m Launch development tools
    \033[0;33mrun:console\033[00m Show PsySH PHP REPL for debugging code
    \033[0;33mrun:server\033[00m  Start local development server
-   \033[0;33mrun:worker\033[00m  Start consumer/worker to handle queue jobs
+   \033[0;33mrun:worker\033[00m  Start consumer/worker to handle queue tasks
 
 USAGE;
             echo $usage;
@@ -593,7 +593,7 @@ private function help(?string $command = null): int
     \033[0;33m$\033[00m php \033[0;34mbow\033[00m add:seeder name [--seed=n]    Create a new seeder
     \033[0;33m$\033[00m php \033[0;34mbow\033[00m add:migration name            Create a new migration
     \033[0;33m$\033[00m php \033[0;34mbow\033[00m add:event name                Create a new event listener
-    \033[0;33m$\033[00m php \033[0;34mbow\033[00m add:job name                  Create a new queue job
+    \033[0;33m$\033[00m php \033[0;34mbow\033[00m add:task name                  Create a new queue task
     \033[0;33m$\033[00m php \033[0;34mbow\033[00m add:command name              Create a new console command
     \033[0;33m$\033[00m php \033[0;34mbow\033[00m add:notifier name              Create a new messaging handler
     \033[0;33m$\033[00m php \033[0;34mbow\033[00m add help                      Display this help
@@ -642,7 +642,7 @@ private function help(?string $command = null): int
 
    \033[0;33m$\033[00m php \033[0;34mbow\033[00m run:console          Show PsySH PHP REPL for debugging code
    \033[0;33m$\033[00m php \033[0;34mbow\033[00m run:server [option]  Start local development server
-   \033[0;33m$\033[00m php \033[0;34mbow\033[00m run:worker [option]  Start worker to handle queue jobs
+   \033[0;33m$\033[00m php \033[0;34mbow\033[00m run:worker [option]  Start worker to handle queue tasks
 
 U; // phpcs:enable
                 break;

src/Console/Console.php

@@ -137,11 +137,11 @@ class Setting
     private string $service_directory;
 
     /**
-     * The job directory
+     * The task directory
      *
      * @var string
      */
-    private string $job_directory;
+    private string $task_directory;
     /**
      * The command directory
      *
@@ -402,24 +402,24 @@ public function setServiceDirectory(string $service_directory): void
     }
 
     /**
-     * Get the job directory
+     * Get the task directory
      *
      * @return string
      */
-    public function getJobDirectory(): string
+    public function getTaskDirectory(): string
     {
-        return $this->job_directory;
+        return $this->task_directory;
     }
 
     /**
-     * Set the job directory
+     * Set the task directory
      *
-     * @param  string $job_directory
+     * @param  string $task_directory
      * @return void
      */
-    public function setJobDirectory(string $job_directory): void
+    public function setTaskDirectory(string $task_directory): void
     {
-        $this->job_directory = $job_directory;
+        $this->task_directory = $task_directory;
     }
 
     /**

src/Console/Setting.php

@@ -2,9 +2,9 @@
 
 namespace {baseNamespace}{namespace};
 
-use Bow\Queue\QueueJob;
+use Bow\Queue\QueueTask;
 
-class {className} extends QueueJob
+class {className} extends QueueTask
 {
     /**
      * {className} constructor

src/Console/stubs/job.stub src/Console/stubs/task.stubsrc/Console/stubs/job.stub renamed to src/Console/stubs/task.stub

@@ -337,7 +337,7 @@ public static function retrieveAndDelete(
         }
 
         if ($model instanceof Collection) {
-            $model->delete();
+            $model->map(fn ($m) => $m->delete());
             return $model;
         }
 
@@ -861,9 +861,7 @@ public function toArray(): array
     {
         return array_filter(
             $this->attributes,
-            function ($key) {
-                return !in_array($key, $this->hidden);
-            },
+            fn ($key) => !in_array($key, $this->hidden),
             ARRAY_FILTER_USE_KEY
         );
     }
@@ -875,9 +873,7 @@ public function jsonSerialize(): array
     {
         return array_filter(
             $this->attributes,
-            function ($key) {
-                return !in_array($key, $this->hidden);
-            },
+            fn ($key) => !in_array($key, $this->hidden),
             ARRAY_FILTER_USE_KEY
         );
     }

src/Database/Barry/Model.php

@@ -426,19 +426,19 @@ public static function inTransaction(): bool
      */
     public static function commit(): void
     {
-        static::ensureDatabaseConnection();
-
-        static::$adapter->getConnection()->commit();
+        if (static::inTransaction()) {
+            static::$adapter->getConnection()->commit();
+        }
     }
 
     /**
      * Cancel a transaction
      */
     public static function rollback(): void
     {
-        static::ensureDatabaseConnection();
-
-        static::$adapter->getConnection()->rollBack();
+        if (static::inTransaction()) {
+            static::$adapter->getConnection()->rollBack();
+        }
     }
 
     /**

src/Database/Database.php

@@ -4,12 +4,12 @@
 
 use Bow\Event\Contracts\EventListener;
 use Bow\Event\Contracts\EventShouldQueue;
-use Bow\Queue\QueueJob;
+use Bow\Queue\QueueTask;
 
-class EventQueueJob extends QueueJob
+class EventQueueTask extends QueueTask
 {
     /**
-     * EventQueueJob constructor
+     * EventQueueTask constructor
      *
      * @param EventListener|EventShouldQueue $event
      * @param mixed                          $payload

src/Event/EventQueueJob.php src/Event/EventQueueTask.phpsrc/Event/EventQueueJob.php renamed to src/Event/EventQueueTask.php

@@ -50,7 +50,7 @@ public function call(array $data = []): mixed
             $instance = app($callable);
             if ($instance instanceof EventListener) {
                 if ($instance instanceof EventShouldQueue) {
-                    queue(new EventQueueJob($instance, $data));
+                    queue(new EventQueueTask($instance, $data));
                     return null;
                 }
                 $callable = [$instance, 'process'];