Compare commits

..

4 Commits
0.0.4 ... 0.0.7

Author SHA1 Message Date
Brabli
57796a6fdb Return null instead of throwing 2022-10-17 15:46:19 +01:00
Brabli
31d29f2460 Fix broken latlong model 2022-10-17 15:38:10 +01:00
Brabli
6edbed9dfe Add attributes above lat long properties 2022-10-17 12:21:35 +01:00
Brabli
3c23d5e88d Require doctrine orm 2022-10-17 12:21:07 +01:00
5 changed files with 17 additions and 16 deletions

View File

@@ -18,7 +18,8 @@
"symfony/http-client": "^6.1", "symfony/http-client": "^6.1",
"symfony/dependency-injection": "^6.1", "symfony/dependency-injection": "^6.1",
"symfony/framework-bundle": "^6.1", "symfony/framework-bundle": "^6.1",
"symfony/yaml": "^6.1" "symfony/yaml": "^6.1",
"doctrine/orm": "^2.13"
}, },
"require-dev": { "require-dev": {

View File

@@ -4,6 +4,8 @@ declare(strict_types=1);
namespace Pcm\GeocodeBundle\Entity\Trait; namespace Pcm\GeocodeBundle\Entity\Trait;
use Doctrine\ORM\Mapping as ORM;
/** /**
* Allows an entity to be mapped via latitude and longitude coordinates * Allows an entity to be mapped via latitude and longitude coordinates
* *
@@ -13,8 +15,10 @@ namespace Pcm\GeocodeBundle\Entity\Trait;
*/ */
trait MappableTrait trait MappableTrait
{ {
#[ORM\Column(type: 'decimal', precision: 10, scale: 6, nullable: true)]
private ?float $latitude = null; private ?float $latitude = null;
#[ORM\Column(type: 'decimal', precision: 10, scale: 6, nullable: true)]
private ?float $longitude = null; private ?float $longitude = null;
public function getLatitude(): ?float public function getLatitude(): ?float

View File

@@ -15,11 +15,11 @@ class LatLongModel
public function getLatitude(): float public function getLatitude(): float
{ {
return $this->getLatitude(); return $this->latitude;
} }
public function getLongitude(): float public function getLongitude(): float
{ {
return $this->getLongitude(); return $this->longitude;
} }
} }

View File

@@ -15,17 +15,20 @@ class Geocoder
public function __construct(private HttpClientInterface $client) {} public function __construct(private HttpClientInterface $client) {}
/** /**
* Convert a postcode into latitude and longitude * Convert a postcode into latitude and longitude. Returns null if conversion failed.
* *
* @param string $postcode * @param string $postcode
* @return LatLongModel * @return null|LatLongModel
*/ */
public function geocodePostcode(string $postcode): LatLongModel public function geocodePostcode(string $postcode): ?LatLongModel
{ {
$client = $this->createClient(); $client = $this->createClient();
$response = $this->makeApiRequest($client, $postcode); $response = $this->makeApiRequest($client, $postcode);
$data = $this->getDataFromResponse($response); $data = $this->getDataFromResponse($response);
$this->throwIfDataIsEmpty($data);
if (empty($data)) {
return null;
}
return $this->createLatLongModel($data); return $this->createLatLongModel($data);
} }
@@ -56,12 +59,6 @@ class Geocoder
return $response->toArray(false); return $response->toArray(false);
} }
private function throwIfDataIsEmpty(array $data): void
{
if (empty($data))
throw new \Exception("No data was received from API response! Were the arguments valid?");
}
private function createLatLongModel(array $data): LatLongModel private function createLatLongModel(array $data): LatLongModel
{ {
$lat = $this->getLatitudeFromData($data); $lat = $this->getLatitudeFromData($data);

View File

@@ -33,11 +33,10 @@ class GeocodeTest extends KernelTestCase
$this->assertInstanceOf(Geocoder::class, $this->geocoder); $this->assertInstanceOf(Geocoder::class, $this->geocoder);
} }
public function testGeocodePostcodeThrowsOnInvalidInput(): void public function testGeocodePostcodeReturnsNullOnInvalidInput(): void
{ {
sleep(1); sleep(1);
$this->expectException(\Exception::class); $this->assertNull($this->geocoder->geocodePostcode(''));
$this->geocoder->geocodePostcode('aaaaaaaa');
} }
public function testGeocodePostcodeReturnsLatLonModel(): void public function testGeocodePostcodeReturnsLatLonModel(): void