Merge pull request #66 from acelaya-forks/feature/location-default-pa…

…rams

Add default values to Location constructor params

CHANGELOG.md

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 
 ### Changed
 * Update shlinkio coding standard to v2.4
+* Add default values to `Location` constructor params, making it easier to handle with named parameters.
 
 ### Deprecated
 * *Nothing*

src/Model/Location.php

@@ -4,21 +4,27 @@
 
 namespace Shlinkio\Shlink\IpGeolocation\Model;
 
-final class Location
+final readonly class Location
 {
     public function __construct(
-        public readonly string $countryCode,
-        public readonly string $countryName,
-        public readonly string $regionName,
-        public readonly string $city,
-        public readonly float $latitude,
-        public readonly float $longitude,
-        public readonly string $timeZone,
+        public string $countryCode = '',
+        public string $countryName = '',
+        public string $regionName = '',
+        public string $city = '',
+        public float $latitude = 0.0,
+        public float $longitude = 0.0,
+        public string $timeZone = '',
     ) {
     }
 
+    /** @deprecated Use self:.empty() instead */
     public static function emptyInstance(): self
     {
-        return new self('', '', '', '', 0.0, 0.0, '');
+        return self::empty();
+    }
+
+    public static function empty(): self
+    {
+        return new self();
     }
 }

src/Resolver/EmptyIpLocationResolver.php

@@ -14,6 +14,6 @@ class EmptyIpLocationResolver implements IpLocationResolverInterface
      */
     public function resolveIpLocation(string $ipAddress): Model\Location
     {
-        return Model\Location::emptyInstance();
+        return Model\Location::empty();
     }
 }

test/Resolver/ChainIpLocationResolverTest.php

@@ -56,7 +56,7 @@ public function returnsResultOfFirstInnerResolver(): void
             ->expects($this->once())
             ->method('resolveIpLocation')
             ->with($this->equalTo($ipAddress))
-            ->willReturn(Location::emptyInstance());
+            ->willReturn(Location::empty());
         $this->secondInnerResolver->expects($this->never())->method('resolveIpLocation');
 
         $this->resolver->resolveIpLocation($ipAddress);
@@ -76,7 +76,7 @@ public function returnsResultOfSecondInnerResolver(): void
             ->expects($this->once())
             ->method('resolveIpLocation')
             ->with($this->equalTo($ipAddress))
-            ->willReturn(Location::emptyInstance());
+            ->willReturn(Location::empty());
 
         $this->resolver->resolveIpLocation($ipAddress);
     }

test/Resolver/EmptyIpLocationResolverTest.php

@@ -25,7 +25,7 @@ public function setUp(): void
     #[Test, DataProvider('provideEmptyResponses')]
     public function alwaysReturnsAnEmptyLocation(string $ipAddress): void
     {
-        self::assertEquals(Location::emptyInstance(), $this->resolver->resolveIpLocation($ipAddress));
+        self::assertEquals(Location::empty(), $this->resolver->resolveIpLocation($ipAddress));
     }
 
     public static function provideEmptyResponses(): array

test/Resolver/GeoLite2LocationResolverTest.php

@@ -62,6 +62,6 @@ public function resolvedCityIsProperlyMapped(): void
 
         $result = $this->resolver->resolveIpLocation($ipAddress);
 
-        self::assertEquals(Location::emptyInstance(), $result);
+        self::assertEquals(Location::empty(), $result);
     }
 }