Add automated coding standard checks and Static Analysis

Author: Torann

.gitignore

@@ -1,5 +1,6 @@
 /vendor
 composer.phar
 composer.lock
+.phpunit.result.cache
 .DS_Store
 .idea/*

.travis.yml

@@ -9,4 +9,7 @@ before_script:
   - curl -s http://getcomposer.org/installer | php
   - php composer.phar install --dev
 
-script: php ./vendor/bin/phpunit
+script:
+  - ./vendor/bin/phpunit
+  - ./vendor/bin/phpcs --standard=phpcs.xml src
+  - ./vendor/bin/phpstan --level=0 --no-progress analyse src

composer.json

@@ -20,7 +20,8 @@
   "require": {
     "php": "^7.2",
     "illuminate/support": "^6.0|^7.0",
-    "illuminate/console": "^6.0|^7.0"
+    "illuminate/console": "^6.0|^7.0",
+    "illuminate/cache": "^6.0|^7.0"
   },
   "suggest": {
     "geoip2/geoip2": "Required to use the MaxMind database or web service with GeoIP (~2.1).",
@@ -30,7 +31,9 @@
     "phpunit/phpunit": "^8.0",
     "mockery/mockery": "^1.3",
     "geoip2/geoip2": "~2.1",
-    "vlucas/phpdotenv": "^4.0"
+    "vlucas/phpdotenv": "^4.0",
+    "phpstan/phpstan": "^0.12.14",
+    "squizlabs/php_codesniffer": "^3.5"
   },
   "autoload": {
     "files": [

phpcs.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0"?>
+<ruleset name="PSR2-package">
+    <description>The PSR2 standard</description>
+
+    <!-- use preg_match https://github.com/squizlabs/PHP_CodeSniffer/issues/742#issuecomment-215250517 -->
+    <exclude-pattern>/resources/</exclude-pattern>
+    <exclude-pattern>/vendor/</exclude-pattern>
+    <exclude-pattern>/_[a-zA-Z0-9\._]+\.php</exclude-pattern>
+    <exclude-pattern>/\.[a-zA-Z0-9\._]+\.php</exclude-pattern>
+    <exclude-pattern>\.git</exclude-pattern>
+
+    <!-- Include the whole PSR2 standard -->
+    <rule ref="PSR2">
+        <exclude name="PSR1.Methods.CamelCapsMethodName"/>
+        <exclude name="PSR2.Files.EndFileNewline"/>
+        <exclude name="PSR2.Methods.FunctionCallSignature.MultipleArguments"/>
+        <exclude name="Squiz.ControlStructures.ControlSignature.SpaceAfterCloseBrace"/>
+    </rule>
+
+    <!-- Lines can be longer -->
+    <rule ref="Generic.Files.LineLength">
+        <properties>
+            <property name="lineLimit" value="9999"/>
+        </properties>
+    </rule>
+</ruleset>

phpstan.neon

@@ -0,0 +1,10 @@
+parameters:
+    excludes_analyse:
+        - vendor
+        - resources
+    ignoreErrors:
+        - '#Function config_path not found#'
+        - '#Function config not found#'
+        - '#Instantiated class Monolog\\Logger not found#'
+        - '#Instantiated class Monolog\\Handler\\StreamHandler not found#'
+        - '#Access to constant ERROR on an unknown class Monolog\\Logger#'

src/GeoIP.php

@@ -107,14 +107,15 @@ public function __construct(array $config, CacheManager $cache)
      * @param string $ip
      *
      * @return \Torann\GeoIP\Location
+     * @throws \Exception
      */
     public function getLocation($ip = null)
     {
         // Get location data
         $this->location = $this->find($ip);
 
         // Should cache location
-        if ($this->shouldCache($ip, $this->location)) {
+        if ($this->shouldCache($this->location, $ip)) {
             $this->getCache()->set($ip, $this->location);
         }
 
@@ -148,16 +149,15 @@ private function find($ip = null)
                 $location = $this->getService()->locate($ip);
 
                 // Set currency if not already set by the service
-                if (!$location->currency) {
+                if (! $location->currency) {
                     $location->currency = $this->getCurrency($location->iso_code);
                 }
 
                 // Set default
                 $location->default = false;
 
                 return $location;
-            }
-            catch (\Exception $e) {
+            } catch (\Exception $e) {
                 if ($this->config('log_failures', true) === true) {
                     $log = new Logger('geoip');
                     $log->pushHandler(new StreamHandler(storage_path('logs/geoip.log'), Logger::ERROR));
@@ -262,8 +262,8 @@ public function getClientIP()
      */
     private function isValid($ip)
     {
-        if (!filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 | FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE)
-            && !filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6 | FILTER_FLAG_NO_PRIV_RANGE)
+        if (! filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 | FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE)
+            && ! filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6 | FILTER_FLAG_NO_PRIV_RANGE)
         ) {
             return false;
         }
@@ -274,20 +274,19 @@ private function isValid($ip)
     /**
      * Determine if the location should be cached.
      *
-     * @param string   $ip
-     * @param Location $location
+     * @param Location    $location
+     * @param string|null $ip
      *
      * @return bool
      */
-    private function shouldCache($ip = null, Location $location)
+    private function shouldCache(Location $location, $ip = null)
     {
         if ($location->default === true || $location->cached === true) {
             return false;
         }
 
         switch ($this->config('cache', 'none')) {
             case 'all':
-                return true;
             case 'some' && $ip === null:
                 return true;
         }

src/Services/IPGeoLocation.php

@@ -1,56 +1,55 @@
-<?php
-
-namespace Torann\GeoIP\Services;
-
-use Exception;
-use Illuminate\Support\Arr;
-use Torann\GeoIP\Support\HttpClient;
-
-class IPGeoLocation extends AbstractService
-{
-    /**
-     * Http client instance.
-     *
-     * @var HttpClient
-     */
-    protected $client;
-
-    /**
-     * The "booting" method of the service.
-     *
-     * @return void
-     */
-    public function boot()
-    {
-        $base = [
-            'base_uri' => 'https://api.ipgeolocation.io/',
-        ];
-
-        if ($this->config('key')) {
-            $base['base_uri'] = "{$base['base_uri']}ipgeo?apiKey=" . $this->config('key');
-        }
-
-        $this->client = new HttpClient($base);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-
-    public function locate($ip)
-    {
-        // Get data from client
-        $data = $this->client->get('&ip=' . $ip);
-
-        // Verify server response
-        if ($this->client->getErrors() !== null) {
-            throw new Exception('Request failed (' . $this->client->getErrors() . ')');
-        }
-
-        // Parse body content
-        $json = json_decode($data[0], true);
-
-        return $this->hydrate($json);
-
-    }
-}
+<?php
+
+namespace Torann\GeoIP\Services;
+
+use Exception;
+use Illuminate\Support\Arr;
+use Torann\GeoIP\Support\HttpClient;
+
+class IPGeoLocation extends AbstractService
+{
+    /**
+     * Http client instance.
+     *
+     * @var HttpClient
+     */
+    protected $client;
+
+    /**
+     * The "booting" method of the service.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        $base = [
+            'base_uri' => 'https://api.ipgeolocation.io/',
+        ];
+
+        if ($this->config('key')) {
+            $base['base_uri'] = "{$base['base_uri']}ipgeo?apiKey=" . $this->config('key');
+        }
+
+        $this->client = new HttpClient($base);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+
+    public function locate($ip)
+    {
+        // Get data from client
+        $data = $this->client->get('&ip=' . $ip);
+
+        // Verify server response
+        if ($this->client->getErrors() !== null) {
+            throw new Exception('Request failed (' . $this->client->getErrors() . ')');
+        }
+
+        // Parse body content
+        $json = json_decode($data[0], true);
+
+        return $this->hydrate($json);
+    }
+}