Add PHPStan in CI (#1193)

* Add PHPStan

* Update php.yml

* Update composer.json

* Fix PHPStan level 0

* Fix PHPStan level 1

* Update phpstan.neon

* Fix PHPStan level 2

* Update composer.json

* Fix PHPStan level 3

* Fix tests

* Fix PHPStan level 4

* Update src/Common/Tests/TimedGeocoderTest.php

Co-authored-by: Tomas Norkūnas <[email protected]>

* Update src/Provider/Cache/Tests/ProviderCacheTest.php

Co-authored-by: Tomas Norkūnas <[email protected]>

* Update src/Provider/Cache/Tests/ProviderCacheTest.php

Co-authored-by: Tomas Norkūnas <[email protected]>

* Update src/Provider/GeoIP2/Tests/GeoIP2Test.php

Co-authored-by: Tomas Norkūnas <[email protected]>

* Fix PHPStan level 5

* Normalize composer.json

* Rename analyse script

* Update composer.json

* Update IntegrationTest

* Update AlgoliaPlacesTest

* Update composer.json

* Update RequestInterface vs. getParsedResponse()

* Update src/Plugin/PluginProvider.php

Co-authored-by: Tomas Norkūnas <[email protected]>

* Update src/Plugin/PluginProvider.php

Co-authored-by: Tomas Norkūnas <[email protected]>

* Use PHPStan baseline instead of ignore

See https://phpstan.org/user-guide/baseline

---------

Co-authored-by: Tomas Norkūnas <[email protected]>

Author: jbelien

Photon.php

@@ -77,7 +77,7 @@ public function geocodeQuery(GeocodeQuery $query): Collection
                 'lang' => $query->getLocale(),
             ]);
 
-        $json = $this->executeQuery($url, $query->getLocale());
+        $json = $this->executeQuery($url);
 
         if (!isset($json->features) || empty($json->features)) {
             return new AddressCollection([]);
@@ -149,7 +149,9 @@ private function featureToAddress(\stdClass $feature): Location
         }
 
         /** @var PhotonAddress $address */
-        $address = $builder->build(PhotonAddress::class)
+        $address = $builder->build(PhotonAddress::class);
+
+        $address = $address
             ->withOSMId($properties->osm_id ?? null)
             ->withOSMType($properties->osm_type ?? null)
             ->withOSMTag(

Tests/IntegrationTest.php

@@ -19,31 +19,31 @@
  */
 class IntegrationTest extends ProviderIntegrationTest
 {
-    protected $testAddress = true;
+    protected bool $testAddress = true;
 
-    protected $testReverse = true;
+    protected bool $testReverse = true;
 
-    protected $testIpv4 = false;
+    protected bool $testIpv4 = false;
 
-    protected $testIpv6 = false;
+    protected bool $testIpv6 = false;
 
-    protected $skippedTests = [
+    protected array $skippedTests = [
         'testGeocodeQuery' => 'Photon API returns "Great George Street" for "10 Downing St, London, UK" query.',
         'testReverseQueryWithNoResults' => 'Photon API returns "Atlas Buoy 0.00E 0.00N" for reverse query at 0,0.',
     ];
 
     protected function createProvider(ClientInterface $httpClient)
     {
-        return Photon::withKomootServer($httpClient, 'Geocoder PHP/Photon Provider/Integration Test');
+        return Photon::withKomootServer($httpClient);
     }
 
-    protected function getCacheDir()
+    protected function getCacheDir(): string
     {
         return __DIR__.'/.cached_responses';
     }
 
-    protected function getApiKey()
+    protected function getApiKey(): string
     {
-        return null;
+        return '';
     }
 }

Tests/PhotonTest.php

@@ -62,8 +62,8 @@ public function testGeocodeQuery()
         /** @var \Geocoder\Provider\Photon\Model\PhotonAddress $result */
         $result = $results->first();
         $this->assertInstanceOf('\Geocoder\Model\Address', $result);
-        $this->assertEquals(48.8631927, $result->getCoordinates()->getLatitude(), '', 0.00001);
-        $this->assertEquals(2.3890894, $result->getCoordinates()->getLongitude(), '', 0.00001);
+        $this->assertEqualsWithDelta(48.8631927, $result->getCoordinates()->getLatitude(), 0.00001);
+        $this->assertEqualsWithDelta(2.3890894, $result->getCoordinates()->getLongitude(), 0.00001);
         $this->assertEquals('10', $result->getStreetNumber());
         $this->assertEquals('Avenue Gambetta', $result->getStreetName());
         $this->assertEquals('75020', $result->getPostalCode());
@@ -105,8 +105,8 @@ public function testReverseQuery()
         /** @var \Geocoder\Provider\Photon\Model\PhotonAddress $result */
         $result = $results->first();
         $this->assertInstanceOf('\Geocoder\Model\Address', $result);
-        $this->assertEquals(51.9982968, $result->getCoordinates()->getLatitude(), '', 0.00001);
-        $this->assertEquals(9.998645, $result->getCoordinates()->getLongitude(), '', 0.00001);
+        $this->assertEqualsWithDelta(51.9982968, $result->getCoordinates()->getLatitude(), 0.00001);
+        $this->assertEqualsWithDelta(9.998645, $result->getCoordinates()->getLongitude(), 0.00001);
         $this->assertEquals('31195', $result->getPostalCode());
         $this->assertEquals('Lamspringe', $result->getLocality());
         $this->assertEquals('Deutschland', $result->getCountry()->getName());