Add tests and date time mutable / immutable transformations

symfony · joelwurtz · Feb 14, 2019 · Feb 14, 2019 · Feb 14, 2019 · Feb 14, 2019
commit 20a37dfc70894ad5a3c5c2e38dc15733f4c3fbf4
diff --git a/src/Symfony/Component/AutoMapper/Extractor/ReadAccessor.php b/src/Symfony/Component/AutoMapper/Extractor/ReadAccessor.php
@@ -44,21 +44,6 @@ public function __construct(int $type, string $name, $private = false)
         $this->private = $private;
     }
 
-    public function getType(): int
-    {
-        return $this->type;
-    }
-
-    public function getName(): string
-    {
-        return $this->name;
-    }
-
-    public function isPrivate(): bool
-    {
-        return $this->private;
-    }
-
     /**
      * Get AST expression for reading property from an input.
      *

diff --git a/src/Symfony/Component/AutoMapper/Extractor/SourceTargetMappingExtractor.php b/src/Symfony/Component/AutoMapper/Extractor/SourceTargetMappingExtractor.php
@@ -27,13 +27,16 @@ class SourceTargetMappingExtractor extends MappingExtractor
      */
     public function getPropertiesMapping(MapperMetadataInterface $mapperMetadata): array
     {
-        $sourceProperties = array_unique($this->propertyInfoExtractor->getProperties($mapperMetadata->getSource()));
-        $targetProperties = array_unique($this->propertyInfoExtractor->getProperties($mapperMetadata->getTarget()));
+        $sourceProperties = $this->propertyInfoExtractor->getProperties($mapperMetadata->getSource());
+        $targetProperties = $this->propertyInfoExtractor->getProperties($mapperMetadata->getTarget());
 
         if (null === $sourceProperties || null === $targetProperties) {
             return [];
         }
 
+        $sourceProperties = array_unique($sourceProperties ?? []);
+        $targetProperties = array_unique($targetProperties ?? []);
+
         $mapping = [];
 
         foreach ($sourceProperties as $property) {

diff --git a/src/Symfony/Component/AutoMapper/Extractor/WriteMutator.php b/src/Symfony/Component/AutoMapper/Extractor/WriteMutator.php
@@ -49,16 +49,6 @@ public function getType(): int
         return $this->type;
     }
 
-    public function getName(): string
-    {
-        return $this->name;
-    }
-
-    public function isPrivate(): bool
-    {
-        return $this->private;
-    }
-
     /**
      * Get AST expression for writing from a value to an output.
      *
@@ -97,10 +87,6 @@ public function getExpression(Expr\Variable $output, Expr $value, bool $byRef =
             return new Expr\Assign(new Expr\ArrayDimFetch($output, new Scalar\String_($this->name)), $value);
         }
 
-        if (self::TYPE_CONSTRUCTOR === $this->type) {
-            return null;
-        }
-
         throw new CompileException('Invalid accessor for write expression');
     }
 

diff --git a/src/Symfony/Component/AutoMapper/MapperMetadata.php b/src/Symfony/Component/AutoMapper/MapperMetadata.php
@@ -88,11 +88,7 @@ public function getPropertiesMapping(): array
      */
     public function getPropertyMapping(string $property): ?PropertyMapping
     {
-        if (null === $this->propertiesMapping) {
-            $this->buildPropertyMapping();
-        }
-
-        return $this->propertiesMapping[$property] ?? null;
+        return $this->getPropertiesMapping()[$property] ?? null;
     }
 
     /**

diff --git a/src/Symfony/Component/AutoMapper/Tests/AutoMapperTest.php b/src/Symfony/Component/AutoMapper/Tests/AutoMapperTest.php
@@ -75,6 +75,29 @@ public function testAutoMapperFromArray(): void
         self::assertEquals(1987, $userDto->createdAt->format('Y'));
     }
 
+    public function testAutoMapperFromArrayCustomDateTime(): void
+    {
+        $dateTime = \DateTime::createFromFormat(\DateTime::RFC3339, '1987-04-30T06:00:00Z');
+        $customFormat = 'U';
+        $user = [
+            'id' => 1,
+            'address' => [
+                'city' => 'Toulon',
+            ],
+            'createdAt' => $dateTime->format($customFormat),
+        ];
+
+        $autoMapper = AutoMapper::create(true, $this->loader, null, 'CustomDateTime_');
+        $configuration = $autoMapper->getMetadata('array', Fixtures\UserDTO::class);
+        $configuration->setDateTimeFormat($customFormat);
+
+        /** @var Fixtures\UserDTO $userDto */
+        $userDto = $autoMapper->map($user, Fixtures\UserDTO::class);
+
+        self::assertInstanceOf(Fixtures\UserDTO::class, $userDto);
+        self::assertEquals($dateTime->format($customFormat), $userDto->createdAt->format($customFormat));
+    }
+
     public function testAutoMapperToArray(): void
     {
         $address = new Fixtures\Address();
@@ -114,6 +137,62 @@ public function testAutoMapperToStdObject(): void
         self::assertEquals(1, $user->id);
     }
 
