Rename Mappable stuff to Geocode stuff, change dir structure

src/Exception/ApiErrorException.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pcm\GeocodeBundle\Exception;
+
+class ApiErrorException extends GeocodeException
+{
+}
+

src/Exception/GeocodeException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pcm\GeocodeBundle\Exception;
+
+class GeocodeException extends \RuntimeException
+{
+    public function __construct(string $postcode, string $message)
+    {
+        $formattedMessage = sprintf("Failed to geocode a postcode \"%s\": %s", $postcode, $message);
+
+        parent::__construct($formattedMessage);
+    }
+}
+

src/Exception/NoResultsFoundException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pcm\GeocodeBundle\Exception;
+
+class NoResultsFoundException extends GeocodeException
+{
+    private const string MESSAGE = "No results found.";
+
+    public function __construct(string $postcode)
+    {
+        parent::__construct($postcode, self::MESSAGE);
+    }
+}
+

src/Interface/Entity/GeocodeInterface.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Pcm\GeocodeBundle\Entity\Interface;
+namespace Pcm\GeocodeBundle\Interface\Entity;
 
-interface MappableInterface
+interface GeocodeInterface
 {
     public function getLatitude(): ?float;
 

src/Model/GeoCoordinates.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pcm\GeocodeBundle\Model;
+
+/**
+ * A model for accessing latitude and longitude values.
+ *
+ * @package Pcm\GeocodeBundle
+ */
+final class GeoCoordinates
+{
+    public function __construct(readonly public float $latitude, readonly public float $longitude) {}
+}
+

src/Model/LatLongModel.php

@@ -1,26 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Pcm\GeocodeBundle\Model;
-
-/**
- * A model for accessing latitude and longitude values
- *
- * @package Pcm\GeocodeBundle
- */
-final class LatLongModel
-{
-    public function __construct(private float $latitude, private float $longitude) {}
-
-    public function getLatitude(): float
-    {
-        return $this->latitude;
-    }
-
-    public function getLongitude(): float
-    {
-        return $this->longitude;
-    }
-}
-

src/Service/Geocoder.php

@@ -4,7 +4,9 @@ declare(strict_types=1);
 
 namespace Pcm\GeocodeBundle\Service;
 
-use Pcm\GeocodeBundle\Model\LatLongModel;
+use Pcm\GeocodeBundle\Exception\ApiErrorException;
+use Pcm\GeocodeBundle\Exception\NoResultsFoundException;
+use Pcm\GeocodeBundle\Model\GeoCoordinates;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
@@ -18,23 +20,23 @@ final class Geocoder
      * Convert a postcode into latitude and longitude. Returns null if conversion failed.
      *
      * @param string $postcode
-     * @return null|LatLongModel
+     * @return null|GeoCoordinates
      */
-    public function geocodePostcode(string $postcode): ?LatLongModel
+    public function geocodePostcode(string $postcode): ?GeoCoordinates
     {
         $client = $this->createClient();
         $response = $this->makeApiRequest($client, $postcode);
         $data = $this->getDataFromResponse($response);
 
-        if (empty($data)) {
-            return null;
-        }
-
         if (array_key_exists('error', $data)) {
-            return null;
+            throw new ApiErrorException($postcode, $data['error']['message']);
         }
 
-        return $this->createLatLongModel($data);
+        if (empty($data)) {
+            throw new NoResultsFoundException($postcode, "No results found.");
+        }
+
+        return $this->createGeoCoordinates($data);
     }
 
     private function createClient(): HttpClientInterface
@@ -63,12 +65,12 @@ final class Geocoder
         return $response->toArray(false);
     }
 
-    private function createLatLongModel(array $data): LatLongModel
+    private function createGeoCoordinates(array $data): GeoCoordinates
     {
         $lat = $this->getLatitudeFromData($data);
         $long = $this->getLongitudeFromData($data);
 
-        return new LatLongModel($lat, $long);
+        return new GeoCoordinates($lat, $long);
     }
 
     private function getLatitudeFromData(array $data): float
@@ -81,3 +83,4 @@ final class Geocoder
         return (float) $data[0]['lon'];
     }
 }
+

src/Trait/Entity/GeocodeTrait.php

@@ -2,18 +2,16 @@
 
 declare(strict_types=1);
 
-namespace Pcm\GeocodeBundle\Entity\Trait;
+namespace Pcm\GeocodeBundle\Trait\Entity;
 
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Allows an entity to be mapped via latitude and longitude coordinates
+ * Implementation of {@see Pcm\GeocodeBundle\Interface\Entity\GeocodeInterface}
- *
- * Use MappableInterface
  *
  * @package Pcm\GeocodeBundle
  */
-trait MappableTrait
+trait GeocodeTrait
 {
     #[ORM\Column(type: 'decimal', precision: 10, scale: 6, nullable: true)]
     private ?float $latitude = null;
@@ -55,3 +53,4 @@ trait MappableTrait
         return null !== $this->getLatitude() && null !== $this->getLongitude();
     }
 }
+

tests/Service/GeocodeTest.php

