Improve string representation of IssueTrigger value object

sebastianbergmann · sebastianbergmann · commit f2ebdc585c7d · 2024-03-19T08:06:43.000+01:00
diff --git a/src/Event/Value/Test/Issue/DirectTrigger.php b/src/Event/Value/Test/Issue/DirectTrigger.php
@@ -28,6 +28,6 @@ public function isDirect(): true
 
     public function asString(): string
     {
-        return 'first-party code triggered issue in third-party code';
+        return 'issue triggered by first-party code calling into third-party code';
     }
 }
diff --git a/src/Event/Value/Test/Issue/IndirectTrigger.php b/src/Event/Value/Test/Issue/IndirectTrigger.php
@@ -28,6 +28,6 @@ public function isIndirect(): true
 
     public function asString(): string
     {
-        return 'third-party code triggered issue in third-party code';
+        return 'issue triggered by third-party code';
     }
 }
diff --git a/src/Event/Value/Test/Issue/SelfTrigger.php b/src/Event/Value/Test/Issue/SelfTrigger.php
@@ -28,6 +28,6 @@ public function isSelf(): true
 
     public function asString(): string
     {
-        return 'first-party code triggered issue in first-party code';
+        return 'issue triggered by first-party code calling into first-party code';
     }
 }
diff --git a/src/Event/Value/Test/Issue/UnknownTrigger.php b/src/Event/Value/Test/Issue/UnknownTrigger.php
@@ -26,6 +26,6 @@ public function isUnknown(): true
 
     public function asString(): string
     {
-        return 'unknown whether this issue was triggered in first-party or third-party code';
+        return 'unknown if issue was triggered in first-party code or third-party code';
     }
 }
diff --git a/tests/end-to-end/cli/fail-on/fail-on-deprecation.phpt b/tests/end-to-end/cli/fail-on/fail-on-deprecation.phpt
@@ -30,7 +30,7 @@ Test Runner Execution Started (2 tests)
 Test Suite Started (PHPUnit\TestFixture\TestRunnerStopping\DeprecationTest, 2 tests)
 Test Preparation Started (PHPUnit\TestFixture\TestRunnerStopping\DeprecationTest::testOne)
 Test Prepared (PHPUnit\TestFixture\TestRunnerStopping\DeprecationTest::testOne)
-Test Triggered Deprecation (PHPUnit\TestFixture\TestRunnerStopping\DeprecationTest::testOne, unknown whether this issue was triggered in first-party or third-party code)
+Test Triggered Deprecation (PHPUnit\TestFixture\TestRunnerStopping\DeprecationTest::testOne, unknown if issue was triggered in first-party code or third-party code)
 message
 Test Passed (PHPUnit\TestFixture\TestRunnerStopping\DeprecationTest::testOne)
 Test Finished (PHPUnit\TestFixture\TestRunnerStopping\DeprecationTest::testOne)
diff --git a/tests/end-to-end/cli/stop-on/stop-on-deprecation.phpt b/tests/end-to-end/cli/stop-on/stop-on-deprecation.phpt
@@ -30,7 +30,7 @@ Test Runner Execution Started (2 tests)
 Test Suite Started (PHPUnit\TestFixture\TestRunnerStopping\DeprecationTest, 2 tests)
 Test Preparation Started (PHPUnit\TestFixture\TestRunnerStopping\DeprecationTest::testOne)
 Test Prepared (PHPUnit\TestFixture\TestRunnerStopping\DeprecationTest::testOne)
-Test Triggered Deprecation (PHPUnit\TestFixture\TestRunnerStopping\DeprecationTest::testOne, unknown whether this issue was triggered in first-party or third-party code)
+Test Triggered Deprecation (PHPUnit\TestFixture\TestRunnerStopping\DeprecationTest::testOne, unknown if issue was triggered in first-party code or third-party code)
 message
 Test Passed (PHPUnit\TestFixture\TestRunnerStopping\DeprecationTest::testOne)
 Test Finished (PHPUnit\TestFixture\TestRunnerStopping\DeprecationTest::testOne)
diff --git a/tests/end-to-end/event/deprecations-can-be-ignored-using-attribute.phpt b/tests/end-to-end/event/deprecations-can-be-ignored-using-attribute.phpt
@@ -29,25 +29,25 @@ Test Runner Execution Started (4 tests)
 Test Suite Started (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest, 4 tests)
 Test Preparation Started (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOne)
 Test Prepared (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOne)
-Test Triggered Deprecation (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOne, unknown whether this issue was triggered in first-party or third-party code, ignored by test)
+Test Triggered Deprecation (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOne, unknown if issue was triggered in first-party code or third-party code, ignored by test)
 message
 Test Passed (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOne)
 Test Finished (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOne)
 Test Preparation Started (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testTwo)
 Test Prepared (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testTwo)
