From 3ca7eb3a5583d15ab1170c92362d76d0e03c56da Mon Sep 17 00:00:00 2001
From: Kevin Bond <kevinbond@gmail.com>
Date: Fri, 28 Jul 2023 15:02:01 -0400
Subject: [PATCH] [Scheduler] Add `AbstractTriggerDecorator`

---
 src/Symfony/Component/Scheduler/CHANGELOG.md  |  1 +
 .../Trigger/AbstractDecoratedTriggerTest.php  | 40 +++++++++++++++
 .../Trigger/AbstractDecoratedTrigger.php      | 49 +++++++++++++++++++
 .../Scheduler/Trigger/ExcludeTimeTrigger.php  |  3 +-
 .../Scheduler/Trigger/JitterTrigger.php       |  3 +-
 .../Scheduler/Trigger/PeriodicalTrigger.php   |  2 +-
 6 files changed, 95 insertions(+), 3 deletions(-)
 create mode 100644 src/Symfony/Component/Scheduler/Tests/Trigger/AbstractDecoratedTriggerTest.php
 create mode 100644 src/Symfony/Component/Scheduler/Trigger/AbstractDecoratedTrigger.php

diff --git a/src/Symfony/Component/Scheduler/CHANGELOG.md b/src/Symfony/Component/Scheduler/CHANGELOG.md
index a2b7fd057ed1d..982658a2bfafa 100644
--- a/src/Symfony/Component/Scheduler/CHANGELOG.md
+++ b/src/Symfony/Component/Scheduler/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Allow setting timezone of next run date in CronExpressionTrigger
+ * Add `AbstractTriggerDecorator`
 
 6.3
 ---
diff --git a/src/Symfony/Component/Scheduler/Tests/Trigger/AbstractDecoratedTriggerTest.php b/src/Symfony/Component/Scheduler/Tests/Trigger/AbstractDecoratedTriggerTest.php
new file mode 100644
index 0000000000000..331b43be845a2
--- /dev/null
+++ b/src/Symfony/Component/Scheduler/Tests/Trigger/AbstractDecoratedTriggerTest.php
@@ -0,0 +1,40 @@
+<?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\Trigger;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Scheduler\Trigger\ExcludeTimeTrigger;
+use Symfony\Component\Scheduler\Trigger\JitterTrigger;
+use Symfony\Component\Scheduler\Trigger\TriggerInterface;
+
+class AbstractDecoratedTriggerTest extends TestCase
+{
+    public function testCanGetInnerTrigger()
+    {
+        $trigger = new JitterTrigger($inner = $this->createMock(TriggerInterface::class));
+
+        $this->assertSame($inner, $trigger->inner());
+        $this->assertSame([$trigger], iterator_to_array($trigger->decorators()));
+    }
+
+    public function testCanGetNestedInnerTrigger()
+    {
+        $trigger = new ExcludeTimeTrigger(
+            $jitter = new JitterTrigger($inner = $this->createMock(TriggerInterface::class)),
+            new \DateTimeImmutable(),
+            new \DateTimeImmutable(),
+        );
+
+        $this->assertSame($inner, $trigger->inner());
+        $this->assertSame([$trigger, $jitter], iterator_to_array($trigger->decorators()));
+    }
+}
diff --git a/src/Symfony/Component/Scheduler/Trigger/AbstractDecoratedTrigger.php b/src/Symfony/Component/Scheduler/Trigger/AbstractDecoratedTrigger.php
new file mode 100644
index 0000000000000..8ba5047a664d3
--- /dev/null
+++ b/src/Symfony/Component/Scheduler/Trigger/AbstractDecoratedTrigger.php
@@ -0,0 +1,49 @@
+<?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\Trigger;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+abstract class AbstractDecoratedTrigger implements TriggerInterface
+{
+    public function __construct(private TriggerInterface $inner)
+    {
+    }
+
+    final public function inner(): TriggerInterface
+    {
+        $inner = $this->inner;
+
+        while ($inner instanceof self) {
+            $inner = $inner->inner;
+        }
+
+        return $inner;
+    }
+
+    /**
+     * @return \Traversable<self>
+     */
+    final public function decorators(): \Traversable
+    {
+        yield $this;
+
+        $inner = $this->inner;
+
+        while ($inner instanceof self) {
+            yield $inner;
+
+            $inner = $inner->inner;
+        }
+    }
+}
diff --git a/src/Symfony/Component/Scheduler/Trigger/ExcludeTimeTrigger.php b/src/Symfony/Component/Scheduler/Trigger/ExcludeTimeTrigger.php
index 619d3dccb9618..f76275ab01dcf 100644
--- a/src/Symfony/Component/Scheduler/Trigger/ExcludeTimeTrigger.php
+++ b/src/Symfony/Component/Scheduler/Trigger/ExcludeTimeTrigger.php
@@ -14,13 +14,14 @@
 /**
  * @experimental
  */
-final class ExcludeTimeTrigger implements TriggerInterface
+final class ExcludeTimeTrigger extends AbstractDecoratedTrigger
 {
     public function __construct(
         private readonly TriggerInterface $inner,
         private readonly \DateTimeImmutable $from,
         private readonly \DateTimeImmutable $until,
     ) {
+        parent::__construct($inner);
     }
 
     public function __toString(): string
diff --git a/src/Symfony/Component/Scheduler/Trigger/JitterTrigger.php b/src/Symfony/Component/Scheduler/Trigger/JitterTrigger.php
index 639c490c12070..a63c026fbc0cd 100644
--- a/src/Symfony/Component/Scheduler/Trigger/JitterTrigger.php
+++ b/src/Symfony/Component/Scheduler/Trigger/JitterTrigger.php
@@ -14,13 +14,14 @@
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
  */
-final class JitterTrigger implements TriggerInterface
+final class JitterTrigger extends AbstractDecoratedTrigger
 {
     /**
      * @param positive-int $maxSeconds
      */
     public function __construct(private readonly TriggerInterface $trigger, private readonly int $maxSeconds = 60)
     {
+        parent::__construct($trigger);
     }
 
     public function __toString(): string
diff --git a/src/Symfony/Component/Scheduler/Trigger/PeriodicalTrigger.php b/src/Symfony/Component/Scheduler/Trigger/PeriodicalTrigger.php
index b7241c5c35be8..c02315bed1a55 100644
--- a/src/Symfony/Component/Scheduler/Trigger/PeriodicalTrigger.php
+++ b/src/Symfony/Component/Scheduler/Trigger/PeriodicalTrigger.php
@@ -16,7 +16,7 @@
 /**
  * @experimental
  */
-class PeriodicalTrigger implements TriggerInterface, \Stringable
+class PeriodicalTrigger implements TriggerInterface
 {
     private float $intervalInSeconds = 0.0;
     private \DateTimeImmutable $from;

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>pFad - Phonifier reborn</title>
<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
</head>
<body>
<h1>Pfad - The Proxy pFad of &#169; 2024 Garber Painting. All rights reserved.</h1>


<!-- Disclaimer -->
<p>Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.</p>
<br>
<p>Alternative Proxies:</p><p><a href="http://rainy.clevelandohioweatherforecast.com/php-proxy/index.php?q=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/51152.patch" target="_blank">Alternative Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/51152.patch" target="_blank">pFad Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v3index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/51152.patch" target="_blank">pFad v3 Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v4index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/51152.patch" target="_blank">pFad v4 Proxy</a></p></body>
</html>