Merge pull request #158 from maxmind/greg/phpstan

Lint with phpstan

Author: rafl

.github/workflows/lint.yml

@@ -23,3 +23,6 @@ jobs:
 
       - name: Lint with phpcs
         run: vendor/bin/phpcs --standard=PSR2 src/
+
+      - name: Lint with phpstan
+        run: vendor/bin/phpstan analyze

composer.json

@@ -21,7 +21,8 @@
     "require-dev": {
         "friendsofphp/php-cs-fixer": "*",
         "phpunit/phpunit": "^8.0 || ^9.0",
-        "squizlabs/php_codesniffer": "3.*"
+        "squizlabs/php_codesniffer": "3.*",
+        "phpstan/phpstan": "*"
     },
     "autoload": {
         "psr-4": {

phpstan.neon

@@ -0,0 +1,7 @@
+parameters:
+    level: 6
+    paths:
+        - src
+        - tests
+    checkMissingIterableValueType: false
+

src/Database/Reader.php

@@ -5,6 +5,7 @@
 namespace GeoIp2\Database;
 
 use GeoIp2\Exception\AddressNotFoundException;
+use GeoIp2\Model\AbstractModel;
 use GeoIp2\ProviderInterface;
 use MaxMind\Db\Reader as DbReader;
 use MaxMind\Db\Reader\InvalidDatabaseException;
@@ -35,8 +36,17 @@
  */
 class Reader implements ProviderInterface
 {
+    /**
+     * @var DbReader
+     */
     private $dbReader;
+    /**
+     * @var string
+     */
     private $dbType;
+    /**
+     * @var array<string>
+     */
     private $locales;
 
     /**
@@ -70,6 +80,7 @@ public function __construct(
      */
     public function city(string $ipAddress): \GeoIp2\Model\City
     {
+        // @phpstan-ignore-next-line
         return $this->modelFor('City', 'City', $ipAddress);
     }
 
@@ -85,6 +96,7 @@ public function city(string $ipAddress): \GeoIp2\Model\City
      */
     public function country(string $ipAddress): \GeoIp2\Model\Country
     {
+        // @phpstan-ignore-next-line
         return $this->modelFor('Country', 'Country', $ipAddress);
     }
 
@@ -100,6 +112,7 @@ public function country(string $ipAddress): \GeoIp2\Model\Country
      */
     public function anonymousIp(string $ipAddress): \GeoIp2\Model\AnonymousIp
     {
+        // @phpstan-ignore-next-line
         return $this->flatModelFor(
             'AnonymousIp',
             'GeoIP2-Anonymous-IP',
@@ -119,6 +132,7 @@ public function anonymousIp(string $ipAddress): \GeoIp2\Model\AnonymousIp
      */
     public function asn(string $ipAddress): \GeoIp2\Model\Asn
     {
+        // @phpstan-ignore-next-line
         return $this->flatModelFor(
             'Asn',
             'GeoLite2-ASN',
@@ -138,6 +152,7 @@ public function asn(string $ipAddress): \GeoIp2\Model\Asn
      */
     public function connectionType(string $ipAddress): \GeoIp2\Model\ConnectionType
     {
+        // @phpstan-ignore-next-line
         return $this->flatModelFor(
             'ConnectionType',
             'GeoIP2-Connection-Type',
@@ -157,6 +172,7 @@ public function connectionType(string $ipAddress): \GeoIp2\Model\ConnectionType
      */
     public function domain(string $ipAddress): \GeoIp2\Model\Domain
     {
+        // @phpstan-ignore-next-line
         return $this->flatModelFor(
             'Domain',
             'GeoIP2-Domain',
@@ -176,6 +192,7 @@ public function domain(string $ipAddress): \GeoIp2\Model\Domain
      */
     public function enterprise(string $ipAddress): \GeoIp2\Model\Enterprise
     {
+        // @phpstan-ignore-next-line
         return $this->modelFor('Enterprise', 'Enterprise', $ipAddress);
     }
 
@@ -191,14 +208,15 @@ public function enterprise(string $ipAddress): \GeoIp2\Model\Enterprise
      */
     public function isp(string $ipAddress): \GeoIp2\Model\Isp
     {
+        // @phpstan-ignore-next-line
         return $this->flatModelFor(
             'Isp',
             'GeoIP2-ISP',
             $ipAddress
         );
     }
 
-    private function modelFor(string $class, string $type, string $ipAddress)
+    private function modelFor(string $class, string $type, string $ipAddress): AbstractModel
     {
         list($record, $prefixLen) = $this->getRecord($class, $type, $ipAddress);
 
@@ -210,7 +228,7 @@ private function modelFor(string $class, string $type, string $ipAddress)
         return new $class($record, $this->locales);
     }
 
-    private function flatModelFor(string $class, string $type, string $ipAddress)
+    private function flatModelFor(string $class, string $type, string $ipAddress): AbstractModel
     {
         list($record, $prefixLen) = $this->getRecord($class, $type, $ipAddress);
 

src/Exception/HttpException.php

@@ -11,6 +11,8 @@ class HttpException extends GeoIp2Exception
 {
     /**
      * The URI queried.
+     *
+     * @var string
      */
     public $uri;
 

src/Exception/InvalidRequestException.php

@@ -12,6 +12,8 @@ class InvalidRequestException extends HttpException
 {
     /**
      * The code returned by the MaxMind web service.
+     *
+     * @var string
      */
     public $error;
 

src/Model/AbstractModel.php

@@ -9,6 +9,9 @@
  */
 abstract class AbstractModel implements \JsonSerializable
 {
+    /**
+     * @var array<string, mixed>
+     */
     protected $raw;
 
     /**
@@ -21,6 +24,8 @@ public function __construct(array $raw)
 
     /**
      * @ignore
+     *
+     * @return mixed
      */
     protected function get(string $field)
     {
@@ -36,6 +41,8 @@ protected function get(string $field)
 
     /**
      * @ignore
+     *
+     * @return mixed
      */
     public function __get(string $attr)
     {

src/Model/AnonymousIp.php

@@ -31,13 +31,37 @@
  */
 class AnonymousIp extends AbstractModel
 {
+    /**
+     * @var bool
+     */
     protected $isAnonymous;
+    /**
+     * @var bool
+     */
     protected $isAnonymousVpn;
+    /**
+     * @var bool
+     */
     protected $isHostingProvider;
+    /**
+     * @var bool
+     */
     protected $isPublicProxy;
+    /**
+     * @var bool
+     */
     protected $isResidentialProxy;
+    /**
+     * @var bool
+     */
     protected $isTorExitNode;
+    /**
+     * @var string
+     */
     protected $ipAddress;
+    /**
+     * @var string
+     */
     protected $network;
 
     /**

src/Model/Asn.php

@@ -22,9 +22,21 @@
  */
 class Asn extends AbstractModel
 {
+    /**
+     * @var int|null
+     */
     protected $autonomousSystemNumber;
+    /**
+     * @var string|null
+     */
     protected $autonomousSystemOrganization;
+    /**
+     * @var string
+     */
     protected $ipAddress;
+    /**
+     * @var string
+     */
     protected $network;
 
     /**

src/Model/City.php

@@ -33,18 +33,26 @@ class City extends Country
 {
     /**
      * @ignore
+     *
+     * @var \GeoIp2\Record\City
      */
     protected $city;
     /**
      * @ignore
+     *
+     * @var \GeoIp2\Record\Location
      */
     protected $location;
     /**
      * @ignore
+     *
+     * @var \GeoIp2\Record\Postal
      */
     protected $postal;
     /**
      * @ignore
+     *
+     * @var array<\GeoIp2\Record\Subdivision>
      */
     protected $subdivisions = [];
 
@@ -77,6 +85,8 @@ private function createSubdivisions(array $raw, array $locales): void
 
     /**
      * @ignore
+     *
+     * @return mixed
      */
     public function __get(string $attr)
     {