Leverage PHP8's get_debug_type()

nicolas-grekas · nicolas-grekas · commit bba93aecf514 · 2020-03-16T17:46:21.000+01:00
diff --git a/OptionsResolver.php b/OptionsResolver.php
@@ -434,7 +434,7 @@ public function setDeprecated(string $option, $deprecationMessage = 'The option
         }
 
         if (!\is_string($deprecationMessage) && !$deprecationMessage instanceof \Closure) {
-            throw new InvalidArgumentException(sprintf('Invalid type for deprecation message argument, expected string or \Closure, but got "%s".', \gettype($deprecationMessage)));
+            throw new InvalidArgumentException(sprintf('Invalid type for deprecation message argument, expected string or \Closure, but got "%s".', get_debug_type($deprecationMessage)));
         }
 
         // ignore if empty string
@@ -929,7 +929,7 @@ public function offsetGet($option, bool $triggerDeprecation = true)
             }
 
             if (!\is_array($value)) {
-                throw new InvalidOptionsException(sprintf('The nested option "%s" with value %s is expected to be of type array, but is of type "%s".', $this->formatOptions([$option]), $this->formatValue($value), $this->formatTypeOf($value)));
+                throw new InvalidOptionsException(sprintf('The nested option "%s" with value %s is expected to be of type array, but is of type "%s".', $this->formatOptions([$option]), $this->formatValue($value), get_debug_type($value)));
             }
 
             // The following section must be protected from cyclic calls.
@@ -1059,7 +1059,7 @@ public function offsetGet($option, bool $triggerDeprecation = true)
                 $this->calling[$option] = true;
                 try {
                     if (!\is_string($deprecationMessage = $deprecationMessage($this, $value))) {
-                        throw new InvalidOptionsException(sprintf('Invalid type for deprecation message, expected string but got "%s", return an empty string to ignore.', \gettype($deprecationMessage)));
+                        throw new InvalidOptionsException(sprintf('Invalid type for deprecation message, expected string but got "%s", return an empty string to ignore.', get_debug_type($deprecationMessage)));
                     }
                 } finally {
                     unset($this->calling[$option]);
@@ -1120,7 +1120,7 @@ private function verifyTypes(string $type, $value, array &$invalidTypes, int $le
         }
 
         if (!$invalidTypes || $level > 0) {
-            $invalidTypes[$this->formatTypeOf($value)] = true;
+            $invalidTypes[get_debug_type($value)] = true;
         }
 
         return false;
@@ -1186,18 +1186,6 @@ public function count()
         return \count($this->defaults);
     }
 
