Initial work on value object for representing issue triggers

Author: sebastianbergmann

src/Event/Value/Test/Issue/DirectTrigger.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Event\Code\DeprecationTrigger;
+
+/**
+ * @psalm-immutable
+ *
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ */
+final class DirectTrigger extends IssueTrigger
+{
+    /**
+     * Your own code triggers an issue in your own code.
+     *
+     * @psalm-assert-if-true DirectTrigger $this
+     */
+    public function isDirect(): true
+    {
+        return true;
+    }
+}

src/Event/Value/Test/Issue/IndirectTrigger.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Event\Code\DeprecationTrigger;
+
+/**
+ * @psalm-immutable
+ *
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ */
+final class IndirectTrigger extends IssueTrigger
+{
+    /**
+     * Your own code triggers an issue in your own code.
+     *
+     * @psalm-assert-if-true IndirectTrigger $this
+     */
+    public function isIndirect(): true
+    {
+        return true;
+    }
+}

src/Event/Value/Test/Issue/IssueTrigger.php

@@ -0,0 +1,67 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Event\Code\DeprecationTrigger;
+
+/**
+ * @psalm-immutable
+ *
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ */
+abstract class IssueTrigger
+{
+    public static function self(): SelfTrigger
+    {
+        return new SelfTrigger;
+    }
+
+    public static function direct(): DirectTrigger
+    {
+        return new DirectTrigger;
+    }
+
+    public static function indirect(): IndirectTrigger
+    {
+        return new IndirectTrigger;
+    }
+
+    final private function __construct()
+    {
+    }
+
+    /**
+     * Your own code triggers an issue in your own code.
+     *
+     * @psalm-assert-if-true SelfTrigger $this
+     */
+    public function isSelf(): bool
+    {
+        return false;
+    }
+
+    /**
+     * Your own code triggers an issue in third-party code.
+     *
+     * @psalm-assert-if-true DirectTrigger $this
+     */
+    public function isDirect(): bool
+    {
+        return false;
+    }
+
+    /**
+     * Third-party code triggers an issue either in your own code or in third-party code.
+     *
+     * @psalm-assert-if-true IndirectTrigger $this
+     */
+    public function isIndirect(): bool
+    {
+        return false;
+    }
+}

src/Event/Value/Test/Issue/SelfTrigger.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Event\Code\DeprecationTrigger;
+
+/**
+ * @psalm-immutable
+ *
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ */
+final class SelfTrigger extends IssueTrigger
+{
+    /**
+     * Your own code triggers an issue in your own code.
+     *
+     * @psalm-assert-if-true SelfTrigger $this
+     */
+    public function isSelf(): true
+    {
+        return true;
+    }
+}

tests/unit/Event/Value/Test/IssueTriggerTest.php

@@ -0,0 +1,48 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Event\Code\DeprecationTrigger;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Small;
+use PHPUnit\Framework\TestCase;
+
+#[CoversClass(SelfTrigger::class)]
+#[CoversClass(DirectTrigger::class)]
+#[CoversClass(IndirectTrigger::class)]
+#[Small]
+final class IssueTriggerTest extends TestCase
+{
+    public function testCanBeSelf(): void
+    {
+        $trigger = IssueTrigger::self();
+
+        $this->assertTrue($trigger->isSelf());
+        $this->assertFalse($trigger->isDirect());
+        $this->assertFalse($trigger->isIndirect());
+    }
+
+    public function testCanBeDirect(): void
+    {
+        $trigger = IssueTrigger::direct();
+
+        $this->assertTrue($trigger->isDirect());
+        $this->assertFalse($trigger->isSelf());
+        $this->assertFalse($trigger->isIndirect());
+    }
+
+    public function testCanBeIndirect(): void
+    {
+        $trigger = IssueTrigger::indirect();
+
+        $this->assertTrue($trigger->isIndirect());
+        $this->assertFalse($trigger->isSelf());
+        $this->assertFalse($trigger->isDirect());
+    }
+}