Add PHPStan in CI (#1193)

jbelien · norkunas · web-flow · commit 4531c29b83d5 · 2023-07-16T16:36:39.000+02:00
* 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 <norkunas.tom@gmail.com> * Update src/Provider/Cache/Tests/ProviderCacheTest.php Co-authored-by: Tomas Norkūnas <norkunas.tom@gmail.com> * Update src/Provider/Cache/Tests/ProviderCacheTest.php Co-authored-by: Tomas Norkūnas <norkunas.tom@gmail.com> * Update src/Provider/GeoIP2/Tests/GeoIP2Test.php Co-authored-by: Tomas Norkūnas <norkunas.tom@gmail.com> * 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 <norkunas.tom@gmail.com> * Update src/Plugin/PluginProvider.php Co-authored-by: Tomas Norkūnas <norkunas.tom@gmail.com> * Use PHPStan baseline instead of ignore See https://phpstan.org/user-guide/baseline --------- Co-authored-by: Tomas Norkūnas <norkunas.tom@gmail.com>
diff --git a/Model/HereAddress.php b/Model/HereAddress.php
@@ -53,7 +53,7 @@ public function getLocationId()
     }
 
     /**
-     * @param string|null $LocationId
+     * @param string|null $locationId
      *
      * @return HereAddress
      */
@@ -74,7 +74,7 @@ public function getLocationType()
     }
 
     /**
-     * @param string|null $LocationType
+     * @param string|null $locationType
      *
      * @return HereAddress
      */
@@ -95,7 +95,7 @@ public function getLocationName()
     }
 
     /**
-     * @param string|null $LocationName
+     * @param string|null $locationName
      *
      * @return HereAddress
      */
diff --git a/Tests/HereTest.php b/Tests/HereTest.php
@@ -21,6 +21,7 @@
 use Geocoder\Query\GeocodeQuery;
 use Geocoder\Query\ReverseQuery;
 use Geocoder\Provider\Here\Here;
