Cleanup throws annotations

Author: spawnia

CHANGELOG.md

@@ -9,6 +9,12 @@ You can find and compare releases at the [GitHub release page](https://github.co
 
 ## Unreleased
 
+## 4.1.0
+
+### Changed
+
+- Improve error message when values can not be coerced into strings
+
 ## 4.0.0
 
 ### Added

src/Utils.php

@@ -44,19 +44,21 @@ public static function extractStringFromLiteral(Node $valueNode): string
     }
 
     /**
-     * Convert the value to a string and throw an exception if it is not possible.
+     * Convert the value to a string or throw.
      *
+     * @template T of \Throwable
      * @param mixed $value Any value
+     * @param class-string<T> $exceptionClass
      *
-     * @throws \Exception of type $exceptionClass
+     * @throws T
      */
     public static function coerceToString($value, string $exceptionClass): string
     {
         if (!self::canBeString($value)) {
             $safeValue = GraphQLUtils::printSafeJson($value);
 
             throw new $exceptionClass(
-                "The given value {$safeValue} can not be serialized."
+                "The given value {$safeValue} can not be coerced to a string."
             );
         }
 

tests/EmailTest.php

@@ -15,7 +15,7 @@ class EmailTest extends TestCase
     public function testSerializeThrowsIfUnserializableValueIsGiven(): void
     {
         $this->expectException(InvariantViolation::class);
-        $this->expectExceptionMessageMatches(/** @lang RegExp */ '/^The given value .* can not be serialized\./');
+        $this->expectExceptionMessageMatches(/** @lang RegExp */ '/^The given value .* can not be coerced to a string\./');
 
         (new Email())->serialize(
             new class() {

tests/MyRegex.php

@@ -10,9 +10,6 @@ class MyRegex extends Regex
 {
     public $description = 'Bar';
 
-    /**
-     * Return the Regex that the values are validated against.
-     */
     public static function regex(): string
     {
         return /** @lang RegExp */'/foo/';

tests/MyStringScalar.php

@@ -10,9 +10,6 @@ class MyStringScalar extends StringScalar
 {
     public $description = 'Bar';
 
-    /**
-     * Check if the given string is exactly "foo".
-     */
     protected function isValid(string $stringValue): bool
     {
         return $stringValue === 'foo';

tests/RegexTest.php

@@ -113,22 +113,18 @@ public function __toString(): string
 
     /**
      * @dataProvider regexClassProvider
-     *
-     * @throws Error
      */
     public function testParseValueThrowsIfValueCantBeString(Regex $regex): void
     {
         $this->expectException(Error::class);
-        $this->expectExceptionMessageMatches(/** @lang RegExp */'/can not be serialized/');
+        $this->expectExceptionMessageMatches(/** @lang RegExp */'/can not be coerced to a string/');
 
         $regex->parseValue(new class() {
         });
     }
 
     /**
      * @dataProvider regexClassProvider
-     *
-     * @throws Error
      */
     public function testParseValueThrowsIfValueDoesNotMatch(Regex $regex): void
     {
@@ -140,8 +136,6 @@ public function testParseValueThrowsIfValueDoesNotMatch(Regex $regex): void
 
     /**
      * @dataProvider regexClassProvider
-     *
-     * @throws Error
      */
     public function testParseValuePassesOnMatch(Regex $regex): void
     {
@@ -153,8 +147,6 @@ public function testParseValuePassesOnMatch(Regex $regex): void
 
     /**
      * @dataProvider regexClassProvider
-     *
-     * @throws Error
      */
     public function testParseLiteralThrowsIfNotString(Regex $regex): void
     {
@@ -166,8 +158,6 @@ public function testParseLiteralThrowsIfNotString(Regex $regex): void
 
     /**
      * @dataProvider regexClassProvider
-     *
-     * @throws Error
      */
     public function testParseLiteralThrowsIfValueDoesNotMatch(Regex $regex): void
     {
@@ -179,8 +169,6 @@ public function testParseLiteralThrowsIfValueDoesNotMatch(Regex $regex): void
 
     /**
      * @dataProvider regexClassProvider
-     *
-     * @throws Error
      */
     public function testParseLiteralPassesOnMatch(Regex $regex): void
     {

tests/StringScalarTest.php

@@ -119,22 +119,18 @@ public function __toString(): string
 
     /**
      * @dataProvider stringClassProvider
-     *
-     * @throws Error
      */
     public function testParseValueThrowsIfValueCantBeString(StringScalar $stringScalar): void
     {
         $this->expectException(Error::class);
-        $this->expectExceptionMessageMatches(/** @lang RegExp */'/can not be serialized/');
+        $this->expectExceptionMessageMatches(/** @lang RegExp */'/can not be coerced to a string/');
 
         $stringScalar->parseValue(new class() {
         });
     }
 
     /**
      * @dataProvider stringClassProvider
-     *
-     * @throws Error
      */
     public function testParseValueThrowsIfValueDoesNotMatch(StringScalar $stringScalar): void
     {
@@ -146,8 +142,6 @@ public function testParseValueThrowsIfValueDoesNotMatch(StringScalar $stringScal
 
     /**
      * @dataProvider stringClassProvider
-     *
-     * @throws Error
      */
     public function testParseValuePassesOnMatch(StringScalar $stringScalar): void
     {
@@ -159,8 +153,6 @@ public function testParseValuePassesOnMatch(StringScalar $stringScalar): void
 
     /**
      * @dataProvider stringClassProvider
-     *
-     * @throws Error
      */
     public function testParseLiteralThrowsIfNotString(StringScalar $stringScalar): void
     {
@@ -172,8 +164,6 @@ public function testParseLiteralThrowsIfNotString(StringScalar $stringScalar): v
 
     /**
      * @dataProvider stringClassProvider
-     *
-     * @throws Error
      */
     public function testParseLiteralThrowsIfValueDoesNotMatch(StringScalar $stringScalar): void
     {
@@ -185,8 +175,6 @@ public function testParseLiteralThrowsIfValueDoesNotMatch(StringScalar $stringSc
 
     /**
      * @dataProvider stringClassProvider
-     *
-     * @throws Error
      */
     public function testParseLiteralPassesOnMatch(StringScalar $stringScalar): void
     {