-Test Triggered Deprecation (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testTwo, unknown whether this issue was triggered in first-party or third-party code)
+Test Triggered Deprecation (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testTwo, unknown if issue was triggered in first-party code or third-party code)
 message
 Test Passed (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testTwo)
 Test Finished (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testTwo)
 Test Preparation Started (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOneErrorGetLast)
 Test Prepared (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOneErrorGetLast)
-Test Triggered Deprecation (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOneErrorGetLast, unknown whether this issue was triggered in first-party or third-party code, ignored by test)
+Test Triggered Deprecation (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOneErrorGetLast, unknown if issue was triggered in first-party code or third-party code, ignored by test)
 message
 Test Passed (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOneErrorGetLast)
 Test Finished (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOneErrorGetLast)
 Test Preparation Started (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testTwoErrorGetLast)
 Test Prepared (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testTwoErrorGetLast)
-Test Triggered Deprecation (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testTwoErrorGetLast, unknown whether this issue was triggered in first-party or third-party code)
+Test Triggered Deprecation (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testTwoErrorGetLast, unknown if issue was triggered in first-party code or third-party code)
 message
 Test Passed (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testTwoErrorGetLast)
 Test Finished (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testTwoErrorGetLast)
diff --git a/tests/end-to-end/event/php-deprecated.phpt b/tests/end-to-end/event/php-deprecated.phpt
@@ -32,9 +32,9 @@ Test Runner Execution Started (1 test)
 Test Suite Started (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest, 1 test)
 Test Preparation Started (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature)
 Test Prepared (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature)
-Test Triggered PHP Deprecation (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature, unknown whether this issue was triggered in first-party or third-party code)
+Test Triggered PHP Deprecation (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature, unknown if issue was triggered in first-party code or third-party code)
 strlen(): Passing null to parameter #1 ($string) of type string is deprecated
-Test Triggered PHP Deprecation (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature, unknown whether this issue was triggered in first-party or third-party code, suppressed using operator)
+Test Triggered PHP Deprecation (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature, unknown if issue was triggered in first-party code or third-party code, suppressed using operator)
 strlen(): Passing null to parameter #1 ($string) of type string is deprecated
 Test Passed (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature)
 Test Finished (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature)
diff --git a/tests/end-to-end/event/user-deprecated.phpt b/tests/end-to-end/event/user-deprecated.phpt
@@ -29,15 +29,15 @@ Test Runner Execution Started (2 tests)
 Test Suite Started (PHPUnit\TestFixture\Event\DeprecatedFeatureTest, 2 tests)
 Test Preparation Started (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature)
 Test Prepared (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature)
-Test Triggered Deprecation (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature, unknown whether this issue was triggered in first-party or third-party code)
+Test Triggered Deprecation (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature, unknown if issue was triggered in first-party code or third-party code)
 message
-Test Triggered Deprecation (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature, unknown whether this issue was triggered in first-party or third-party code, suppressed using operator)
+Test Triggered Deprecation (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature, unknown if issue was triggered in first-party code or third-party code, suppressed using operator)
 message
 Test Passed (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature)
 Test Finished (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature)
 Test Preparation Started (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedSuppressedErrorGetLast)
 Test Prepared (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedSuppressedErrorGetLast)
-Test Triggered Deprecation (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedSuppressedErrorGetLast, unknown whether this issue was triggered in first-party or third-party code, suppressed using operator)
+Test Triggered Deprecation (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedSuppressedErrorGetLast, unknown if issue was triggered in first-party code or third-party code, suppressed using operator)
 message
 Test Passed (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedSuppressedErrorGetLast)
 Test Finished (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedSuppressedErrorGetLast)
diff --git a/tests/unit/Event/Events/Test/Issue/DeprecationTriggeredTest.php b/tests/unit/Event/Events/Test/Issue/DeprecationTriggeredTest.php
@@ -51,7 +51,7 @@ public function testConstructorSetsValues(): void
         $this->assertSame($suppressed, $event->wasSuppressed());
         $this->assertSame($ignoredByBaseline, $event->ignoredByBaseline());
         $this->assertSame($ignoredByTest, $event->ignoredByTest());
-        $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown whether this issue was triggered in first-party or third-party code)' . PHP_EOL . 'message', $event->asString());
+        $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown if issue was triggered in first-party code or third-party code)' . PHP_EOL . 'message', $event->asString());
         $this->assertSame($trigger, $event->trigger());
     }
 
@@ -70,7 +70,7 @@ public function testCanBeIgnoredByBaseline(): void
         );
 
         $this->assertTrue($event->ignoredByBaseline());
