Update changelog and readme

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
 ## [x.x.x] xxxx-xx-xx
+- Adjust how error messages are formatted
+- Add getGeocodeData method to GeocodeInterface to allow for more abstraction in services
 - Coordinates set to 0, 0 will cause isGeocoded to return false
 
 ## [1.0.0] 2024-08-05

README.md

@@ -2,5 +2,11 @@
 
 Provides an interface/trait combo to add latitude and longitude fields to an entity.
 
-Also included is a `Geocoder` service which accepts a postcode and attempts to return a `GeoCoordinates` object which contains the latitude and longitude of the postcode.
+Also included is a `Geocoder` service which accepts an instance of GeocodeInterface and attempts to return a `GeoCoordinates` object which contains the object's latitude and longitude.
+
+# Usage
+
+Use the `GeocodeTrait` an an entity to give it latitude and longitude fields.
+
+If you wish to geocode an entity you must implement the `GeocodeInterface` interface, the trait will get you most of the way there but you must manually add a `getGeocodeData()` method. The simplest implementation is to return a postcode, but you can return a string of any data if it can be used to find a location.
 

src/Exception/GeocodeException.php

@@ -6,11 +6,5 @@ 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/MissingGeocodeDataException.php

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

src/Exception/NoResultsFoundException.php

@@ -6,11 +6,5 @@ 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/Service/Geocoder.php

@@ -5,6 +5,7 @@ declare(strict_types=1);
 namespace Pcm\GeocodeBundle\Service;
 
 use Pcm\GeocodeBundle\Exception\ApiErrorException;
+use Pcm\GeocodeBundle\Exception\MissingGeocodeDataException;
 use Pcm\GeocodeBundle\Exception\NoResultsFoundException;
 use Pcm\GeocodeBundle\Interface\Entity\GeocodeInterface;
 use Pcm\GeocodeBundle\Model\GeoCoordinates;
@@ -32,17 +33,23 @@ final class Geocoder
      */
     public function geocode(GeocodeInterface $entity): GeoCoordinates
     {
-        $geocodeData = $entity->getGeocodeData();
+        $geocodeData = trim($entity->getGeocodeData());
         $client = $this->createClient();
+
+        if ('' === $geocodeData) {
+            throw new MissingGeocodeDataException('No geocode data present.');
+        }
+
         $response = $this->makeApiRequest($client, $geocodeData);
         $data = $this->getDataFromResponse($response);
 
         if (array_key_exists('error', $data)) {
-            throw new ApiErrorException($geocodeData, $data['error']['message']);
+            throw new ApiErrorException($data['error']['message']);
         }
 
         if (empty($data)) {
-            throw new NoResultsFoundException($geocodeData, "No results found.");
+            $message = sprintf('No results found with geocode data "%s".', $geocodeData);
+            throw new NoResultsFoundException($message);
         }
 
         return $this->createGeoCoordinates($data);

tests/Service/GeocoderTest.php

@@ -4,9 +4,9 @@ declare(strict_types=1);
 
 namespace Pcm\GeocodeBundle\Tests;
 
+use Pcm\GeocodeBundle\Exception\MissingGeocodeDataException;
 use Pcm\GeocodeBundle\Interface\Entity\GeocodeInterface;
 use Pcm\GeocodeBundle\Trait\Entity\GeocodeTrait;
-use Pcm\GeocodeBundle\Exception\ApiErrorException;
 use Pcm\GeocodeBundle\Exception\NoResultsFoundException;
 use Pcm\GeocodeBundle\Model\GeoCoordinates;
 use Pcm\GeocodeBundle\Service\Geocoder;
@@ -33,9 +33,9 @@ final class GeocoderTest extends KernelTestCase
     public function testGeocodeThrowsOnEmptyInput(): void
     {
         sleep(1);
-        $this->expectException(ApiErrorException::class);
+        $this->expectException(MissingGeocodeDataException::class);
         $entity = $this->createEntity('');
-        $this->expectExceptionMessageMatches("/Nothing to search for.$/");
+        $this->expectExceptionMessageMatches("/No geocode data present./");
         $this->geocoder->geocode($entity);
     }
 
@@ -43,7 +43,7 @@ final class GeocoderTest extends KernelTestCase
     {
         sleep(1);
         $this->expectException(NoResultsFoundException::class);
-        $this->expectExceptionMessageMatches("/No results found.$/");
+        $this->expectExceptionMessageMatches("/No results found with geocode data \"Invalid Postcode\"./");
         $entity = $this->createEntity('Invalid Postcode');
         $this->geocoder->geocode($entity);
     }