adding a coding static analysis tools with PHPStan

nyamsprod · nyamsprod · commit a8173ec36072 · 2018-02-23T09:21:39.000+01:00
diff --git a/.gitattributes b/.gitattributes
@@ -1,12 +1,13 @@
 * text=auto
 
-/.editorconfig     export-ignore
-/.gitattributes    export-ignore
-/.github           export-ignore
-/.gitignore        export-ignore
-/.php_cs           export-ignore
-/.travis.yml       export-ignore
-/README.md         export-ignore
-/CHANGELOG.md      export-ignore
-/phpunit.xml.dist  export-ignore
-/tests             export-ignore
+/.editorconfig       export-ignore
+/.gitattributes      export-ignore
+/.github             export-ignore
+/.gitignore          export-ignore
+/.php_cs             export-ignore
+/.phpstan.src.neon   export-ignore
+/.phpstan.tests.neon export-ignore
+/.travis.yml         export-ignore
+/README.md           export-ignore
+/phpunit.xml.dist    export-ignore
+/tests               export-ignore
diff --git a/.travis.yml b/.travis.yml
@@ -5,13 +5,13 @@ sudo: false
 matrix:
   include:
     - php: 7.0
-      env: COLLECT_COVERAGE=true VALIDATE_CODING_STYLE=true IGNORE_PLATFORMS=false
+      env: VALIDATE_CODING_STYLE=false RUN_PHPSTAN=false IGNORE_PLATFORMS=false
     - php: 7.1
-      env: COLLECT_COVERAGE=true VALIDATE_CODING_STYLE=true IGNORE_PLATFORMS=false
+      env: VALIDATE_CODING_STYLE=false RUN_PHPSTAN=false IGNORE_PLATFORMS=false
     - php: 7.2
-      env: COLLECT_COVERAGE=false VALIDATE_CODING_STYLE=false IGNORE_PLATFORMS=true
+      env: VALIDATE_CODING_STYLE=true RUN_PHPSTAN=true IGNORE_PLATFORMS=false
     - php: nightly
-      env: COLLECT_COVERAGE=false VALIDATE_CODING_STYLE=false IGNORE_PLATFORMS=true
+      env: VALIDATE_CODING_STYLE=false RUN_PHPSTAN=false IGNORE_PLATFORMS=true
   allow_failures:
     - php: nightly
   fast_finish: true
@@ -31,5 +31,5 @@ script:
   - composer phpunit
 
 after_script:
- - if [ "$COLLECT_COVERAGE" == "true" ]; then wget https://scrutinizer-ci.com/ocular.phar && php ocular.phar code-coverage:upload --format=php-clover build/clover.xml; fi
- - if [ "$VALIDATE_CODING_STYLE" == "true" ]; then composer phpcs; fi
+ - if [ "$VALIDATE_CODING_STYLE" == "true" ]; then composer phpcs; fi
+ - if [ "$RUN_PHPSTAN" == "true" ]; then composer phpstan; fi
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 All Notable changes to `PHP Domain Parser` **5.x** series will be documented in this file
 
-## Next - TBD
+## 5.2.0 - 2018-02-23
 
 ### Added
 
@@ -17,7 +17,8 @@ All Notable changes to `PHP Domain Parser` **5.x** series will be documented in
 
 - `Pdp\Domain::getDomain` returns the normalized form of the domain name
 - `Pdp\PublicSuffix` is no longer internal.
-- normalizes IDN conversion using a internal `IDNConverterTrait`
+- Normalizes IDN conversion using a internal `IDNConverterTrait`
+- Internal code improved by requiring PHPStan for development
 
 ### Deprecated
 
diff --git a/README.md b/README.md
@@ -428,6 +428,26 @@ Contributing
 
 Contributions are welcome and will be fully credited. Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
 
