Merge pull request #382 from norkunas/stringable-getter

Allow stringable object to be used to geocode address

Author: norkunas

src/Doctrine/ORM/GeocoderListener.php

@@ -57,7 +57,7 @@ public function onFlush(OnFlushEventArgs $args): void
             $this->geocodeEntity($metadata, $entity);
 
             $uow->recomputeSingleEntityChangeSet(
-                $em->getClassMetadata(get_class($entity)),
+                $em->getClassMetadata($entity::class),
                 $entity
             );
         }
@@ -76,7 +76,7 @@ public function onFlush(OnFlushEventArgs $args): void
             $this->geocodeEntity($metadata, $entity);
 
             $uow->recomputeSingleEntityChangeSet(
-                $em->getClassMetadata(get_class($entity)),
+                $em->getClassMetadata($entity::class),
                 $entity
             );
         }
@@ -92,11 +92,16 @@ private function geocodeEntity(ClassMetadata $metadata, object $entity): void
             $address = '';
         }
 
-        if (empty($address) || !is_string($address)) {
+        if (!is_string($address) && !$address instanceof \Stringable) {
             return;
         }
 
-        $results = $this->geocoder->geocodeQuery(GeocodeQuery::create($address));
+        $addressString = (string) $address;
+        if ('' === $addressString) {
+            return;
+        }
+
+        $results = $this->geocoder->geocodeQuery(GeocodeQuery::create($addressString));
 
         if (!$results->isEmpty()) {
             $result = $results->first();

src/Mapping/Driver/AttributeDriver.php

@@ -40,7 +40,7 @@ public function loadMetadataFromObject(object $object): ClassMetadata
         $attributes = $reflection->getAttributes(Attributes\Geocodeable::class);
 
         if ([] === $attributes) {
-            throw new MappingException(sprintf('The class "%s" is not geocodeable', get_class($object)));
+            throw new MappingException(sprintf('The class "%s" is not geocodeable', $object::class));
         }
 
         $args = [];

tests/Functional/Fixtures/Entity/DummyWithStringableGetter.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Tests\Functional\Fixtures\Entity;
+
+use Bazinga\GeocoderBundle\Mapping\Attributes\Address;
+use Bazinga\GeocoderBundle\Mapping\Attributes\Geocodeable;
+use Bazinga\GeocoderBundle\Mapping\Attributes\Latitude;
+use Bazinga\GeocoderBundle\Mapping\Attributes\Longitude;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Embedded;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\GeneratedValue;
+use Doctrine\ORM\Mapping\Id;
+
+#[Entity]
+#[Geocodeable]
+final class DummyWithStringableGetter
+{
+    #[Id]
+    #[GeneratedValue]
+    #[Column(type: Types::INTEGER)]
+    public $id;
+
+    #[Column]
+    #[Latitude]
+    public $latitude;
+
+    #[Column]
+    #[Longitude]
+    public $longitude;
+
+    #[Embedded]
+    public StringableAddress $address;
+
+    public function setAddress(StringableAddress $address): void
+    {
+        $this->address = $address;
+    }
+
+    #[Address]
+    public function getAddress(): StringableAddress
+    {
+        return $this->address;
+    }
+}

tests/Functional/Fixtures/Entity/StringableAddress.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Tests\Functional\Fixtures\Entity;
+
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Embeddable;
+
+#[Embeddable]
+final class StringableAddress implements \Stringable
+{
+    public function __construct(
+        #[Column]
+        private string $address,
+    ) {
+    }
+
+    public function __toString(): string
+    {
+        return $this->address;
+    }
+}

tests/Functional/GeocoderListenerTest.php

@@ -17,6 +17,8 @@
 use Bazinga\GeocoderBundle\Tests\Functional\Fixtures\Entity\DummyWithGetter;
 use Bazinga\GeocoderBundle\Tests\Functional\Fixtures\Entity\DummyWithInvalidGetter;
 use Bazinga\GeocoderBundle\Tests\Functional\Fixtures\Entity\DummyWithProperty;
+use Bazinga\GeocoderBundle\Tests\Functional\Fixtures\Entity\DummyWithStringableGetter;
+use Bazinga\GeocoderBundle\Tests\Functional\Fixtures\Entity\StringableAddress;
 use Doctrine\Bundle\DoctrineBundle\ConnectionFactory;
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use Doctrine\ORM\Configuration;
@@ -177,6 +179,46 @@ public function testPersistForGetter(): void
         self::assertNotEquals($clone->getLongitude(), $dummy->getLongitude());
     }
 
+    public function testPersistForStringableGetter(): void
+    {
+        self::bootKernel(['config' => static function (TestKernel $kernel) {
+            $kernel->addTestConfig(__DIR__.'/config/framework.yml');
+
+            if ($kernel::VERSION_ID >= 60000) {
+                $kernel->addTestConfig(__DIR__.'/config/framework_sf6.yml');
+            }
+
+            $kernel->addTestConfig(__DIR__.'/config/listener.yml');
+            $kernel->addTestConfig(__DIR__.'/config/listener_'.(PHP_VERSION_ID >= 80000 ? 'php8' : 'php7').'.yml');
+        }]);
+
+        $container = self::getContainer();
+        $container->set('http_client', self::createHttpClientForBerlinQuery());
+
+        $em = $container->get('doctrine.orm.entity_manager');
+
+        $tool = new SchemaTool($em);
+        $tool->createSchema($em->getMetadataFactory()->getAllMetadata());
+
+        $dummy = new DummyWithStringableGetter();
+        $dummy->setAddress(new StringableAddress('Berlin, Germany'));
+
+        $em->persist($dummy);
+        $em->flush();
+
+        self::assertNotNull($dummy->latitude);
+        self::assertNotNull($dummy->longitude);
+
+        $clone = clone $dummy;
+        $dummy->setAddress(new StringableAddress('Paris, France'));
+
+        $em->persist($dummy);
+        $em->flush();
+
+        self::assertNotEquals($clone->latitude, $dummy->latitude);
+        self::assertNotEquals($clone->longitude, $dummy->longitude);
+    }
+
     public function testPersistForInvalidGetter(): void
     {
         self::bootKernel(['config' => static function (TestKernel $kernel) {