+    public function testNotReadable(): void
+    {
+        $autoMapper = AutoMapper::create(false, $this->loader, null, 'NotReadable_');
+        $address = new Fixtures\Address();
+        $address->setCity('test');
+
+        $addressArray = $autoMapper->map($address, 'array');
+
+        self::assertIsArray($addressArray);
+        self::assertArrayNotHasKey('city', $addressArray);
+
+        $addressMapped = $autoMapper->map($address, Fixtures\Address::class);
+
+        self::assertInstanceOf(Fixtures\Address::class, $addressMapped);
+
+        $property = (new \ReflectionClass($addressMapped))->getProperty('city');
+        $property->setAccessible(true);
+
+        $city = $property->getValue($addressMapped);
+
+        self::assertNull($city);
+    }
+
+    public function testNoTypes(): void
+    {
+        $autoMapper = AutoMapper::create(false, $this->loader, null, 'NotReadable_');
+        $address = new Fixtures\AddressNoTypes();
+        $address->city = 'test';
+
+        $addressArray = $autoMapper->map($address, 'array');
+
+        self::assertIsArray($addressArray);
+        self::assertArrayNotHasKey('city', $addressArray);
+    }
+
+    public function testNoTransformer(): void
+    {
+        $addressFoo = new Fixtures\AddressFoo();
+        $addressFoo->city = new Fixtures\CityFoo();
+        $addressFoo->city->name = 'test';
+
+        $addressBar = $this->autoMapper->map($addressFoo, Fixtures\AddressBar::class);
+
+        self::assertInstanceOf(Fixtures\AddressBar::class, $addressBar);
+        self::assertNull($addressBar->city);
+    }
+
+    public function testNoProperties(): void
+    {
+        $noProperties = new Fixtures\FooNoProperties();
+        $noPropertiesMapped = $this->autoMapper->map($noProperties, Fixtures\FooNoProperties::class);
+
+        self::assertInstanceOf(Fixtures\FooNoProperties::class, $noPropertiesMapped);
+        self::assertNotSame($noProperties, $noPropertiesMapped);
+    }
+
     public function testGroupsSourceTarget(): void
     {
         $foo = new Fixtures\Foo();
@@ -205,6 +284,28 @@ public function testDeepCloningArray(): void
         self::assertSame($newNode, $newNode['parent']['parent']['parent']);
     }
 
+    public function testCircularReferenceDeep(): void
+    {
+        $foo = new Fixtures\CircularFoo();
+        $bar = new Fixtures\CircularBar();
+        $baz = new Fixtures\CircularBaz();
+
+        $foo->bar = $bar;
+        $bar->baz = $baz;
+        $baz->foo = $foo;
+
+
+        $newFoo = $this->autoMapper->map($foo, Fixtures\CircularFoo::class);
+
+        self::assertNotSame($foo, $newFoo);
+        self::assertNotNull($newFoo->bar);
+        self::assertNotSame($bar, $newFoo->bar);
+        self::assertNotNull($newFoo->bar->baz);
+        self::assertNotSame($baz, $newFoo->bar->baz);
+        self::assertNotNull($newFoo->bar->baz->foo);
+        self::assertSame($newFoo, $newFoo->bar->baz->foo);
+    }
+
     public function testCircularReferenceArray(): void
     {
         $nodeA = new Fixtures\Node();
@@ -248,6 +349,28 @@ public function testConstructor(): void
         self::assertSame('10', $userDto->getId());
         self::assertSame('foo', $userDto->getName());
         self::assertSame(3, $userDto->getAge());
+        self::assertTrue($userDto->getConstructor());
+    }
+
+    public function testConstructorNotAllowed(): void
+    {
+        $autoMapper = AutoMapper::create(true, $this->loader, null, 'NotAllowedMapper_');
+        $configuration = $autoMapper->getMetadata(Fixtures\UserDTO::class, Fixtures\UserConstructorDTO::class);
+        $configuration->setConstructorAllowed(false);
+
+        $user = new Fixtures\UserDTO();
+        $user->id = 10;
+        $user->setName('foo');
+        $user->age = 3;
+
+        /** @var Fixtures\UserConstructorDTO $userDto */
+        $userDto = $autoMapper->map($user, Fixtures\UserConstructorDTO::class);
+
+        self::assertInstanceOf(Fixtures\UserConstructorDTO::class, $userDto);
+        self::assertSame('10', $userDto->getId());
+        self::assertSame('foo', $userDto->getName());
+        self::assertSame(3, $userDto->getAge());
+        self::assertFalse($userDto->getConstructor());
     }
 
     public function testConstructorWithDefault(): void