@@ -4,9 +4,11 @@ declare(strict_types=1);
 
 namespace Pcm\GeocodeBundle\Tests;
 
-use Pcm\GeocodeBundle\Entity\Interface\MappableInterface;
+use Pcm\GeocodeBundle\Interface\Entity\GeocodeInterface;
-use Pcm\GeocodeBundle\Entity\Trait\MappableTrait;
+use Pcm\GeocodeBundle\Trait\Entity\GeocodeTrait;
-use Pcm\GeocodeBundle\Model\LatLongModel;
+use Pcm\GeocodeBundle\Exception\ApiErrorException;
+use Pcm\GeocodeBundle\Exception\NoResultsFoundException;
+use Pcm\GeocodeBundle\Model\GeoCoordinates;
 use Pcm\GeocodeBundle\Service\Geocoder;
 use Pcm\GeocodeBundle\Tests\AppKernel;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
@@ -33,24 +35,45 @@ final class GeocodeTest extends KernelTestCase
         $this->assertInstanceOf(Geocoder::class, $this->geocoder);
     }
 
-    public function testGeocodePostcodeReturnsNullOnInvalidInput(): void
+    public function testGeocodePostcodeThrowsOnEmptyInput(): void
     {
         sleep(1);
-        $this->assertNull($this->geocoder->geocodePostcode(''));
+        $this->expectException(ApiErrorException::class);
+        $this->expectExceptionMessageMatches("/Nothing to search for.$/");
+        $this->geocoder->geocodePostcode('');
     }
 
-    public function testGeocodePostcodeReturnsLatLonModel(): void
+    public function testGeocodePostcodeThrowsOnInvalidPostcode(): void
     {
         sleep(1);
-        $result = $this->geocoder->geocodePostcode(self::POSTCODE);
+        $this->expectException(NoResultsFoundException::class);
-        $this->assertInstanceOf(LatLongModel::class, $result);
+        $this->expectExceptionMessageMatches("/No results found.$/");
+        $this->geocoder->geocodePostcode('ZZZZZZZZZZZZ');
     }
 
-    private function getMappableEntity(): MappableInterface
+    public function testGeocodePostcodeReturnsGeoCoordinates(): GeoCoordinates
     {
-        return new class implements MappableInterface
+        sleep(1);
+        $geoCoords = $this->geocoder->geocodePostcode(self::POSTCODE);
+        $this->assertNotNull($geoCoords);
+
+        return $geoCoords;
+    }
+
+    /**
+     * @depends testGeocodePostcodeReturnsGeoCoordinates
+     */
+    public function testCoordinatesAreSet(GeoCoordinates $geoCoordinates): void
     {
-            use MappableTrait;
+        $this->assertIsFloat($geoCoordinates->latitude);
+        $this->assertIsFloat($geoCoordinates->longitude);
+    }
+
+    private function getGeocodableEntity(): GeocodeInterface
+    {
+        return new class implements GeocodeInterface
+        {
+            use GeocodeTrait;
         };
     }
 }

tests/Trait/GeocodeTraitTest.php

@@ -4,15 +4,15 @@ declare(strict_types=1);
 
 namespace Pcm\GeocodeBundle\Tests;
 
-use Pcm\GeocodeBundle\Entity\Interface\MappableInterface;
+use Pcm\GeocodeBundle\Interface\Entity\GeocodeInterface;
-use Pcm\GeocodeBundle\Entity\Trait\MappableTrait;
+use Pcm\GeocodeBundle\Trait\Entity\GeocodeTrait;
 use PHPUnit\Framework\TestCase;
 
-final class MappableTraitTest extends TestCase
+final class GeocodeTraitTest extends TestCase
 {
     private const float COORD = 123.456;
 
-    private MappableInterface $obj;
+    private GeocodeInterface $obj;
 
     protected function setUp(): void
     {
@@ -21,7 +21,7 @@ final class MappableTraitTest extends TestCase
 
     public function testSetLatitude(): void
     {
-        $this->assertInstanceOf(MappableInterface::class, $this->obj->setLatitude(self::COORD));
+        $this->assertInstanceOf(GeocodeInterface::class, $this->obj->setLatitude(self::COORD));
     }
 
     public function testGetLatitudeReturnsNull(): void
@@ -37,7 +37,7 @@ final class MappableTraitTest extends TestCase
 
     public function testSetLongitude(): void
     {
-        $this->assertInstanceOf(MappableInterface::class, $this->obj->setLongitude(self::COORD));
+        $this->assertInstanceOf(GeocodeInterface::class, $this->obj->setLongitude(self::COORD));
     }
 
     public function testGetLongitudeReturnsNull(): void
@@ -82,11 +82,11 @@ final class MappableTraitTest extends TestCase
         $this->assertTrue($this->obj->isGeocoded());
     }
 
-    private function getTraitObject(): MappableInterface
+    private function getTraitObject(): GeocodeInterface
     {
-        return new class implements MappableInterface
+        return new class implements GeocodeInterface
         {
-            use MappableTrait;
+            use GeocodeTrait;
         };
     }
 }