Level up PHPStan to the max

Author: spawnia

phpstan.neon

@@ -1,5 +1,5 @@
 parameters:
-  level: 4
+  level: max
   paths:
   - src
   - tests

src/Email.php

@@ -9,16 +9,8 @@
 
 class Email extends StringScalar
 {
-    /**
-     * The description that is used for schema introspection.
-     *
-     * @var string
-     */
     public $description = 'A [RFC 5321](https://tools.ietf.org/html/rfc5321) compliant email.';
 
-    /**
-     * Check if the given string is a valid email.
-     */
     protected function isValid(string $stringValue): bool
     {
         return (new EmailValidator())->isValid(

src/JSON.php

@@ -4,52 +4,25 @@
 
 namespace MLL\GraphQLScalars;
 
-use Exception;
 use GraphQL\Error\Error;
-use GraphQL\Language\AST\Node;
 use GraphQL\Type\Definition\ScalarType;
 use GraphQL\Utils\Utils as GraphQLUtils;
 use Safe\Exceptions\JsonException;
 
 class JSON extends ScalarType
 {
-    /**
-     * The description that is used for schema introspection.
-     *
-     * @var string
-     */
     public $description = 'Arbitrary data encoded in JavaScript Object Notation. See https://www.json.org/.';
 
-    /**
-     * Serializes an internal value to include in a response.
-     */
     public function serialize($value): string
     {
         return \Safe\json_encode($value);
     }
 
-    /**
-     * Parses an externally provided value (query variable) to use as an input.
-     *
-     * In the case of an invalid value this method must throw an Exception
-     *
-     * @throws Error
-     */
     public function parseValue($value)
     {
         return $this->decodeJSON($value);
     }
 
-    /**
-     * Parses an externally provided literal value (hardcoded in GraphQL query) to use as an input.
-     *
-     * In the case of an invalid node or value this method must throw an Exception
-     *
-     * @param Node $valueNode
-     * @param mixed[]|null $variables
-     *
-     * @throws Exception
-     */
     public function parseLiteral($valueNode, ?array $variables = null)
     {
         if (!property_exists($valueNode, 'value')) {
@@ -62,20 +35,23 @@ public function parseLiteral($valueNode, ?array $variables = null)
     }
 
     /**
-     * Try to decode a user-given value into JSON.
+     * Try to decode a user-given JSON value.
+     *
+     * @param mixed $value A user given JSON
+     * @return mixed The decoded value
      *
      * @throws Error
      */
     protected function decodeJSON($value)
     {
         try {
-            $parsed = \Safe\json_decode($value);
+            $decoded = \Safe\json_decode($value);
         } catch (JsonException $jsonException) {
             throw new Error(
                 $jsonException->getMessage()
             );
         }
 
-        return $parsed;
+        return $decoded;
     }
 }

src/Mixed.php

@@ -4,7 +4,6 @@
 
 namespace MLL\GraphQLScalars;
 
-use GraphQL\Language\AST\Node;
 use GraphQL\Type\Definition\ScalarType;
 use GraphQL\Utils\AST;
 
@@ -21,34 +20,16 @@ class Mixed extends ScalarType
 dealing with really large numbers to be on the safe side.
 DESCRIPTION;
 
-    /**
-     * Serializes an internal value to include in a response.
-     */
     public function serialize($value)
     {
         return $value;
     }
 
-    /**
-     * Parses an externally provided value (query variable) to use as an input.
-     *
-     * In the case of an invalid value this method must throw an Exception
-     */
     public function parseValue($value)
     {
         return $value;
     }
 
-    /**
-     * Parses an externally provided literal value (hardcoded in GraphQL query) to use as an input.
-     *
-     * In the case of an invalid node or value, this method must throw an Exception.
-     *
-     * @param Node $valueNode
-     * @param mixed[]|null $variables
-     *
-     * @throws \Exception
-     */
     public function parseLiteral($valueNode, ?array $variables = null)
     {
         return AST::valueFromASTUntyped($valueNode);

src/Regex.php

@@ -6,7 +6,6 @@
 
 use GraphQL\Error\Error;
 use GraphQL\Error\InvariantViolation;
-use GraphQL\Language\AST\Node;
 use GraphQL\Type\Definition\ScalarType;
 use GraphQL\Utils\Utils as GraphQLUtils;
 use Spatie\Regex\Regex as RegexValidator;
@@ -52,9 +51,6 @@ public static function regex(): string
      */
     abstract public static function regex(): string;
 
-    /**
-     * Serializes an internal value to include in a response.
-     */
     public function serialize($value): string
     {
         $stringValue = Utils::coerceToString($value, InvariantViolation::class);
@@ -81,11 +77,6 @@ protected static function matchesRegex(string $value): bool
             ->hasMatch();
     }
 
-    /**
-     * Parses an externally provided value (query variable) to use as an input.
-     *
-     * @throws Error
-     */
     public function parseValue($value): string
     {
         $stringValue = Utils::coerceToString($value, Error::class);
@@ -99,22 +90,14 @@ public function parseValue($value): string
         return $value;
     }
 
-    /**
-     * Parses an externally provided literal value (hardcoded in GraphQL query) to use as an input.
-     *
-     * @param Node $valueNode
-     * @param mixed[]|null $variables
-     *
-     * @throws Error
-     */
     public function parseLiteral($valueNode, ?array $variables = null): string
     {
         $value = Utils::extractStringFromLiteral($valueNode);
 
         if (!static::matchesRegex($value)) {
             throw new Error(
                 static::unmatchedRegexMessage($value),
-                [$valueNode]
+                $valueNode
             );
         }
 

src/StringScalar.php

@@ -50,11 +50,6 @@ protected function isValid(string $stringValue): bool
      */
     abstract protected function isValid(string $stringValue): bool;
 
-    /**
-     * Serializes an internal value to include in a response.
-     *
-     * @throws InvariantViolation
-     */
     public function serialize($value): string
     {
         $stringValue = Utils::coerceToString($value, InvariantViolation::class);
@@ -78,11 +73,6 @@ public function invalidStringMessage(string $stringValue): string
         return "The given string {$safeValue} is not a valid {$this->tryInferName()}.";
     }
 
-    /**
-     * Parses an externally provided value (query variable) to use as an input.
-     *
-     * @throws Error
-     */
     public function parseValue($value): string
     {
         $stringValue = Utils::coerceToString($value, Error::class);
@@ -96,19 +86,6 @@ public function parseValue($value): string
         return $stringValue;
     }
 
-    /**
-     * Parses an externally provided literal value (hardcoded in GraphQL query) to use as an input.
-     *
-     * E.g.
-     * {
-     *   user(email: "[email protected]")
-     * }
-     *
-     * @param Node $valueNode
-     * @param mixed[]|null $variables
-     *
-     * @throws Error
-     */
     public function parseLiteral($valueNode, ?array $variables = null): string
     {
         $stringValue = Utils::extractStringFromLiteral($valueNode);

src/Utils.php

@@ -5,13 +5,17 @@
 namespace MLL\GraphQLScalars;
 
 use GraphQL\Error\Error;
+use GraphQL\Language\AST\Node;
 use GraphQL\Language\AST\StringValueNode;
+use GraphQL\Language\AST\ValueNode;
 use GraphQL\Utils\Utils as GraphQLUtils;
 
 class Utils
 {
     /**
      * Check if a value can be serialized to a string.
+     *
+     * @param mixed $value Any value
      */
     public static function canBeString($value): bool
     {
@@ -23,14 +27,15 @@ public static function canBeString($value): bool
     /**
      * Get the underlying string from a GraphQL literal and throw if Literal is not a string.
      *
+     * @param Node&ValueNode $valueNode
      * @throws Error
      */
-    public static function extractStringFromLiteral($valueNode): string
+    public static function extractStringFromLiteral(Node $valueNode): string
     {
         if (!$valueNode instanceof StringValueNode) {
             throw new Error(
                 "Query error: Can only parse strings got: {$valueNode->kind}",
-                [$valueNode]
+                $valueNode
             );
         }
 
@@ -40,6 +45,8 @@ public static function extractStringFromLiteral($valueNode): string
     /**
      * Convert the value to a string and throw an exception if it is not possible.
      *
+     * @param mixed $value Any value
+     *
      * @throws \Exception of type $exceptionClass
      */
     public static function coerceToString($value, string $exceptionClass): string
@@ -52,6 +59,6 @@ public static function coerceToString($value, string $exceptionClass): string
             );
         }
 
-        return strval($value);
+        return (string) $value;
     }
 }