make $context for RecurringMessage::hashedCron() optional

kbond · kbond · commit ab9ca22ffc98 · 2023-03-29T15:34:43.000-04:00
if `$message` is `\Stringable`.
diff --git a/src/Symfony/Component/Scheduler/RecurringMessage.php b/src/Symfony/Component/Scheduler/RecurringMessage.php
@@ -46,8 +46,16 @@ public static function cron(string $expression, object $message): self
         return new self(CronExpressionTrigger::fromSpec($expression), $message);
     }
 
-    public static function hashedCron(string $expression, string $context, object $message): self
+    public static function hashedCron(string $expression, object $message, string $context = null): self
     {
+        if (!$context && $message instanceof \Stringable) {
+            $context = (string) $message;
+        }
+
+        if (!$context) {
+            throw new InvalidArgumentException('A context must be provided when the message is not a stringable object.');
+        }
+
         return new self(CronExpressionTrigger::fromHash($expression, $context), $message);
     }
 
diff --git a/src/Symfony/Component/Scheduler/Tests/RecurringMessageTest.php b/src/Symfony/Component/Scheduler/Tests/RecurringMessageTest.php
@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Scheduler\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Scheduler\RecurringMessage;
+
+class RecurringMessageTest extends TestCase
+{
+    public function testCanCreateHashedCronMessage()
+    {
+        $object = new class() {
+            public function __toString(): string
+            {
+                return 'my task';
+            }
+        };
+
+        $this->assertSame('56 2 * * *', (string) RecurringMessage::hashedCron('#midnight', $object)->getTrigger());
+        $this->assertSame('3 0 * * *', (string) RecurringMessage::hashedCron('#midnight', $object, 'context')->getTrigger());
+    }
+
+    public function testHashedCronContextIsRequiredIfMessageIsNotStringable()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+
+        RecurringMessage::hashedCron('#midnight', new \stdClass());
+    }
+}
diff --git a/src/Symfony/Component/Scheduler/Tests/Trigger/CronExpressionTriggerTest.php b/src/Symfony/Component/Scheduler/Tests/Trigger/CronExpressionTriggerTest.php
@@ -14,7 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Scheduler\Trigger\CronExpressionTrigger;
 
-final class CronExpressionTriggerTest extends TestCase
+class CronExpressionTriggerTest extends TestCase
 {
     /**
      * @dataProvider hashedExpressionProvider
@@ -25,7 +25,7 @@ public function testHashedExpressionParsing(string $input, string $expected)
         $triggerB = CronExpressionTrigger::fromHash($input, 'my task');
         $triggerC = CronExpressionTrigger::fromHash($input, 'another task');
 
-        $this->assertSame('cron: '.$expected, (string) $triggerA);
+        $this->assertSame($expected, (string) $triggerA);
         $this->assertSame((string) $triggerB, (string) $triggerA);
         $this->assertNotSame((string) $triggerC, (string) $triggerA);
     }
@@ -59,7 +59,7 @@ public static function hashedExpressionProvider(): array
 
     public function testFromHashWithStandardExpression()
     {
-        $this->assertSame('cron: 56 20 1 9 0', (string) CronExpressionTrigger::fromHash('56 20 1 9 0', 'some context'));
-        $this->assertSame('cron: 0 0 * * *', (string) CronExpressionTrigger::fromHash('@daily', 'some context'));
+        $this->assertSame('56 20 1 9 0', (string) CronExpressionTrigger::fromHash('56 20 1 9 0', 'some context'));
+        $this->assertSame('0 0 * * *', (string) CronExpressionTrigger::fromHash('@daily', 'some context'));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -46,8 +46,16 @@ public static function cron(string $expression, object $message): self`
`46`	`46`	`return new self(CronExpressionTrigger::fromSpec($expression), $message);`
`47`	`47`	`}`
`48`	`48`
`49`		`- public static function hashedCron(string $expression, string $context, object $message): self`
	`49`	`+ public static function hashedCron(string $expression, object $message, string $context = null): self`
`50`	`50`	`{`
	`51`	`+ if (!$context && $message instanceof \Stringable) {`
	`52`	`+ $context = (string) $message;`
	`53`	`+ }`
	`54`	`+`
	`55`	`+ if (!$context) {`
	`56`	`+ throw new InvalidArgumentException('A context must be provided when the message is not a stringable object.');`
	`57`	`+ }`
	`58`	`+`
`51`	`59`	`return new self(CronExpressionTrigger::fromHash($expression, $context), $message);`
`52`	`60`	`}`
`53`	`61`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`use PHPUnit\Framework\TestCase;`
`15`	`15`	`use Symfony\Component\Scheduler\Trigger\CronExpressionTrigger;`
`16`	`16`
`17`		`-final class CronExpressionTriggerTest extends TestCase`
	`17`	`+class CronExpressionTriggerTest extends TestCase`
`18`	`18`	`{`
`19`	`19`	`/**`
`20`	`20`	`* @dataProvider hashedExpressionProvider`
`@@ -25,7 +25,7 @@ public function testHashedExpressionParsing(string $input, string $expected)`
`25`	`25`	`$triggerB = CronExpressionTrigger::fromHash($input, 'my task');`
`26`	`26`	`$triggerC = CronExpressionTrigger::fromHash($input, 'another task');`
`27`	`27`
`28`		`- $this->assertSame('cron: '.$expected, (string) $triggerA);`
	`28`	`+ $this->assertSame($expected, (string) $triggerA);`
`29`	`29`	`$this->assertSame((string) $triggerB, (string) $triggerA);`
`30`	`30`	`$this->assertNotSame((string) $triggerC, (string) $triggerA);`
`31`	`31`	`}`
`@@ -59,7 +59,7 @@ public static function hashedExpressionProvider(): array`
`59`	`59`
`60`	`60`	`public function testFromHashWithStandardExpression()`
`61`	`61`	`{`
`62`		`- $this->assertSame('cron: 56 20 1 9 0', (string) CronExpressionTrigger::fromHash('56 20 1 9 0', 'some context'));`
`63`		`- $this->assertSame('cron: 0 0 * * *', (string) CronExpressionTrigger::fromHash('@daily', 'some context'));`
	`62`	`+ $this->assertSame('56 20 1 9 0', (string) CronExpressionTrigger::fromHash('56 20 1 9 0', 'some context'));`
	`63`	`+ $this->assertSame('0 0 * * *', (string) CronExpressionTrigger::fromHash('@daily', 'some context'));`
`64`	`64`	`}`
`65`	`65`	`}`