Merge pull request #24 from InteractionDesignFoundation/array-shape

alies-dev · web-flow · commit e3b43b5f49c4 · 2024-02-24T09:53:00.000+01:00
Describe Location array shape
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,9 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <files psalm-version="5.22.2@d768d914152dbbf3486c36398802f74e80cfde48">
   <file src="src/Cache.php">
-    <MixedAssignment>
-      <code><![CDATA[$value]]></code>
-    </MixedAssignment>
     <MixedInferredReturnType>
       <code><![CDATA[bool]]></code>
     </MixedInferredReturnType>
@@ -64,6 +61,12 @@
       <code><![CDATA[Update]]></code>
     </PropertyNotSetInConstructor>
   </file>
+  <file src="src/Contracts/ServiceInterface.php">
+    <InvalidParamDefault>
+      <code><![CDATA[LocationArray]]></code>
+      <code><![CDATA[LocationArray]]></code>
+    </InvalidParamDefault>
+  </file>
   <file src="src/GeoIP.php">
     <DeprecatedMethod>
       <code><![CDATA[setPrefix]]></code>
@@ -94,6 +97,9 @@
       <code><![CDATA[$this->config('cache_tags')]]></code>
       <code><![CDATA[$this->config('default_location', [])]]></code>
     </MixedArgument>
+    <MixedArgumentTypeCoercion>
+      <code><![CDATA[$this->default_location]]></code>
+    </MixedArgumentTypeCoercion>
     <MixedAssignment>
       <code><![CDATA[$class]]></code>
       <code><![CDATA[$config]]></code>
@@ -166,6 +172,9 @@
     </UndefinedFunction>
   </file>
   <file src="src/Location.php">
+    <InvalidParamDefault>
+      <code><![CDATA[LocationArray]]></code>
+    </InvalidParamDefault>
     <MissingParamType>
       <code><![CDATA[$key]]></code>
       <code><![CDATA[$value]]></code>
@@ -196,6 +205,21 @@
       <code><![CDATA[$this->config('continent_path')]]></code>
       <code><![CDATA[$this->config('continent_path')]]></code>
     </MixedArgument>
+    <MixedArgumentTypeCoercion>
+      <code><![CDATA[[
+            'ip' => $ip,
+            'iso_code' => $json->countryCode,
+            'country' => $json->country,
+            'city' => $json->city,
+            'state' => $json->region,
+            'state_name' => $json->regionName,
+            'postal_code' => $json->zip,
+            'lat' => $json->lat,
+            'lon' => $json->lon,
+            'timezone' => $json->timezone,
+            'continent' => $this->getContinent($json->countryCode),
+        ]]]></code>
+    </MixedArgumentTypeCoercion>
     <MixedAssignment>
       <code><![CDATA[$base['query']['key']]]></code>
       <code><![CDATA[$json]]></code>
@@ -242,6 +266,22 @@
       <code><![CDATA[$json]]></code>
       <code><![CDATA[$json]]></code>
     </MixedArgument>
+    <MixedArgumentTypeCoercion>
+      <code><![CDATA[[
+            'ip' => $ip,
+            'iso_code' => $json['country_code'],
+            'country' => $json['country_name'],
+            'city' => $json['city'],
+            'state' => $json['region_code'],
+            'state_name' => $json['region'],
+            'postal_code' => $json['postal'],
+            'lat' => $json['latitude'],
+            'lon' => $json['longitude'],
+            'timezone' => Arr::get($json, 'time_zone.name'),
+            'continent' => Arr::get($json, 'continent_code'),
+            'currency' => Arr::get($json, 'currency.code'),
+        ]]]></code>
+    </MixedArgumentTypeCoercion>
     <MixedArrayAccess>
       <code><![CDATA[$json['city']]]></code>
       <code><![CDATA[$json['country_code']]]></code>
@@ -287,30 +327,25 @@
     </RedundantConditionGivenDocblockType>
   </file>
   <file src="src/Services/MaxMindDatabase.php">
-    <ImplicitToStringCast>
-      <code><![CDATA[$file]]></code>
-    </ImplicitToStringCast>
     <MissingClosureParamType>
       <code><![CDATA[$directory]]></code>
     </MissingClosureParamType>
     <MixedArgument>
       <code><![CDATA[$directory]]></code>
       <code><![CDATA[$directory]]></code>