+Testing
+-------
+
+`pdp-domain-parser` has:
+
+- a [PHPUnit](https://phpunit.de) test suite
+- a coding style compliance test suite using [PHP CS Fixer](http://cs.sensiolabs.org/).
+- a code analysis compliance test suite using [PHPStan](https://github.com/phpstan/phpstan).
+
+To run the tests, run the following command from the project folder.
+
+``` bash
+$ composer test
+```
+
+Security
+-------
+
+If you discover any security related issues, please email nyamsprod@gmail.com instead of using the issue tracker.
+
 Credits
 -------
 
diff --git a/composer.json b/composer.json
@@ -39,9 +39,13 @@
         "psr/simple-cache": "^1"
     },
     "require-dev": {
-        "phpunit/phpunit": "^6.3",
+        "composer/composer": "^1.6",
+        "friendsofphp/php-cs-fixer": "^2.7",
         "mikey179/vfsStream": "^1.6",
-        "friendsofphp/php-cs-fixer": "^2.7"
+        "phpstan/phpstan": "^0.9.2",
+        "phpstan/phpstan-phpunit": "^0.9.4",
+        "phpstan/phpstan-strict-rules": "^0.9.0",
+        "phpunit/phpunit": "^6.3"
     },
     "suggest": {
         "psr/simple-cache-implementation": "To enable using other cache providers",
@@ -59,11 +63,21 @@
         }
     },
     "scripts": {
+        "phpcs": "php-cs-fixer fix -vv --diff --dry-run --allow-risky=yes",
+        "phpstan-src": "phpstan analyse -l 7 -c phpstan.src.neon src",
+        "phpstan-tests": "phpstan analyse -l 7 -c phpstan.tests.neon tests",
+        "phpstan": [
+            "@phpstan-src",
+            "@phpstan-tests"
+        ],
+        "phpunit": "phpunit --coverage-text",
         "post-install-cmd": "\\Pdp\\Installer::updateLocalCache",
         "post-update-cmd": "\\Pdp\\Installer::updateLocalCache",
-        "test": "phpunit --coverage-text; php-cs-fixer fix -vv --diff --dry-run --allow-risky=yes",
-        "phpunit": "phpunit --coverage-text",
-        "phpcs": "php-cs-fixer fix -vv --diff --dry-run --allow-risky=yes"
+        "test": [
+            "@phpunit",
+            "@phpcs",
+            "@phpstan"
+        ]
     },
     "extra": {
         "branch-alias": {
diff --git a/data/pdp-PSL_FULL_5a3cc7f81795bb2e48e848af42d287b4.cache b/data/pdp-PSL_FULL_5a3cc7f81795bb2e48e848af42d287b4.cache
diff --git a/phpstan.src.neon b/phpstan.src.neon
@@ -0,0 +1,6 @@
+includes:
+- vendor/phpstan/phpstan-strict-rules/rules.neon
+parameters:
+    ignoreErrors:
+        - '#has invalid typehint type Psr\\SimpleCache\\DateInterval#'
+    reportUnmatchedIgnoredErrors: false
diff --git a/phpstan.tests.neon b/phpstan.tests.neon
@@ -0,0 +1,5 @@
+includes:
+    - vendor/phpstan/phpstan-strict-rules/rules.neon
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+    - vendor/phpstan/phpstan-phpunit/rules.neon
+    - vendor/phpstan/phpstan-phpunit/strictRules.neon
diff --git a/src/Installer.php b/src/Installer.php
@@ -67,7 +67,7 @@ public static function updateLocalCache(Event $event = null)
             $io->writeError([
                 '😓 😓 😓 Your local cache could not be updated. 😓 😓 😓',
                 'An error occurred during the update.',
-                '----- Error Trace ----',
+                '----- Error Message ----',
             ]);
             $io->writeError($e->getMessage());
             die(1);
@@ -83,7 +83,7 @@ public static function updateLocalCache(Event $event = null)
      */
     private static function getVendorPath(Event $event = null)
     {
-        if ($event instanceof Event) {
+        if (null !== $event) {
             return $event->getComposer()->getConfig()->get('vendor-dir');
         }
 
@@ -103,11 +103,11 @@ private static function getVendorPath(Event $event = null)
      *
      * @param Event|null $event
      *
-     * @return object
+     * @return mixed
      */
     private static function getIO(Event $event = null)
     {
-        if ($event instanceof Event) {
+        if (null !== $event) {
             return $event->getIO();
         }
 
diff --git a/src/Rules.php b/src/Rules.php
@@ -102,7 +102,7 @@ public function __construct(array $rules)
      */
     public function getPublicSuffix(string $domain = null, string $section = self::ALL_DOMAINS): PublicSuffix
     {
-        if (!$this->isMatchable($domain)) {
+        if (null === $domain || !$this->isMatchable($domain)) {
             throw new Exception(sprintf('The submitted domain `%s` is invalid or malformed', $domain));
         }
         $this->validateSection($section);
@@ -121,7 +121,7 @@ public function getPublicSuffix(string $domain = null, string $section = self::A
     public function resolve(string $domain = null, string $section = self::ALL_DOMAINS): Domain
     {
         $this->validateSection($section);
-        if (!$this->isMatchable($domain)) {
+        if (null === $domain || !$this->isMatchable($domain)) {
             return new Domain();
         }
 
@@ -135,14 +135,13 @@ public function resolve(string $domain = null, string $section = self::ALL_DOMAI
     /**
      * Tells whether the given domain can be resolved.
      *
-     * @param string|null $domain
+     * @param string $domain
      *
      * @return bool
      */
     private function isMatchable($domain): bool
     {
-        return null !== $domain
-            && strpos($domain, '.') > 0
+        return strpos($domain, '.') > 0
             && strlen($domain) === strcspn($domain, '][')
             && !filter_var($domain, FILTER_VALIDATE_IP);
     }
diff --git a/tests/CacheTest.php b/tests/CacheTest.php
@@ -2,14 +2,14 @@
 
 declare(strict_types=1);
 
-namespace pdp\tests;
+namespace Pdp\Tests;
 
 use DateInterval;
+use Iterator;
 use org\bovigo\vfs\vfsStream;
 use Pdp\Cache;
 use PHPUnit\Framework\TestCase;
 use Psr\SimpleCache\InvalidArgumentException;
-use Traversable;
 
 /**
  * Abstract PSR-16 tester.
@@ -47,8 +47,7 @@ public function tearDown()
     /**
      * @dataProvider storableValuesProvider
      *
-     * @param mixed  $expected
-     * @param string $key
+     * @param mixed $expected
      */
     public function testSetGet($expected)
     {
@@ -387,7 +386,7 @@ public function testGetMultipleInvalidArg()
         // first value is requested.
         //
         // This extra line is just a precaution for that
-        if ($result instanceof Traversable) {
+        if ($result instanceof Iterator) {
             $result->current();
         }
     }
diff --git a/tests/CurlHttpClientTest.php b/tests/CurlHttpClientTest.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace pdp\tests;
+namespace Pdp\Tests;
 
 use Pdp\CurlHttpClient;
 use Pdp\Exception;
diff --git a/tests/DomainTest.php b/tests/DomainTest.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace pdp\tests;
+namespace Pdp\Tests;
 
 use Pdp\Domain;
 use Pdp\Exception;
diff --git a/tests/ManagerTest.php b/tests/ManagerTest.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace pdp\tests;
+namespace Pdp\Tests;
 
 use org\bovigo\vfs\vfsStream;
 use Pdp\Cache;
@@ -13,9 +13,6 @@
 
 class ManagerTest extends TestCase
 {
-    /**
-     * @var Manager
-     */
     protected $manager;
     protected $cachePool;
     protected $cacheDir;
diff --git a/tests/PublicSuffixTest.php b/tests/PublicSuffixTest.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace pdp\tests;
+namespace Pdp\Tests;
 
 use Pdp\Exception;
 use Pdp\PublicSuffix;
diff --git a/tests/RulesTest.php b/tests/RulesTest.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace pdp\tests;
+namespace Pdp\Tests;
 
 use Pdp\Cache;
 use Pdp\CurlHttpClient;
@@ -257,8 +257,8 @@ public function testPublicSuffixSection()
      *
      * @see http://publicsuffix.org/list/
      *
-     * @param string $input    Domain and public suffix
-     * @param string $expected Expected result
+     * @param string|null $input    Domain and public suffix
+     * @param string|null $expected Expected result
      */
     public function checkPublicSuffix($input, $expected)
     {

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ public static function updateLocalCache(Event $event = null)`
`67`	`67`	`$io->writeError([`
`68`	`68`	`'😓 😓 😓 Your local cache could not be updated. 😓 😓 😓',`
`69`	`69`	`'An error occurred during the update.',`
`70`		`- '----- Error Trace ----',`
	`70`	`+ '----- Error Message ----',`
`71`	`71`	`]);`
`72`	`72`	`$io->writeError($e->getMessage());`
`73`	`73`	`die(1);`
`@@ -83,7 +83,7 @@ public static function updateLocalCache(Event $event = null)`
`83`	`83`	`*/`
`84`	`84`	`private static function getVendorPath(Event $event = null)`
`85`	`85`	`{`
`86`		`- if ($event instanceof Event) {`
	`86`	`+ if (null !== $event) {`
`87`	`87`	`return $event->getComposer()->getConfig()->get('vendor-dir');`
`88`	`88`	`}`
`89`	`89`
`@@ -103,11 +103,11 @@ private static function getVendorPath(Event $event = null)`
`103`	`103`	`*`
`104`	`104`	`* @param Event\|null $event`
`105`	`105`	`*`
`106`		`- * @return object`
	`106`	`+ * @return mixed`
`107`	`107`	`*/`
`108`	`108`	`private static function getIO(Event $event = null)`
`109`	`109`	`{`
`110`		`- if ($event instanceof Event) {`
	`110`	`+ if (null !== $event) {`
`111`	`111`	`return $event->getIO();`
`112`	`112`	`}`
`113`	`113`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ public function __construct(array $rules)`
`102`	`102`	`*/`
`103`	`103`	`public function getPublicSuffix(string $domain = null, string $section = self::ALL_DOMAINS): PublicSuffix`
`104`	`104`	`{`
`105`		`- if (!$this->isMatchable($domain)) {`
	`105`	`+ if (null === $domain \|\| !$this->isMatchable($domain)) {`
`106`	`106`	throw new Exception(sprintf('The submitted domain `%s` is invalid or malformed', $domain));
`107`	`107`	`}`
`108`	`108`	`$this->validateSection($section);`
`@@ -121,7 +121,7 @@ public function getPublicSuffix(string $domain = null, string $section = self::A`
`121`	`121`	`public function resolve(string $domain = null, string $section = self::ALL_DOMAINS): Domain`
`122`	`122`	`{`
`123`	`123`	`$this->validateSection($section);`
`124`		`- if (!$this->isMatchable($domain)) {`
	`124`	`+ if (null === $domain \|\| !$this->isMatchable($domain)) {`
`125`	`125`	`return new Domain();`
`126`	`126`	`}`
`127`	`127`
`@@ -135,14 +135,13 @@ public function resolve(string $domain = null, string $section = self::ALL_DOMAI`
`135`	`135`	`/**`
`136`	`136`	`* Tells whether the given domain can be resolved.`
`137`	`137`	`*`
`138`		`- * @param string\|null $domain`
	`138`	`+ * @param string $domain`
`139`	`139`	`*`
`140`	`140`	`* @return bool`
`141`	`141`	`*/`
`142`	`142`	`private function isMatchable($domain): bool`
`143`	`143`	`{`
`144`		`- return null !== $domain`
`145`		`- && strpos($domain, '.') > 0`
	`144`	`+ return strpos($domain, '.') > 0`
`146`	`145`	`&& strlen($domain) === strcspn($domain, '][')`
`147`	`146`	`&& !filter_var($domain, FILTER_VALIDATE_IP);`
`148`	`147`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`declare(strict_types=1);`
`4`	`4`
`5`		`-namespace pdp\tests;`
	`5`	`+namespace Pdp\Tests;`
`6`	`6`
`7`	`7`	`use Pdp\Cache;`
`8`	`8`	`use Pdp\CurlHttpClient;`
`@@ -257,8 +257,8 @@ public function testPublicSuffixSection()`
`257`	`257`	`*`
`258`	`258`	`* @see http://publicsuffix.org/list/`
`259`	`259`	`*`
`260`		`- * @param string $input Domain and public suffix`
`261`		`- * @param string $expected Expected result`
	`260`	`+ * @param string\|null $input Domain and public suffix`
	`261`	`+ * @param string\|null $expected Expected result`
`262`	`262`	`*/`
`263`	`263`	`public function checkPublicSuffix($input, $expected)`
`264`	`264`	`{`