diff --git a/src/Symfony/Component/AutoMapper/Tests/Fixtures/Address.php b/src/Symfony/Component/AutoMapper/Tests/Fixtures/Address.php
@@ -18,14 +18,6 @@ class Address
      */
     private $city;
 
-    /**
-     * @return string
-     */
-    public function getCity(): ?string
-    {
-        return $this->city;
-    }
-
     /**
      * @param string $city
      */

diff --git a/src/Symfony/Component/AutoMapper/Tests/Fixtures/AddressBar.php b/src/Symfony/Component/AutoMapper/Tests/Fixtures/AddressBar.php
@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\AutoMapper\Tests\Fixtures;
+
+class AddressBar
+{
+    /**
+     * @var string|null
+     */
+    public $city;
+}
diff --git a/src/Symfony/Component/AutoMapper/Tests/Fixtures/AddressFoo.php b/src/Symfony/Component/AutoMapper/Tests/Fixtures/AddressFoo.php
@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\AutoMapper\Tests\Fixtures;
+
+class AddressFoo
+{
+    /**
+     * @var CityFoo
+     */
+    public $city;
+}
diff --git a/src/Symfony/Component/AutoMapper/Tests/Fixtures/AddressNoTypes.php b/src/Symfony/Component/AutoMapper/Tests/Fixtures/AddressNoTypes.php
@@ -0,0 +1,17 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\AutoMapper\Tests\Fixtures;
+
+class AddressNoTypes
+{
+    public $city;
+}
diff --git a/src/Symfony/Component/AutoMapper/Tests/Fixtures/AddressNotWritable.php b/src/Symfony/Component/AutoMapper/Tests/Fixtures/AddressNotWritable.php
@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\AutoMapper\Tests\Fixtures;
+
+class AddressNotWritable
+{
+    /**
+     * @var string|null
+     */
+    private $city;
+
+    public function getCity(): ?string
+    {
+        return $this->city;
+    }
+}
diff --git a/src/Symfony/Component/AutoMapper/Tests/Fixtures/CircularBar.php b/src/Symfony/Component/AutoMapper/Tests/Fixtures/CircularBar.php
@@ -0,0 +1,11 @@
+<?php
+
+
+namespace Symfony\Component\AutoMapper\Tests\Fixtures;
+
+
+class CircularBar
+{
+    /** @var CircularBaz */
+    public $baz;
+}
diff --git a/src/Symfony/Component/AutoMapper/Tests/Fixtures/CircularBaz.php b/src/Symfony/Component/AutoMapper/Tests/Fixtures/CircularBaz.php
@@ -0,0 +1,11 @@
+<?php
+
+
+namespace Symfony\Component\AutoMapper\Tests\Fixtures;
+
+
+class CircularBaz
+{
+    /** @var CircularFoo */
+    public $foo;
+}
diff --git a/src/Symfony/Component/AutoMapper/Tests/Fixtures/CircularFoo.php b/src/Symfony/Component/AutoMapper/Tests/Fixtures/CircularFoo.php
@@ -0,0 +1,11 @@
+<?php
+
+
+namespace Symfony\Component\AutoMapper\Tests\Fixtures;
+
+
+class CircularFoo
+{
+    /** @var CircularBar */
+    public $bar;
+}
diff --git a/src/Symfony/Component/AutoMapper/Tests/Fixtures/CityFoo.php b/src/Symfony/Component/AutoMapper/Tests/Fixtures/CityFoo.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Symfony\Component\AutoMapper\Tests\Fixtures;
+
+class CityFoo
+{
+    public $name;
+}
diff --git a/src/Symfony/Component/AutoMapper/Tests/Fixtures/FooNoProperties.php b/src/Symfony/Component/AutoMapper/Tests/Fixtures/FooNoProperties.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Symfony\Component\AutoMapper\Tests\Fixtures;
+
+class FooNoProperties
+{
+}
diff --git a/src/Symfony/Component/AutoMapper/Tests/Fixtures/User.php b/src/Symfony/Component/AutoMapper/Tests/Fixtures/User.php
@@ -44,7 +44,7 @@ class User
     public $addresses = [];
 
     /**
-     * @var \DateTimeInterface
+     * @var \DateTime
      */
     public $createdAt;