-      <code><![CDATA[$path]]></code>
-      <code><![CDATA[$path]]></code>
-      <code><![CDATA[$path]]></code>
-      <code><![CDATA[$path]]></code>
       <code><![CDATA[$this->config('database_path')]]></code>
       <code><![CDATA[$this->config('locales', ['en'])]]></code>
       <code><![CDATA[$this->config('update_url')]]></code>
     </MixedArgument>
     <MixedAssignment>
       <code><![CDATA[$file]]></code>
-      <code><![CDATA[$path]]></code>
     </MixedAssignment>
     <MixedMethodCall>
       <code><![CDATA[getFilename]]></code>
     </MixedMethodCall>
+    <PossiblyInvalidArgument>
+      <code><![CDATA[$file]]></code>
+    </PossiblyInvalidArgument>
     <PossiblyInvalidMethodCall>
       <code><![CDATA[getPathName]]></code>
       <code><![CDATA[isDir]]></code>
@@ -327,12 +362,7 @@
     <DocblockTypeContradiction>
       <code><![CDATA[is_null($this->errors)]]></code>
     </DocblockTypeContradiction>
-    <InvalidScalarArgument>
-      <code><![CDATA[$response]]></code>
-      <code><![CDATA[$response]]></code>
-    </InvalidScalarArgument>
     <MixedArgument>
-      <code><![CDATA[$header_size]]></code>
       <code><![CDATA[$header_size]]></code>
       <code><![CDATA[Arr::get($this->config, 'headers', [])]]></code>
       <code><![CDATA[Arr::get($this->config, 'query', [])]]></code>
@@ -355,7 +385,7 @@
   </file>
   <file src="src/helpers.php">
     <MixedInferredReturnType>
-      <code><![CDATA[\InteractionDesignFoundation\GeoIP\GeoIP|\InteractionDesignFoundation\GeoIP\Location]]></code>
+      <code><![CDATA[($ip is null ? \InteractionDesignFoundation\GeoIP\GeoIP : \InteractionDesignFoundation\GeoIP\Location)]]></code>
     </MixedInferredReturnType>
     <MixedMethodCall>
       <code><![CDATA[getLocation]]></code>
diff --git a/src/Cache.php b/src/Cache.php
@@ -6,6 +6,9 @@
 
 use Illuminate\Cache\CacheManager;
 
