Add address validator constraint (#212)

Author: norkunas

Resources/config/services.yml

@@ -19,6 +19,8 @@ services:
         arguments: ['@Geocoder\ProviderAggregator']
         tags: [{ name: 'console.command' }]
 
+    Bazinga\GeocoderBundle\Validator\Constraint\AddressValidator: ['@geocoder']
+
     # Keep these aliases for BC purpose
     bazinga_geocoder.geocoder:
         alias: "Geocoder\\ProviderAggregator"

Tests/Validator/Constraint/AddressValidatorTest.php

@@ -0,0 +1,75 @@
+<?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\Validator\Constraint;
+
+use Bazinga\GeocoderBundle\Validator\Constraint\Address;
+use Bazinga\GeocoderBundle\Validator\Constraint\AddressValidator;
+use Http\Client\Curl\Client;
+use Geocoder\Provider\Nominatim\Nominatim;
+use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;
+
+class AddressValidatorTest extends ConstraintValidatorTestCase
+{
+    protected function createValidator()
+    {
+        $geocoder = Nominatim::withOpenStreetMapServer(new Client(), 'BazingaGeocoderBundle/Test');
+
+        return new AddressValidator($geocoder);
+    }
+
+    public function testNullIsValid()
+    {
+        $this->validator->validate(null, new Address());
+
+        $this->assertNoViolation();
+    }
+
+    public function testEmptyStringIsValid()
+    {
+        $this->validator->validate('', new Address());
+
+        $this->assertNoViolation();
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Validator\Exception\UnexpectedTypeException
+     */
+    public function testExpectsStringCompatibleType()
+    {
+        $this->validator->validate(new \stdClass(), new Address());
+    }
+
+    public function testValidAddress()
+    {
+        $this->validator->validate('Berlin, Germany', new Address());
+
+        $this->assertNoViolation();
+    }
+
+    public function testInvalidAddress()
+    {
+        $address = 'Bifrost, Nine Realms';
+
+        $constraint = new Address([
+            'message' => 'myMessage {{ address }}',
+        ]);
+
+        $this->validator->validate($address, $constraint);
+
+        $this->buildViolation('myMessage {{ address }}')
+            ->setParameter('{{ address }}', '"'.$address.'"')
+            ->setInvalidValue($address)
+            ->setCode(Address::INVALID_ADDRESS_ERROR)
+            ->assertRaised();
+    }
+}

Validator/Constraint/Address.php

@@ -0,0 +1,39 @@
+<?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\Validator\Constraint;
+
+use Symfony\Component\Validator\Constraint;
+
+/**
+ * @Annotation
+ * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
+ *
+ * @author Tomas Norkūnas <[email protected]>
+ */
+class Address extends Constraint
+{
+    const INVALID_ADDRESS_ERROR = '2243aa07-2ea7-4eb7-962c-6a9586593f2c';
+
+    protected static $errorNames = [
+        self::INVALID_ADDRESS_ERROR => 'INVALID_ADDRESS_ERROR',
+    ];
+
+    public $service = 'Bazinga\GeocoderBundle\Validator\Constraints\AddressValidator';
+
+    public $message = 'Address {{ address }} is not valid.';
+
+    public function validatedBy()
+    {
+        return $this->service;
+    }
+}

Validator/Constraint/AddressValidator.php

@@ -0,0 +1,74 @@
+<?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\Validator\Constraint;
+
+use Geocoder\Exception\Exception;
+use Geocoder\Provider\Provider;
+use Geocoder\Query\GeocodeQuery;
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+use Symfony\Component\Validator\Exception\UnexpectedTypeException;
+use Symfony\Component\Validator\Exception\UnexpectedValueException;
+
+/**
+ * @author Tomas Norkūnas <[email protected]>
+ */
+class AddressValidator extends ConstraintValidator
+{
+    protected $addressGeocoder;
+
+    public function __construct(Provider $addressGeocoder)
+    {
+        $this->addressGeocoder = $addressGeocoder;
+    }
+
+    public function validate($value, Constraint $constraint)
+    {
+        if (!$constraint instanceof Address) {
+            throw new UnexpectedTypeException($constraint, Address::class);
+        }
+
+        if (null === $value || '' === $value) {
+            return;
+        }
+
+        if (!is_scalar($value) && !(\is_object($value) && method_exists($value, '__toString'))) {
+            if (class_exists(UnexpectedValueException::class)) {
+                throw new UnexpectedValueException($value, 'string');
+            } else {
+                throw new UnexpectedTypeException($value, 'string');
+            }
+        }
+
+        $value = (string) $value;
+
+        try {
+            $collection = $this->addressGeocoder->geocodeQuery(GeocodeQuery::create($value));
+
+            if ($collection->isEmpty()) {
+                $this->buildViolation($constraint, $value);
+            }
+        } catch (Exception $e) {
+            $this->buildViolation($constraint, $value);
+        }
+    }
+
+    private function buildViolation(Address $constraint, string $address)
+    {
+        $this->context->buildViolation($constraint->message)
+            ->setParameter('{{ address }}', $this->formatValue($address))
+            ->setInvalidValue($address)
+            ->setCode(Address::INVALID_ADDRESS_ERROR)
+            ->addViolation();
+    }
+}

composer.json

@@ -51,7 +51,8 @@
     "geocoder-php/nominatim-provider": "^5.0",
     "geocoder-php/maxmind-provider": "^4.0",
     "geocoder-php/mapzen-provider": "^4.0",
-    "geocoder-php/mapquest-provider": "^4.0"
+    "geocoder-php/mapquest-provider": "^4.0",
+    "symfony/validator": "^3.3 || ^4.0"
   },
   "conflict":  {
     "willdurand/geocoder": "3.2",