Add types to tests

Author: alies-dev

tests/CacheTest.php

@@ -13,7 +13,7 @@
 class CacheTest extends TestCase
 {
     /** @test */
-    public function should_return_valid_location()
+    public function should_return_valid_location(): void
     {
         $data = [
             'ip' => '81.2.69.142',
@@ -39,7 +39,7 @@ public function should_return_valid_location()
     }
 
     /** @test */
-    public function should_return_invalid_location()
+    public function should_return_invalid_location(): void
     {
         $cacheMock = Mockery::mock(CacheManager::class)
             ->shouldAllowMockingProtectedMethods();
@@ -55,7 +55,7 @@ public function should_return_invalid_location()
     }
 
     /** @test */
-    public function should_set_location()
+    public function should_set_location(): void
     {
         $location = new \InteractionDesignFoundation\GeoIP\Location([
             'ip' => '81.2.69.142',
@@ -82,16 +82,16 @@ public function should_set_location()
     }
 
     /** @test */
-    public function should_flush_locations()
+    public function should_flush_locations(): void
     {
         $cacheMock = Mockery::mock(CacheManager::class)
             ->shouldAllowMockingProtectedMethods();
+        $cacheMock->shouldReceive('supportsTags')->andReturn(false);
 
         $geo_ip = $this->makeGeoIP([], $cacheMock);
 
         $cacheMock->shouldReceive('flush')->andReturn(true);
 
-        $cacheMock->shouldReceive('tags')->with($geo_ip->config('cache_tags'))->andReturnSelf();
         $cacheMock->shouldReceive('tags')->with($geo_ip->config('cache_tags'))->andReturnSelf();
 
         $this->assertSame($geo_ip->getCache()->flush(), true);

tests/GeoIPTest.php

@@ -10,32 +10,32 @@
 class GeoIPTest extends TestCase
 {
     /** @test */
-    public function should_get_usd_currency()
+    public function should_get_usd_currency(): void
     {
-        $geo_ip = $this->makeGeoIP();
+        $geoIp = $this->makeGeoIP();
 
-        $this->assertSame($geo_ip->getCurrency('US'), 'USD');
+        $this->assertSame($geoIp->getCurrency('US'), 'USD');
     }
 
     /** @test */
-    public function test_get_service()
+    public function get_service_returns_service_instance(): void
     {
-        $geo_ip = $this->makeGeoIP([
+        $geoIp = $this->makeGeoIP([
             'service' => 'maxmind_database',
         ]);
 
         // Get config values
         $config = $this->getConfig()['services']['maxmind_database'];
         unset($config['class']);
 
-        $this->assertInstanceOf(\InteractionDesignFoundation\GeoIP\Contracts\ServiceInterface::class, $geo_ip->getService());
+        $this->assertInstanceOf(\InteractionDesignFoundation\GeoIP\Contracts\ServiceInterface::class, $geoIp->getService());
     }
 
     /** @test */
-    public function test_get_cache()
+    public function get_cache_returns_cache_instance(): void
     {
-        $geo_ip = $this->makeGeoIP();
+        $geoIp = $this->makeGeoIP();
 
-        $this->assertInstanceOf(\InteractionDesignFoundation\GeoIP\Cache::class, $geo_ip->getCache());
+        $this->assertInstanceOf(\InteractionDesignFoundation\GeoIP\Cache::class, $geoIp->getCache());
     }
 }

tests/Services/MaxMindDatabaseTest.php

@@ -12,15 +12,15 @@
 class MaxMindDatabaseTest extends TestCase
 {
     /** @test */
-    public function should_return_config_value()
+    public function should_return_config_value(): void
     {
         list($service, $config) = $this->getService();
 
         $this->assertSame($service->config('database_path'), $config['database_path']);
     }
 
     /** @test */
-    public function should_return_valid_location()
+    public function should_return_valid_location(): void
     {
         [$service] = $this->getService();
 
@@ -32,7 +32,7 @@ public function should_return_valid_location()
     }
 
     /** @test */
-    public function should_return_invalid_location_for_special_addresses()
+    public function should_return_invalid_location_for_special_addresses(): void
     {
         [$service] = $this->getService();
 

tests/TestCase.php

@@ -5,6 +5,7 @@
 namespace InteractionDesignFoundation\GeoIP\Tests;
 
 use Illuminate\Cache\CacheManager;
+use InteractionDesignFoundation\GeoIP\GeoIP;
 use Mockery;
 use PHPUnit\Framework\TestCase as PHPUnitTestCase;
 
@@ -25,7 +26,7 @@ protected function tearDown(): void
         Mockery::close();
     }
 
-    protected function makeGeoIP(array $config = [], $cacheMock = null)
+    protected function makeGeoIP(array $config = [], $cacheMock = null): GeoIP
     {
         $cacheMock = $cacheMock ?: Mockery::mock(CacheManager::class);
         $cacheMock->shouldReceive('supportsTags')->andReturn(false);
@@ -34,10 +35,10 @@ protected function makeGeoIP(array $config = [], $cacheMock = null)
 
         $cacheMock->shouldReceive('tags')->with(['laravel-geoip-location'])->andReturnSelf();
 
-        return new \InteractionDesignFoundation\GeoIP\GeoIP($config, $cacheMock);
+        return new GeoIP($config, $cacheMock);
     }
 
-    protected function getConfig()
+    protected function getConfig(): array
     {
         $config = include(__DIR__ . '/../config/geoip.php');
 
@@ -46,17 +47,12 @@ protected function getConfig()
         return $config;
     }
 
-    /**
-     * Check for test database and make a copy of it
-     * if it does not exist.
-     *
-     * @param string $database
-     */
-    protected function databaseCheck($database)
+    /** Check for a test database and make a copy of it if it does not exist.*/
+    protected function databaseCheck(string $databaseFilepath): void
     {
-        if (file_exists($database) === false) {
-            @mkdir(dirname($database), 0755, true);
-            copy(__DIR__ . '/../resources/geoip.mmdb', $database);
+        if (file_exists($databaseFilepath) === false) {
+            @mkdir(dirname($databaseFilepath), 0755, true);
+            copy(__DIR__ . '/../resources/geoip.mmdb', $databaseFilepath);
         }
     }
 }

tests/TestFunctions.php

@@ -3,14 +3,14 @@
 declare(strict_types=1);
 
 if (!function_exists('storage_path')) {
-    function storage_path($path = '')
+    function storage_path($path = ''): string
     {
         return __DIR__ . DIRECTORY_SEPARATOR . 'tmp' . ($path ? DIRECTORY_SEPARATOR . $path : $path);
     }
 }
 
 if (!function_exists('env')) {
-    function env($key, $default = null)
+    function env($key, $default = null): mixed
     {
         return $key;
     }