+/**
+ * @psalm-import-type LocationArray from \InteractionDesignFoundation\GeoIP\Location
+ */
 class Cache
 {
     /**
@@ -56,6 +59,7 @@ public function setPrefix(?string $prefix = null): void
      */
     public function get($name)
     {
+        /** @psalm-var LocationArray|null $value */
         $value = $this->cache->get($this->prefix . $name);
 
         return is_array($value)
diff --git a/src/Contracts/ServiceInterface.php b/src/Contracts/ServiceInterface.php
@@ -4,6 +4,9 @@
 
 namespace InteractionDesignFoundation\GeoIP\Contracts;
 
+/**
+ * @psalm-import-type LocationArray from \InteractionDesignFoundation\GeoIP\Location
+ */
 interface ServiceInterface
 {
     /**
@@ -27,6 +30,7 @@ public function locate($ip);
      * Create a location instance from the provided attributes.
      *
      * @param array $attributes
+     * @psalm-param LocationArray $attributes
      *
      * @return \InteractionDesignFoundation\GeoIP\Location
      */
diff --git a/src/GeoIP.php b/src/GeoIP.php
@@ -10,6 +10,9 @@
 use Illuminate\Cache\CacheManager;
 use Monolog\Handler\StreamHandler;
 
+/**
+ * @psalm-import-type LocationArray from \InteractionDesignFoundation\GeoIP\Location
+ */
 class GeoIP
 {
     /**
diff --git a/src/Location.php b/src/Location.php
@@ -26,6 +26,24 @@
  * @property bool $default
  * @property bool $cached
  * @property-read string $displayName {@see static::getDisplayNameAttribute()}
+ *
+ * @psalm-type LocationArray = array{
+ *     ip: string,
+ *     iso_code: string|null,
+ *     country: string|null,
+ *     city: string|null,
+ *     state: string|null,
+ *     state_name: string|null,
+ *     postal_code: string|null,
+ *     lat: float|null,
+ *     lon: float|null,
+ *     timezone: string|null,
+ *     continent: string|null,
+ *     currency?: string|null,
+ *     default?: bool,
+ *     cached?: bool,
+ * }
+ * How to use it: @@psalm-import-type LocationArray from \InteractionDesignFoundation\GeoIP\Location
  */
 class Location implements ArrayAccess
 {
@@ -40,6 +58,7 @@ class Location implements ArrayAccess
      * Create a new location instance.
      *
      * @param array $attributes
+     * @psalm-param LocationArray $attributes
      */
     public function __construct(array $attributes = [])
     {
diff --git a/src/Services/IPApi.php b/src/Services/IPApi.php
@@ -34,7 +34,7 @@ public function boot()
         $base = [
             'base_uri' => 'http://ip-api.com/',
             'headers' => [
-                'User-Agent' => 'Laravel-GeoIP',
+                'User-Agent' => 'Laravel-GeoIP-InteractionDesignFoundation',
             ],
             'query' => [
                 'fields' => 49663,
diff --git a/src/Support/HttpClient.php b/src/Support/HttpClient.php
@@ -72,7 +72,9 @@ public function get($url, array $query = [], array $headers = [])
      * @param array $query
      * @param array $headers
      *
-     * @return array
+     * @return array{string, array}
+     *
+     * @throws \RuntimeException
      */
     public function execute($method, $url, array $query = [], array $headers = [])
     {
@@ -119,6 +121,10 @@ public function execute($method, $url, array $query = [], array $headers = [])
         // Make request
         curl_setopt($curl, CURLOPT_HEADER, true);
         $response = curl_exec($curl);
+        if (! is_string($response)) {
+            $curlError = curl_error($curl);
+            throw new \RuntimeException("Failed to make {$method} HTTP request: {$curlError}");
+        }
 
         // Set HTTP response code
         $this->http_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,9 @@`
`6`	`6`
`7`	`7`	`use Illuminate\Cache\CacheManager;`
`8`	`8`
	`9`	`+/**`
	`10`	`+ * @psalm-import-type LocationArray from \InteractionDesignFoundation\GeoIP\Location`
	`11`	`+ */`
`9`	`12`	`class Cache`
`10`	`13`	`{`
`11`	`14`	`/**`
`@@ -56,6 +59,7 @@ public function setPrefix(?string $prefix = null): void`
`56`	`59`	`*/`
`57`	`60`	`public function get($name)`
`58`	`61`	`{`
	`62`	`+ /** @psalm-var LocationArray\|null $value */`
`59`	`63`	`$value = $this->cache->get($this->prefix . $name);`
`60`	`64`
`61`	`65`	`return is_array($value)`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,9 @@`
`4`	`4`
`5`	`5`	`namespace InteractionDesignFoundation\GeoIP\Contracts;`
`6`	`6`
	`7`	`+/**`
	`8`	`+ * @psalm-import-type LocationArray from \InteractionDesignFoundation\GeoIP\Location`
	`9`	`+ */`
`7`	`10`	`interface ServiceInterface`
`8`	`11`	`{`
`9`	`12`	`/**`
`@@ -27,6 +30,7 @@ public function locate($ip);`
`27`	`30`	`* Create a location instance from the provided attributes.`
`28`	`31`	`*`
`29`	`32`	`* @param array $attributes`
	`33`	`+ * @psalm-param LocationArray $attributes`
`30`	`34`	`*`
`31`	`35`	`* @return \InteractionDesignFoundation\GeoIP\Location`
`32`	`36`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,9 @@`
`10`	`10`	`use Illuminate\Cache\CacheManager;`
`11`	`11`	`use Monolog\Handler\StreamHandler;`
`12`	`12`
	`13`	`+/**`
	`14`	`+ * @psalm-import-type LocationArray from \InteractionDesignFoundation\GeoIP\Location`
	`15`	`+ */`
`13`	`16`	`class GeoIP`
`14`	`17`	`{`
`15`	`18`	`/**`