Merge pull request #121 from sheldonreiff/make-max-attempts-optional-in-bake-command

Make max attempts optional in bake job command

Author: markstory

docs/en/index.rst

@@ -118,7 +118,7 @@ A simple job that logs received messages would look like::
         use LogTrait;
 
         /**
-         * The maximum number of times the job may be attempted.
+         * The maximum number of times the job may be attempted. (optional property)
          * 
          * @var int|null
          */

src/Command/JobCommand.php

@@ -55,8 +55,11 @@ public function templateData(Arguments $arguments): array
     {
         $parentData = parent::templateData($arguments);
 
+        $maxAttempts = $arguments->getOption('max-attempts');
+
         $data = [
             'isUnique' => $arguments->getOption('unique'),
+            'maxAttempts' => $maxAttempts ? (int)$maxAttempts : null,
         ];
 
         return array_merge($parentData, $data);
@@ -77,6 +80,10 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar
             ->addArgument('name', [
                 'help' => 'The name of the queue job class to create.',
             ])
+            ->addOption('max-attempts', [
+                'help' => 'The maximum number of times the job may be attempted.',
+                'default' => null,
+            ])
             ->addOption('unique', [
                 'help' => 'Whether there should be only one instance of a job on the queue at a time.',
                 'boolean' => true,

templates/bake/job.twig

@@ -27,13 +27,15 @@ use Interop\Queue\Processor;
  */
 class {{ name }}Job implements JobInterface
 {
+{% if maxAttempts %}
     /**
      * The maximum number of times the job may be attempted.
      * 
      * @var int|null
      */
-    public static $maxAttempts = 3;
+    public static $maxAttempts = {{ maxAttempts }};
 
+{% endif %}
 {% if isUnique %}
     /**
      * Whether there should be only one instance of a job on the queue at a time. (optional property)

tests/TestCase/Task/JobTaskTest.php

@@ -86,4 +86,18 @@ public function testMainWithUnique()
             file_get_contents($this->generatedFile)
         );
     }
+
+    public function testMainWithMaxAttempts()
+    {
+        $this->generatedFile = APP . 'Job' . DS . 'UploadJob.php';
+
+        $this->exec('bake job upload --max-attempts 3');
+        $this->assertExitCode(Command::CODE_SUCCESS);
+        $this->assertFileExists($this->generatedFile);
+        $this->assertOutputContains('Creating file ' . $this->generatedFile);
+        $this->assertSameAsFile(
+            $this->comparisonDir . 'JobTaskWithMaxAttempts.php',
+            file_get_contents($this->generatedFile)
+        );
+    }
 }

tests/comparisons/JobTask.php

@@ -12,13 +12,6 @@
  */
 class UploadJob implements JobInterface
 {
-    /**
-     * The maximum number of times the job may be attempted.
-     * 
-     * @var int|null
-     */
-    public static $maxAttempts = 3;
-
     /**
      * Executes logic for UploadJob
      *

tests/comparisons/JobTaskWithMaxAttempts.php

@@ -0,0 +1,32 @@
+<?php
+declare(strict_types=1);
+
+namespace TestApp\Job;
+
+use Cake\Queue\Job\JobInterface;
+use Cake\Queue\Job\Message;
+use Interop\Queue\Processor;
+
+/**
+ * Upload job
+ */
+class UploadJob implements JobInterface
+{
+    /**
+     * The maximum number of times the job may be attempted.
+     * 
+     * @var int|null
+     */
+    public static $maxAttempts = 3;
+
+    /**
+     * Executes logic for UploadJob
+     *
+     * @param \Cake\Queue\Job\Message $message job message
+     * @return string|null
+     */
+    public function execute(Message $message): ?string
+    {
+        return Processor::ACK;
+    }
+}

tests/comparisons/JobTaskWithUnique.php

@@ -12,13 +12,6 @@
  */
 class UploadJob implements JobInterface
 {
-    /**
-     * The maximum number of times the job may be attempted.
-     * 
-     * @var int|null
-     */
-    public static $maxAttempts = 3;
-
     /**
      * Whether there should be only one instance of a job on the queue at a time. (optional property)
      *