-    /**
-     * Returns a string representation of the type of the value.
-     *
-     * @param mixed $value The value to return the type of
-     *
-     * @return string The type of the value
-     */
-    private function formatTypeOf($value): string
-    {
-        return \is_object($value) ? \get_class($value) : \gettype($value);
-    }
-
     /**
      * Returns a string representation of the value.
      *
diff --git a/Tests/OptionsResolverTest.php b/Tests/OptionsResolverTest.php
@@ -460,7 +460,7 @@ public function testSetDeprecatedFailsIfUnknownOption()
     public function testSetDeprecatedFailsIfInvalidDeprecationMessageType()
     {
         $this->expectException('Symfony\Component\OptionsResolver\Exception\InvalidArgumentException');
-        $this->expectExceptionMessage('Invalid type for deprecation message argument, expected string or \Closure, but got "boolean".');
+        $this->expectExceptionMessage('Invalid type for deprecation message argument, expected string or \Closure, but got "bool".');
         $this->resolver
             ->setDefined('foo')
             ->setDeprecated('foo', true)
@@ -470,7 +470,7 @@ public function testSetDeprecatedFailsIfInvalidDeprecationMessageType()
     public function testLazyDeprecationFailsIfInvalidDeprecationMessageType()
     {
         $this->expectException('Symfony\Component\OptionsResolver\Exception\InvalidArgumentException');
-        $this->expectExceptionMessage('Invalid type for deprecation message, expected string but got "boolean", return an empty string to ignore.');
+        $this->expectExceptionMessage('Invalid type for deprecation message, expected string but got "bool", return an empty string to ignore.');
         $this->resolver
             ->setDefined('foo')
             ->setDeprecated('foo', function (Options $options, $value) {
@@ -814,7 +814,7 @@ public function testResolveFailsIfTypedArrayContainsInvalidTypes()
     public function testResolveFailsWithCorrectLevelsButWrongScalar()
     {
         $this->expectException('Symfony\Component\OptionsResolver\Exception\InvalidOptionsException');
-        $this->expectExceptionMessage('The option "foo" with value array is expected to be of type "int[][]", but one of the elements is of type "double".');
+        $this->expectExceptionMessage('The option "foo" with value array is expected to be of type "int[][]", but one of the elements is of type "float".');
         $this->resolver->setDefined('foo');
         $this->resolver->setAllowedTypes('foo', 'int[][]');
 
@@ -842,18 +842,18 @@ public function testResolveFailsIfInvalidType($actualType, $allowedType, $except
     public function provideInvalidTypes()
     {
         return [
-            [true, 'string', 'The option "option" with value true is expected to be of type "string", but is of type "boolean".'],
-            [false, 'string', 'The option "option" with value false is expected to be of type "string", but is of type "boolean".'],
-            [fopen(__FILE__, 'r'), 'string', 'The option "option" with value resource is expected to be of type "string", but is of type "resource".'],
+            [true, 'string', 'The option "option" with value true is expected to be of type "string", but is of type "bool".'],
+            [false, 'string', 'The option "option" with value false is expected to be of type "string", but is of type "bool".'],
+            [fopen(__FILE__, 'r'), 'string', 'The option "option" with value resource is expected to be of type "string", but is of type "resource (stream)".'],
             [[], 'string', 'The option "option" with value array is expected to be of type "string", but is of type "array".'],
             [new OptionsResolver(), 'string', 'The option "option" with value Symfony\Component\OptionsResolver\OptionsResolver is expected to be of type "string", but is of type "Symfony\Component\OptionsResolver\OptionsResolver".'],
-            [42, 'string', 'The option "option" with value 42 is expected to be of type "string", but is of type "integer".'],
-            [null, 'string', 'The option "option" with value null is expected to be of type "string", but is of type "NULL".'],
+            [42, 'string', 'The option "option" with value 42 is expected to be of type "string", but is of type "int".'],
+            [null, 'string', 'The option "option" with value null is expected to be of type "string", but is of type "null".'],
             ['bar', '\stdClass', 'The option "option" with value "bar" is expected to be of type "\stdClass", but is of type "string".'],
-            [['foo', 12], 'string[]', 'The option "option" with value array is expected to be of type "string[]", but one of the elements is of type "integer".'],
-            [123, ['string[]', 'string'], 'The option "option" with value 123 is expected to be of type "string[]" or "string", but is of type "integer".'],
-            [[null], ['string[]', 'string'], 'The option "option" with value array is expected to be of type "string[]" or "string", but one of the elements is of type "NULL".'],
-            [['string', null], ['string[]', 'string'], 'The option "option" with value array is expected to be of type "string[]" or "string", but one of the elements is of type "NULL".'],
+            [['foo', 12], 'string[]', 'The option "option" with value array is expected to be of type "string[]", but one of the elements is of type "int".'],
+            [123, ['string[]', 'string'], 'The option "option" with value 123 is expected to be of type "string[]" or "string", but is of type "int".'],
+            [[null], ['string[]', 'string'], 'The option "option" with value array is expected to be of type "string[]" or "string", but one of the elements is of type "null".'],
+            [['string', null], ['string[]', 'string'], 'The option "option" with value array is expected to be of type "string[]" or "string", but one of the elements is of type "null".'],
             [[\stdClass::class], ['string'], 'The option "option" with value array is expected to be of type "string", but is of type "array".'],
         ];
     }
@@ -869,7 +869,7 @@ public function testResolveSucceedsIfValidType()
     public function testResolveFailsIfInvalidTypeMultiple()
     {
         $this->expectException('Symfony\Component\OptionsResolver\Exception\InvalidOptionsException');
-        $this->expectExceptionMessage('The option "foo" with value 42 is expected to be of type "string" or "bool", but is of type "integer".');
+        $this->expectExceptionMessage('The option "foo" with value 42 is expected to be of type "string" or "bool", but is of type "int".');
         $this->resolver->setDefault('foo', 42);
         $this->resolver->setAllowedTypes('foo', ['string', 'bool']);
 
@@ -1906,7 +1906,7 @@ public function testNested2Arrays()
     public function testNestedArraysException()
     {
         $this->expectException('Symfony\Component\OptionsResolver\Exception\InvalidOptionsException');
-        $this->expectExceptionMessage('The option "foo" with value array is expected to be of type "float[][][][]", but one of the elements is of type "integer".');
+        $this->expectExceptionMessage('The option "foo" with value array is expected to be of type "float[][][][]", but one of the elements is of type "int".');
         $this->resolver->setDefined('foo');
         $this->resolver->setAllowedTypes('foo', 'float[][][][]');
 
@@ -1924,7 +1924,7 @@ public function testNestedArraysException()
     public function testNestedArrayException1()
     {
         $this->expectException('Symfony\Component\OptionsResolver\Exception\InvalidOptionsException');
-        $this->expectExceptionMessage('The option "foo" with value array is expected to be of type "int[][]", but one of the elements is of type "boolean|string|array".');
+        $this->expectExceptionMessage('The option "foo" with value array is expected to be of type "int[][]", but one of the elements is of type "bool|string|array".');
         $this->resolver->setDefined('foo');
         $this->resolver->setAllowedTypes('foo', 'int[][]');
         $this->resolver->resolve([
@@ -1937,7 +1937,7 @@ public function testNestedArrayException1()
     public function testNestedArrayException2()
     {
         $this->expectException('Symfony\Component\OptionsResolver\Exception\InvalidOptionsException');
-        $this->expectExceptionMessage('The option "foo" with value array is expected to be of type "int[][]", but one of the elements is of type "boolean|string|array".');
+        $this->expectExceptionMessage('The option "foo" with value array is expected to be of type "int[][]", but one of the elements is of type "bool|string|array".');
         $this->resolver->setDefined('foo');
         $this->resolver->setAllowedTypes('foo', 'int[][]');
         $this->resolver->resolve([
@@ -1950,7 +1950,7 @@ public function testNestedArrayException2()
     public function testNestedArrayException3()
     {
         $this->expectException('Symfony\Component\OptionsResolver\Exception\InvalidOptionsException');
-        $this->expectExceptionMessage('The option "foo" with value array is expected to be of type "string[][][]", but one of the elements is of type "string|integer".');
+        $this->expectExceptionMessage('The option "foo" with value array is expected to be of type "string[][][]", but one of the elements is of type "string|int".');
         $this->resolver->setDefined('foo');
         $this->resolver->setAllowedTypes('foo', 'string[][][]');
         $this->resolver->resolve([
@@ -1963,7 +1963,7 @@ public function testNestedArrayException3()
     public function testNestedArrayException4()
     {
         $this->expectException('Symfony\Component\OptionsResolver\Exception\InvalidOptionsException');
-        $this->expectExceptionMessage('The option "foo" with value array is expected to be of type "string[][][]", but one of the elements is of type "integer".');
+        $this->expectExceptionMessage('The option "foo" with value array is expected to be of type "string[][][]", but one of the elements is of type "int".');
         $this->resolver->setDefined('foo');
         $this->resolver->setAllowedTypes('foo', 'string[][][]');
         $this->resolver->resolve([
@@ -2031,7 +2031,7 @@ public function testFailsIfMissingRequiredNestedOption()
     public function testFailsIfInvalidTypeNestedOption()
     {
         $this->expectException('Symfony\Component\OptionsResolver\Exception\InvalidOptionsException');
-        $this->expectExceptionMessage('The option "database[logging]" with value null is expected to be of type "bool", but is of type "NULL".');
+        $this->expectExceptionMessage('The option "database[logging]" with value null is expected to be of type "bool", but is of type "null".');
         $this->resolver->setDefaults([
             'name' => 'default',
             'database' => function (OptionsResolver $resolver) {
@@ -2048,7 +2048,7 @@ public function testFailsIfInvalidTypeNestedOption()
     public function testFailsIfNotArrayIsGivenForNestedOptions()
     {
         $this->expectException('Symfony\Component\OptionsResolver\Exception\InvalidOptionsException');
-        $this->expectExceptionMessage('The nested option "database" with value null is expected to be of type array, but is of type "NULL".');
+        $this->expectExceptionMessage('The nested option "database" with value null is expected to be of type array, but is of type "null".');
         $this->resolver->setDefaults([
             'name' => 'default',
             'database' => function (OptionsResolver $resolver) {
diff --git a/composer.json b/composer.json
@@ -17,7 +17,8 @@
     ],
     "require": {
         "php": "^7.2.5",
-        "symfony/deprecation-contracts": "^2.1"
+        "symfony/deprecation-contracts": "^2.1",
+        "symfony/polyfill-php80": "^1.15"
     },
     "autoload": {
         "psr-4": { "Symfony\\Component\\OptionsResolver\\": "" },

Original file line number	Diff line number	Diff line change
`@@ -434,7 +434,7 @@ public function setDeprecated(string $option, $deprecationMessage = 'The option`
`434`	`434`	`}`
`435`	`435`
`436`	`436`	`if (!\is_string($deprecationMessage) && !$deprecationMessage instanceof \Closure) {`
`437`		`- throw new InvalidArgumentException(sprintf('Invalid type for deprecation message argument, expected string or \Closure, but got "%s".', \gettype($deprecationMessage)));`
	`437`	`+ throw new InvalidArgumentException(sprintf('Invalid type for deprecation message argument, expected string or \Closure, but got "%s".', get_debug_type($deprecationMessage)));`
`438`	`438`	`}`
`439`	`439`
`440`	`440`	`// ignore if empty string`
`@@ -929,7 +929,7 @@ public function offsetGet($option, bool $triggerDeprecation = true)`
`929`	`929`	`}`
`930`	`930`
`931`	`931`	`if (!\is_array($value)) {`
`932`		`- throw new InvalidOptionsException(sprintf('The nested option "%s" with value %s is expected to be of type array, but is of type "%s".', $this->formatOptions([$option]), $this->formatValue($value), $this->formatTypeOf($value)));`
	`932`	`+ throw new InvalidOptionsException(sprintf('The nested option "%s" with value %s is expected to be of type array, but is of type "%s".', $this->formatOptions([$option]), $this->formatValue($value), get_debug_type($value)));`
`933`	`933`	`}`
`934`	`934`
`935`	`935`	`// The following section must be protected from cyclic calls.`
`@@ -1059,7 +1059,7 @@ public function offsetGet($option, bool $triggerDeprecation = true)`
`1059`	`1059`	`$this->calling[$option] = true;`
`1060`	`1060`	`try {`
`1061`	`1061`	`if (!\is_string($deprecationMessage = $deprecationMessage($this, $value))) {`
`1062`		`- throw new InvalidOptionsException(sprintf('Invalid type for deprecation message, expected string but got "%s", return an empty string to ignore.', \gettype($deprecationMessage)));`
	`1062`	`+ throw new InvalidOptionsException(sprintf('Invalid type for deprecation message, expected string but got "%s", return an empty string to ignore.', get_debug_type($deprecationMessage)));`
`1063`	`1063`	`}`
`1064`	`1064`	`} finally {`
`1065`	`1065`	`unset($this->calling[$option]);`
`@@ -1120,7 +1120,7 @@ private function verifyTypes(string $type, $value, array &$invalidTypes, int $le`
`1120`	`1120`	`}`
`1121`	`1121`
`1122`	`1122`	`if (!$invalidTypes \|\| $level > 0) {`
`1123`		`- $invalidTypes[$this->formatTypeOf($value)] = true;`
	`1123`	`+ $invalidTypes[get_debug_type($value)] = true;`
`1124`	`1124`	`}`
`1125`	`1125`
`1126`	`1126`	`return false;`
`@@ -1186,18 +1186,6 @@ public function count()`
`1186`	`1186`	`return \count($this->defaults);`
`1187`	`1187`	`}`
`1188`	`1188`
`1189`		`- /**`
`1190`		`- * Returns a string representation of the type of the value.`
`1191`		`- *`
`1192`		`- * @param mixed $value The value to return the type of`
`1193`		`- *`
`1194`		`- * @return string The type of the value`
`1195`		`- */`
`1196`		`- private function formatTypeOf($value): string`
`1197`		`- {`
`1198`		`- return \is_object($value) ? \get_class($value) : \gettype($value);`
`1199`		`- }`
`1200`		`-`
`1201`	`1189`	`/**`
`1202`	`1190`	`* Returns a string representation of the value.`
`1203`	`1191`	`*`