+use Geocoder\Provider\Here\Model\HereAddress;
 
 class HereTest extends BaseTestCase
 {
@@ -81,7 +82,7 @@ public function testGeocodeWithDefaultAdditionalData()
         $this->assertInstanceOf('Geocoder\Model\AddressCollection', $results);
         $this->assertCount(1, $results);
 
-        /** @var Location $result */
+        /** @var HereAddress $result */
         $result = $results->first();
 
         $this->assertInstanceOf('\Geocoder\Model\Address', $result);
@@ -127,7 +128,7 @@ public function testGeocodeWithAdditionalData()
         $this->assertInstanceOf('Geocoder\Model\AddressCollection', $results);
         $this->assertCount(1, $results);
 
-        /** @var Location $result */
+        /** @var HereAddress $result */
         $result = $results->first();
         $this->assertInstanceOf('\Geocoder\Model\Address', $result);
         $this->assertEqualsWithDelta(41.37854, $result->getCoordinates()->getLatitude(), 0.01);
@@ -250,7 +251,9 @@ public function testGeocodeWithExtraFilterCounty()
         $this->assertInstanceOf('Geocoder\Model\AddressCollection', $resultsRegion1);
         $this->assertInstanceOf('Geocoder\Model\AddressCollection', $resultsRegion2);
 
+        /** @var HereAddress $resultRegion1 */
         $resultRegion1 = $resultsRegion1->first();
+        /** @var HereAddress $resultRegion2 */
         $resultRegion2 = $resultsRegion2->first();
 
         $this->assertEquals('Cabanes', $resultRegion1->getLocality());
diff --git a/Tests/IntegrationTest.php b/Tests/IntegrationTest.php
@@ -29,16 +29,16 @@
  */
 class IntegrationTest extends ProviderIntegrationTest
 {
-    protected $testIpv4 = false;
+    protected bool $testIpv4 = false;
 
-    protected $testIpv6 = false;
+    protected bool $testIpv6 = false;
 
     protected function createProvider(ClientInterface $httpClient, bool $useCIT = false)
     {
         return Here::createUsingApiKey($httpClient, $this->getApiKey(), $useCIT);
     }
 
-    protected function getCacheDir()
+    protected function getCacheDir(): string
     {
         return __DIR__.'/.cached_responses';
     }
@@ -64,25 +64,25 @@ private function getCachedHttpClient()
         return new CachedResponseClient($client, $this->getCacheDir(), $this->getApiKey());
     }
 
-    protected function getApiKey()
+    protected function getApiKey(): string
     {
         return $_SERVER['HERE_APP_ID'];
     }
 
-    protected function getAppId()
+    protected function getAppId(): string
     {
         return $_SERVER['HERE_APP_ID'];
     }
 
     /**
      * @return string the Here AppCode or substring to be removed from cache
      */
-    protected function getAppCode()
+    protected function getAppCode(): string
     {
         return $_SERVER['HERE_APP_CODE'];
     }
 
-    public function testGeocodeQuery()
+    public function testGeocodeQuery(): void
     {
         if (isset($this->skippedTests[__FUNCTION__])) {
             $this->markTestSkipped($this->skippedTests[__FUNCTION__]);
@@ -107,7 +107,7 @@ public function testGeocodeQuery()
         }
     }
 
-    public function testGeocodeQueryCIT()
+    public function testGeocodeQueryCIT(): void
     {
         if (isset($this->skippedTests[__FUNCTION__])) {
             $this->markTestSkipped($this->skippedTests[__FUNCTION__]);
@@ -132,7 +132,7 @@ public function testGeocodeQueryCIT()
         }
     }
 
-    public function testGeocodeQueryWithNoResults()
+    public function testGeocodeQueryWithNoResults(): void
     {
         if (isset($this->skippedTests[__FUNCTION__])) {
             $this->markTestSkipped($this->skippedTests[__FUNCTION__]);
@@ -148,7 +148,7 @@ public function testGeocodeQueryWithNoResults()
         $this->assertEquals(0, $result->count());
     }
 
-    public function testReverseQuery()
+    public function testReverseQuery(): void
     {
         if (isset($this->skippedTests[__FUNCTION__])) {
             $this->markTestSkipped($this->skippedTests[__FUNCTION__]);
@@ -164,7 +164,7 @@ public function testReverseQuery()
         $this->assertWellFormattedResult($result);
     }
 
-    public function testReverseQueryCIT()
+    public function testReverseQueryCIT(): void
     {
         if (isset($this->skippedTests[__FUNCTION__])) {
             $this->markTestSkipped($this->skippedTests[__FUNCTION__]);
@@ -180,7 +180,7 @@ public function testReverseQueryCIT()
         $this->assertWellFormattedResult($result);
     }
 
-    public function testReverseQueryWithNoResults()
+    public function testReverseQueryWithNoResults(): void
     {
         if (isset($this->skippedTests[__FUNCTION__])) {
             $this->markTestSkipped($this->skippedTests[__FUNCTION__]);

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public function getLocationId()`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`/**`
`56`		`- * @param string\|null $LocationId`
	`56`	`+ * @param string\|null $locationId`
`57`	`57`	`*`
`58`	`58`	`* @return HereAddress`
`59`	`59`	`*/`
`@@ -74,7 +74,7 @@ public function getLocationType()`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`/**`
`77`		`- * @param string\|null $LocationType`
	`77`	`+ * @param string\|null $locationType`
`78`	`78`	`*`
`79`	`79`	`* @return HereAddress`
`80`	`80`	`*/`
`@@ -95,7 +95,7 @@ public function getLocationName()`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`/**`
`98`		`- * @param string\|null $LocationName`
	`98`	`+ * @param string\|null $locationName`
`99`	`99`	`*`
`100`	`100`	`* @return HereAddress`
`101`	`101`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -29,16 +29,16 @@`
`29`	`29`	`*/`
`30`	`30`	`class IntegrationTest extends ProviderIntegrationTest`
`31`	`31`	`{`
`32`		`- protected $testIpv4 = false;`
	`32`	`+ protected bool $testIpv4 = false;`
`33`	`33`
`34`		`- protected $testIpv6 = false;`
	`34`	`+ protected bool $testIpv6 = false;`
`35`	`35`
`36`	`36`	`protected function createProvider(ClientInterface $httpClient, bool $useCIT = false)`
`37`	`37`	`{`
`38`	`38`	`return Here::createUsingApiKey($httpClient, $this->getApiKey(), $useCIT);`
`39`	`39`	`}`
`40`	`40`
`41`		`- protected function getCacheDir()`
	`41`	`+ protected function getCacheDir(): string`
`42`	`42`	`{`
`43`	`43`	`return __DIR__.'/.cached_responses';`
`44`	`44`	`}`
`@@ -64,25 +64,25 @@ private function getCachedHttpClient()`
`64`	`64`	`return new CachedResponseClient($client, $this->getCacheDir(), $this->getApiKey());`
`65`	`65`	`}`
`66`	`66`
`67`		`- protected function getApiKey()`
	`67`	`+ protected function getApiKey(): string`
`68`	`68`	`{`
`69`	`69`	`return $_SERVER['HERE_APP_ID'];`
`70`	`70`	`}`
`71`	`71`
`72`		`- protected function getAppId()`
	`72`	`+ protected function getAppId(): string`
`73`	`73`	`{`
`74`	`74`	`return $_SERVER['HERE_APP_ID'];`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`/**`
`78`	`78`	`* @return string the Here AppCode or substring to be removed from cache`
`79`	`79`	`*/`
`80`		`- protected function getAppCode()`
	`80`	`+ protected function getAppCode(): string`
`81`	`81`	`{`
`82`	`82`	`return $_SERVER['HERE_APP_CODE'];`
`83`	`83`	`}`
`84`	`84`
`85`		`- public function testGeocodeQuery()`
	`85`	`+ public function testGeocodeQuery(): void`
`86`	`86`	`{`
`87`	`87`	`if (isset($this->skippedTests[__FUNCTION__])) {`
`88`	`88`	`$this->markTestSkipped($this->skippedTests[__FUNCTION__]);`
`@@ -107,7 +107,7 @@ public function testGeocodeQuery()`
`107`	`107`	`}`
`108`	`108`	`}`
`109`	`109`
`110`		`- public function testGeocodeQueryCIT()`
	`110`	`+ public function testGeocodeQueryCIT(): void`
`111`	`111`	`{`
`112`	`112`	`if (isset($this->skippedTests[__FUNCTION__])) {`
`113`	`113`	`$this->markTestSkipped($this->skippedTests[__FUNCTION__]);`
`@@ -132,7 +132,7 @@ public function testGeocodeQueryCIT()`
`132`	`132`	`}`
`133`	`133`	`}`
`134`	`134`
`135`		`- public function testGeocodeQueryWithNoResults()`
	`135`	`+ public function testGeocodeQueryWithNoResults(): void`
`136`	`136`	`{`
`137`	`137`	`if (isset($this->skippedTests[__FUNCTION__])) {`
`138`	`138`	`$this->markTestSkipped($this->skippedTests[__FUNCTION__]);`
`@@ -148,7 +148,7 @@ public function testGeocodeQueryWithNoResults()`
`148`	`148`	`$this->assertEquals(0, $result->count());`
`149`	`149`	`}`
`150`	`150`
`151`		`- public function testReverseQuery()`
	`151`	`+ public function testReverseQuery(): void`
`152`	`152`	`{`
`153`	`153`	`if (isset($this->skippedTests[__FUNCTION__])) {`
`154`	`154`	`$this->markTestSkipped($this->skippedTests[__FUNCTION__]);`
`@@ -164,7 +164,7 @@ public function testReverseQuery()`
`164`	`164`	`$this->assertWellFormattedResult($result);`
`165`	`165`	`}`
`166`	`166`
`167`		`- public function testReverseQueryCIT()`
	`167`	`+ public function testReverseQueryCIT(): void`
`168`	`168`	`{`
`169`	`169`	`if (isset($this->skippedTests[__FUNCTION__])) {`
`170`	`170`	`$this->markTestSkipped($this->skippedTests[__FUNCTION__]);`
`@@ -180,7 +180,7 @@ public function testReverseQueryCIT()`
`180`	`180`	`$this->assertWellFormattedResult($result);`
`181`	`181`	`}`
`182`	`182`
`183`		`- public function testReverseQueryWithNoResults()`
	`183`	`+ public function testReverseQueryWithNoResults(): void`
`184`	`184`	`{`
`185`	`185`	`if (isset($this->skippedTests[__FUNCTION__])) {`
`186`	`186`	`$this->markTestSkipped($this->skippedTests[__FUNCTION__]);`