Merge branch '4.4'

nicolas-grekas · nicolas-grekas · commit 06aedf0286b3 · 2019-10-07T14:45:39.000+02:00
* 4.4:
  [travis] Fix build-packages script
  Add types to constructors and private/final/internal methods (Batch III)
  [HttpClient] Async HTTPlug client
  [Messenger] Allow to configure the db index on Redis transport
  [HttpClient] bugfix exploding values of headers
  [VarDumper] Made all casters final
  [VarDumper] Added a support for casting Ramsey/Uuid
  Remove useless testCanCheckIfTerminalIsInteractive test case
  [Validator] Add the missing translations for the Thai (\"th\") locale
  [Routing] gracefully handle docref_root ini setting
  [Validator] Fix ValidValidator group cascading usage
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,8 @@ CHANGELOG
    to configure casters & flags to use in tests
  * added `ImagineCaster` and infrastructure to dump images
  * added the stamps of a message after it is dispatched in `TraceableMessageBus` and `MessengerDataCollector` collected data
+ * added `UuidCaster`
+ * made all casters final
 
 4.3.0
 -----
diff --git a/Caster/AmqpCaster.php b/Caster/AmqpCaster.php
@@ -17,6 +17,8 @@
  * Casts Amqp related classes to array representation.
  *
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ *
+ * @final since Symfony 4.4
  */
 class AmqpCaster
 {
diff --git a/Caster/DOMCaster.php b/Caster/DOMCaster.php
@@ -17,6 +17,8 @@
  * Casts DOM related classes to array representation.
  *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @final since Symfony 4.4
  */
 class DOMCaster
 {
diff --git a/Caster/DateCaster.php b/Caster/DateCaster.php
@@ -17,6 +17,8 @@
  * Casts DateTimeInterface related classes to array representation.
  *
  * @author Dany Maillard <danymaillard93b@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class DateCaster
 {
@@ -52,7 +54,7 @@ public static function castInterval(\DateInterval $interval, array $a, Stub $stu
         return $filter & Caster::EXCLUDE_VERBOSE ? $i : $i + $a;
     }
 
-    private static function formatInterval(\DateInterval $i)
+    private static function formatInterval(\DateInterval $i): string
     {
         $format = '%R ';
 
diff --git a/Caster/DoctrineCaster.php b/Caster/DoctrineCaster.php
@@ -20,6 +20,8 @@
  * Casts Doctrine related classes to array representation.
  *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @final since Symfony 4.4
  */
 class DoctrineCaster
 {
diff --git a/Caster/DsCaster.php b/Caster/DsCaster.php
@@ -20,6 +20,8 @@
  * Casts Ds extension classes to array representation.
  *
  * @author Jáchym Toušek <enumag@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class DsCaster
 {
diff --git a/Caster/ExceptionCaster.php b/Caster/ExceptionCaster.php
@@ -19,6 +19,8 @@
  * Casts common Exception classes to array representation.
  *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @final since Symfony 4.4
  */
 class ExceptionCaster
 {
diff --git a/Caster/GmpCaster.php b/Caster/GmpCaster.php
@@ -18,6 +18,8 @@
  *
  * @author Hamza Amrouche <hamza.simperfit@gmail.com>
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @final since Symfony 4.4
  */
 class GmpCaster
 {
diff --git a/Caster/ImagineCaster.php b/Caster/ImagineCaster.php
@@ -17,9 +17,9 @@
 /**
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  */
-class ImagineCaster
+final class ImagineCaster
 {
-    public static function castImage(ImageInterface $c, array $a, Stub $stub, bool $isNested)
+    public static function castImage(ImageInterface $c, array $a, Stub $stub, bool $isNested): array
     {
         $imgData = $c->get('png');
         if (\strlen($imgData) > 1 * 1000 * 1000) {
diff --git a/Caster/IntlCaster.php b/Caster/IntlCaster.php
@@ -16,6 +16,8 @@
 /**
  * @author Nicolas Grekas <p@tchwork.com>
  * @author Jan Schädlich <jan.schaedlich@sensiolabs.de>
+ *
+ * @final since Symfony 4.4
  */
 class IntlCaster
 {
diff --git a/Caster/MemcachedCaster.php b/Caster/MemcachedCaster.php
@@ -15,6 +15,8 @@
 
 /**
  * @author Jan Schädlich <jan.schaedlich@sensiolabs.de>
+ *
+ * @final since Symfony 4.4
  */
 class MemcachedCaster
 {
@@ -33,7 +35,7 @@ public static function castMemcached(\Memcached $c, array $a, Stub $stub, bool $
         return $a;
     }
 
-    private static function getNonDefaultOptions(\Memcached $c)
+    private static function getNonDefaultOptions(\Memcached $c): array
     {
         self::$defaultOptions = self::$defaultOptions ?? self::discoverDefaultOptions();
         self::$optionConstants = self::$optionConstants ?? self::getOptionConstants();
@@ -48,7 +50,7 @@ private static function getNonDefaultOptions(\Memcached $c)
         return $nonDefaultOptions;
     }
 
-    private static function discoverDefaultOptions()
+    private static function discoverDefaultOptions(): array
     {
         $defaultMemcached = new \Memcached();
         $defaultMemcached->addServer('127.0.0.1', 11211);
@@ -63,7 +65,7 @@ private static function discoverDefaultOptions()
         return $defaultOptions;
     }
 
-    private static function getOptionConstants()
+    private static function getOptionConstants(): array
     {
         $reflectedMemcached = new \ReflectionClass(\Memcached::class);
 
diff --git a/Caster/PdoCaster.php b/Caster/PdoCaster.php
@@ -17,6 +17,8 @@
  * Casts PDO related classes to array representation.
  *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @final since Symfony 4.4
  */
 class PdoCaster
 {
diff --git a/Caster/PgSqlCaster.php b/Caster/PgSqlCaster.php
@@ -17,6 +17,8 @@
  * Casts pqsql resources to array representation.
  *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @final since Symfony 4.4
  */
 class PgSqlCaster
 {
diff --git a/Caster/ProxyManagerCaster.php b/Caster/ProxyManagerCaster.php
@@ -16,6 +16,8 @@
 
 /**
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @final since Symfony 4.4
  */
 class ProxyManagerCaster
 {
diff --git a/Caster/RedisCaster.php b/Caster/RedisCaster.php
@@ -17,6 +17,8 @@
  * Casts Redis class from ext-redis to array representation.
  *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @final since Symfony 4.4
  */
 class RedisCaster
 {
diff --git a/Caster/ReflectionCaster.php b/Caster/ReflectionCaster.php
@@ -17,6 +17,8 @@
  * Casts Reflector related classes to array representation.
  *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @final since Symfony 4.4
  */
 class ReflectionCaster
 {
@@ -361,7 +363,7 @@ public static function getSignature(array $a)
         return $signature;
     }
 
-    private static function addExtra(&$a, \Reflector $c)
+    private static function addExtra(array &$a, \Reflector $c)
     {
         $x = isset($a[Caster::PREFIX_VIRTUAL.'extra']) ? $a[Caster::PREFIX_VIRTUAL.'extra']->value : [];
 
@@ -377,7 +379,7 @@ private static function addExtra(&$a, \Reflector $c)
         }
     }
 
-    private static function addMap(&$a, \Reflector $c, $map, $prefix = Caster::PREFIX_VIRTUAL)
+    private static function addMap(array &$a, \Reflector $c, array $map, string $prefix = Caster::PREFIX_VIRTUAL)
     {
         foreach ($map as $k => $m) {
             if (method_exists($c, $m) && false !== ($m = $c->$m()) && null !== $m) {
diff --git a/Caster/ResourceCaster.php b/Caster/ResourceCaster.php
@@ -17,6 +17,8 @@
  * Casts common resource types to array representation.
  *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @final since Symfony 4.4
  */
 class ResourceCaster
 {
diff --git a/Caster/SplCaster.php b/Caster/SplCaster.php
@@ -17,6 +17,8 @@
  * Casts SPL related classes to array representation.
  *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @final since Symfony 4.4
  */
 class SplCaster
 {
diff --git a/Caster/SymfonyCaster.php b/Caster/SymfonyCaster.php
@@ -14,6 +14,9 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\VarDumper\Cloner\Stub;
 
+/**
+ * @final since Symfony 4.4
+ */
 class SymfonyCaster
 {
     private static $requestGetters = [
diff --git a/Caster/UuidCaster.php b/Caster/UuidCaster.php
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\VarDumper\Caster;
+
+use Ramsey\Uuid\UuidInterface;
+use Symfony\Component\VarDumper\Cloner\Stub;
+
+/**
+ * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ */
+final class UuidCaster
+{
+    public static function castRamseyUuid(UuidInterface $c, array $a, Stub $stub, bool $isNested): array
+    {
+        $a += [
+            Caster::PREFIX_VIRTUAL.'uuid' => (string) $c,
+        ];
+
+        return $a;
+    }
+}
diff --git a/Caster/XmlReaderCaster.php b/Caster/XmlReaderCaster.php
@@ -16,6 +16,8 @@
  * Casts XmlReader class to array representation.
  *
  * @author Baptiste Clavié <clavie.b@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class XmlReaderCaster
 {
diff --git a/Caster/XmlResourceCaster.php b/Caster/XmlResourceCaster.php
@@ -17,6 +17,8 @@
  * Casts XML resources to array representation.
  *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @final since Symfony 4.4
  */
 class XmlResourceCaster
 {
diff --git a/Cloner/AbstractCloner.php b/Cloner/AbstractCloner.php
@@ -89,6 +89,8 @@ abstract class AbstractCloner implements ClonerInterface
 
         'Imagine\Image\ImageInterface' => ['Symfony\Component\VarDumper\Caster\ImagineCaster', 'castImage'],
 
+        'Ramsey\Uuid\UuidInterface' => ['Symfony\Component\VarDumper\Caster\UuidCaster', 'castRamseyUuid'],
+
         'ProxyManager\Proxy\ProxyInterface' => ['Symfony\Component\VarDumper\Caster\ProxyManagerCaster', 'castProxy'],
         'PHPUnit_Framework_MockObject_MockObject' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
         'PHPUnit\Framework\MockObject\MockObject' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'cutInternals'],
diff --git a/Test/VarDumperTestTrait.php b/Test/VarDumperTestTrait.php
@@ -76,7 +76,7 @@ protected function getDump($data, $key = null, int $filter = 0): ?string
         return rtrim($dumper->dump($data, true));
     }
 
-    private function prepareExpectation($expected, int $filter)
+    private function prepareExpectation($expected, int $filter): string
     {
         if (!\is_string($expected)) {
             $expected = $this->getDump($expected, null, $filter);

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`	`* Casts Amqp related classes to array representation.`
`18`	`18`	`*`
`19`	`19`	`* @author Grégoire Pineau <[email protected]>`
	`20`	`+ *`
	`21`	`+ * @final since Symfony 4.4`
`20`	`22`	`*/`
`21`	`23`	`class AmqpCaster`
`22`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,8 @@`
`20`	`20`	`* Casts Doctrine related classes to array representation.`
`21`	`21`	`*`
`22`	`22`	`* @author Nicolas Grekas <[email protected]>`
	`23`	`+ *`
	`24`	`+ * @final since Symfony 4.4`
`23`	`25`	`*/`
`24`	`26`	`class DoctrineCaster`
`25`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@`
`19`	`19`	`* Casts common Exception classes to array representation.`
`20`	`20`	`*`
`21`	`21`	`* @author Nicolas Grekas <[email protected]>`
	`22`	`+ *`
	`23`	`+ * @final since Symfony 4.4`
`22`	`24`	`*/`
`23`	`25`	`class ExceptionCaster`
`24`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,8 @@`
`18`	`18`	`*`
`19`	`19`	`* @author Hamza Amrouche <[email protected]>`
`20`	`20`	`* @author Nicolas Grekas <[email protected]>`
	`21`	`+ *`
	`22`	`+ * @final since Symfony 4.4`
`21`	`23`	`*/`
`22`	`24`	`class GmpCaster`
`23`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,9 +17,9 @@`
`17`	`17`	`/**`
`18`	`18`	`* @author Grégoire Pineau <[email protected]>`
`19`	`19`	`*/`
`20`		`-class ImagineCaster`
	`20`	`+final class ImagineCaster`
`21`	`21`	`{`
`22`		`- public static function castImage(ImageInterface $c, array $a, Stub $stub, bool $isNested)`
	`22`	`+ public static function castImage(ImageInterface $c, array $a, Stub $stub, bool $isNested): array`
`23`	`23`	`{`
`24`	`24`	`$imgData = $c->get('png');`
`25`	`25`	`if (\strlen($imgData) > 1 * 1000 * 1000) {`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@`
`16`	`16`	`/**`
`17`	`17`	`* @author Nicolas Grekas <[email protected]>`
`18`	`18`	`* @author Jan Schädlich <[email protected]>`
	`19`	`+ *`
	`20`	`+ * @final since Symfony 4.4`
`19`	`21`	`*/`
`20`	`22`	`class IntlCaster`
`21`	`23`	`{`