-        $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown whether this issue was triggered in first-party or third-party code, ignored by baseline)' . PHP_EOL . 'message', $event->asString());
+        $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown if issue was triggered in first-party code or third-party code, ignored by baseline)' . PHP_EOL . 'message', $event->asString());
     }
 
     public function testCanBeIgnoredByTest(): void
@@ -88,7 +88,7 @@ public function testCanBeIgnoredByTest(): void
         );
 
         $this->assertTrue($event->ignoredByTest());
-        $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown whether this issue was triggered in first-party or third-party code, ignored by test)' . PHP_EOL . 'message', $event->asString());
+        $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown if issue was triggered in first-party code or third-party code, ignored by test)' . PHP_EOL . 'message', $event->asString());
     }
 
     public function testCanBeSuppressed(): void
@@ -106,6 +106,6 @@ public function testCanBeSuppressed(): void
         );
 
         $this->assertTrue($event->wasSuppressed());
-        $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown whether this issue was triggered in first-party or third-party code, suppressed using operator)' . PHP_EOL . 'message', $event->asString());
+        $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown if issue was triggered in first-party code or third-party code, suppressed using operator)' . PHP_EOL . 'message', $event->asString());
     }
 }
diff --git a/tests/unit/Event/Events/Test/Issue/PhpDeprecationTriggeredTest.php b/tests/unit/Event/Events/Test/Issue/PhpDeprecationTriggeredTest.php
@@ -51,7 +51,7 @@ public function testConstructorSetsValues(): void
         $this->assertSame($suppressed, $event->wasSuppressed());
         $this->assertSame($ignoredByBaseline, $event->ignoredByBaseline());
         $this->assertSame($ignoredByTest, $event->ignoredByTest());
-        $this->assertSame('Test Triggered PHP Deprecation (FooTest::testBar, unknown whether this issue was triggered in first-party or third-party code)' . PHP_EOL . 'message', $event->asString());
+        $this->assertSame('Test Triggered PHP Deprecation (FooTest::testBar, unknown if issue was triggered in first-party code or third-party code)' . PHP_EOL . 'message', $event->asString());
         $this->assertSame($trigger, $event->trigger());
     }
 
@@ -70,7 +70,7 @@ public function testCanBeIgnoredByBaseline(): void
         );
 
         $this->assertTrue($event->ignoredByBaseline());
-        $this->assertSame('Test Triggered PHP Deprecation (FooTest::testBar, unknown whether this issue was triggered in first-party or third-party code, ignored by baseline)' . PHP_EOL . 'message', $event->asString());
+        $this->assertSame('Test Triggered PHP Deprecation (FooTest::testBar, unknown if issue was triggered in first-party code or third-party code, ignored by baseline)' . PHP_EOL . 'message', $event->asString());
     }
 
     public function testCanBeIgnoredByTest(): void
@@ -88,7 +88,7 @@ public function testCanBeIgnoredByTest(): void
         );
 
         $this->assertTrue($event->ignoredByTest());
-        $this->assertSame('Test Triggered PHP Deprecation (FooTest::testBar, unknown whether this issue was triggered in first-party or third-party code, ignored by test)' . PHP_EOL . 'message', $event->asString());
+        $this->assertSame('Test Triggered PHP Deprecation (FooTest::testBar, unknown if issue was triggered in first-party code or third-party code, ignored by test)' . PHP_EOL . 'message', $event->asString());
     }
 
     public function testCanBeSuppressed(): void
@@ -106,6 +106,6 @@ public function testCanBeSuppressed(): void
         );
 
         $this->assertTrue($event->wasSuppressed());
-        $this->assertSame('Test Triggered PHP Deprecation (FooTest::testBar, unknown whether this issue was triggered in first-party or third-party code, suppressed using operator)' . PHP_EOL . 'message', $event->asString());
+        $this->assertSame('Test Triggered PHP Deprecation (FooTest::testBar, unknown if issue was triggered in first-party code or third-party code, suppressed using operator)' . PHP_EOL . 'message', $event->asString());
     }
 }
diff --git a/tests/unit/Event/Value/Test/IssueTriggerTest.php b/tests/unit/Event/Value/Test/IssueTriggerTest.php
@@ -28,7 +28,7 @@ public function testCanBeSelf(): void
         $this->assertFalse($trigger->isDirect());
         $this->assertFalse($trigger->isIndirect());
         $this->assertFalse($trigger->isUnknown());
-        $this->assertSame('first-party code triggered issue in first-party code', $trigger->asString());
+        $this->assertSame('issue triggered by first-party code calling into first-party code', $trigger->asString());
     }
 
     public function testCanBeDirect(): void
@@ -39,7 +39,7 @@ public function testCanBeDirect(): void
         $this->assertFalse($trigger->isSelf());
         $this->assertFalse($trigger->isIndirect());
         $this->assertFalse($trigger->isUnknown());
-        $this->assertSame('first-party code triggered issue in third-party code', $trigger->asString());
+        $this->assertSame('issue triggered by first-party code calling into third-party code', $trigger->asString());
     }
 
     public function testCanBeIndirect(): void
@@ -50,7 +50,7 @@ public function testCanBeIndirect(): void
         $this->assertFalse($trigger->isSelf());
         $this->assertFalse($trigger->isDirect());
         $this->assertFalse($trigger->isUnknown());
-        $this->assertSame('third-party code triggered issue in third-party code', $trigger->asString());
+        $this->assertSame('issue triggered by third-party code', $trigger->asString());
     }
 
     public function testCanBeUnknown(): void
@@ -61,6 +61,6 @@ public function testCanBeUnknown(): void
         $this->assertFalse($trigger->isDirect());
         $this->assertFalse($trigger->isIndirect());
         $this->assertTrue($trigger->isUnknown());
-        $this->assertSame('unknown whether this issue was triggered in first-party or third-party code', $trigger->asString());
+        $this->assertSame('unknown if issue was triggered in first-party code or third-party code', $trigger->asString());
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,6 @@ public function isDirect(): true`
`28`	`28`
`29`	`29`	`public function asString(): string`
`30`	`30`	`{`
`31`		`- return 'first-party code triggered issue in third-party code';`
	`31`	`+ return 'issue triggered by first-party code calling into third-party code';`
`32`	`32`	`}`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,6 @@ public function isIndirect(): true`
`28`	`28`
`29`	`29`	`public function asString(): string`
`30`	`30`	`{`
`31`		`- return 'third-party code triggered issue in third-party code';`
	`31`	`+ return 'issue triggered by third-party code';`
`32`	`32`	`}`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,6 @@ public function isSelf(): true`
`28`	`28`
`29`	`29`	`public function asString(): string`
`30`	`30`	`{`
`31`		`- return 'first-party code triggered issue in first-party code';`
	`31`	`+ return 'issue triggered by first-party code calling into first-party code';`
`32`	`32`	`}`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,6 @@ public function isUnknown(): true`
`26`	`26`
`27`	`27`	`public function asString(): string`
`28`	`28`	`{`
`29`		`- return 'unknown whether this issue was triggered in first-party or third-party code';`
	`29`	`+ return 'unknown if issue was triggered in first-party code or third-party code';`
`30`	`30`	`}`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public function testConstructorSetsValues(): void`
`51`	`51`	`$this->assertSame($suppressed, $event->wasSuppressed());`
`52`	`52`	`$this->assertSame($ignoredByBaseline, $event->ignoredByBaseline());`
`53`	`53`	`$this->assertSame($ignoredByTest, $event->ignoredByTest());`
`54`		`- $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown whether this issue was triggered in first-party or third-party code)' . PHP_EOL . 'message', $event->asString());`
	`54`	`+ $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown if issue was triggered in first-party code or third-party code)' . PHP_EOL . 'message', $event->asString());`
`55`	`55`	`$this->assertSame($trigger, $event->trigger());`
`56`	`56`	`}`
`57`	`57`
`@@ -70,7 +70,7 @@ public function testCanBeIgnoredByBaseline(): void`
`70`	`70`	`);`
`71`	`71`
`72`	`72`	`$this->assertTrue($event->ignoredByBaseline());`
`73`		`- $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown whether this issue was triggered in first-party or third-party code, ignored by baseline)' . PHP_EOL . 'message', $event->asString());`
	`73`	`+ $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown if issue was triggered in first-party code or third-party code, ignored by baseline)' . PHP_EOL . 'message', $event->asString());`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`public function testCanBeIgnoredByTest(): void`
`@@ -88,7 +88,7 @@ public function testCanBeIgnoredByTest(): void`
`88`	`88`	`);`
`89`	`89`
`90`	`90`	`$this->assertTrue($event->ignoredByTest());`
`91`		`- $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown whether this issue was triggered in first-party or third-party code, ignored by test)' . PHP_EOL . 'message', $event->asString());`
	`91`	`+ $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown if issue was triggered in first-party code or third-party code, ignored by test)' . PHP_EOL . 'message', $event->asString());`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	`public function testCanBeSuppressed(): void`
`@@ -106,6 +106,6 @@ public function testCanBeSuppressed(): void`
`106`	`106`	`);`
`107`	`107`
`108`	`108`	`$this->assertTrue($event->wasSuppressed());`
`109`		`- $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown whether this issue was triggered in first-party or third-party code, suppressed using operator)' . PHP_EOL . 'message', $event->asString());`
	`109`	`+ $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown if issue was triggered in first-party code or third-party code, suppressed using operator)' . PHP_EOL . 'message', $event->asString());`
`110`	`110`	`}`
`111`	`111`	`}`