Phpstan level 5

Author: halaxa

Makefile

@@ -30,16 +30,15 @@ help:
 	@grep -E '^[-a-zA-Z0-9_\.\/]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[32m%-15s\033[0m\t%s\n", $$1, $$2}'
 
 
-build: tests-all cs-check ## Run all necessary stuff before commit.
+build: tests-all cs-check phpstan ## Run all necessary stuff before commit.
 
 
-tests: CMD=composer tests -- $(ARGS)
-tests: docker-run ## Run tests on recent PHP version. Pass args to phpunit via ARGS=""
+tests: ## Run tests on recent PHP version. Pass args to phpunit via ARGS=""
+	@$(call DOCKER_RUN,$(COVERAGE_PHP),composer tests -- $(ARGS))
 
 
-tests-coverage: CMD=composer tests-coverage -- $(ARGS)
 tests-coverage: ## Runs tests and creates ./clover.xml. Pass args to phpunit via ARGS=""
-	@$(call DOCKER_RUN,$(COVERAGE_PHP),$(CMD))
+	@$(call DOCKER_RUN,$(COVERAGE_PHP),composer tests-coverage -- $(ARGS))
 
 
 tests-all: ## Run tests on all supported PHP versions. Pass args to phpunit via ARGS=""
@@ -52,16 +51,20 @@ tests-all: ## Run tests on all supported PHP versions. Pass args to phpunit via
 	done
 
 
-cs-check: CMD=composer cs-check
-cs-check: docker-run ## Check code style
+cs-check: ## Check code style
+	@$(call DOCKER_RUN,$(LATEST_PHP),composer cs-check)
 
 
-cs-fix: CMD=composer cs-fix
-cs-fix: docker-run ## Fix code style
+phpstan: ## Run phpstan
+	@$(call DOCKER_RUN,$(LATEST_PHP),composer phpstan)
 
 
-performance-tests: CMD=composer performance-tests
-performance-tests: docker-run ## Run performance tests
+cs-fix: ## Fix code style
+	@$(call DOCKER_RUN,$(LATEST_PHP),composer cs-fix)
+
+
+performance-tests: ## Run performance tests
+	@$(call DOCKER_RUN,$(LATEST_PHP),composer performance-tests)
 
 
 release: .env build

composer.json

@@ -13,6 +13,7 @@
         "tests-coverage": "build/composer-update.sh && XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-clover clover.xml",
         "cs-check": "build/composer-update.sh && vendor/bin/php-cs-fixer fix --dry-run --verbose --allow-risky=yes",
         "cs-fix": "build/composer-update.sh && vendor/bin/php-cs-fixer fix --verbose --allow-risky=yes",
+        "phpstan": "build/composer-update.sh && vendor/bin/phpstan analyse",
         "performance-tests": "php -d xdebug.mode=off -d opcache.enable_cli=1 -d opcache.jit_buffer_size=100M test/performance/testPerformance.php"
     },
     "config": {
@@ -25,6 +26,7 @@
     "require-dev": {
         "ext-json": "*",
         "friendsofphp/php-cs-fixer": "^3.0",
+        "phpstan/phpstan": "^1.10",
         "phpunit/phpunit": "^8.0"
     },
     "suggest": {

phpstan.neon

@@ -0,0 +1,21 @@
+parameters:
+  level: 5
+  paths:
+    - src
+    - test
+  bootstrapFiles:
+    - %rootDir%/../../../test/bootstrap.php
+  treatPhpDocTypesAsCertain: false
+  exceptions:
+    implicitThrows: false
+    check:
+      missingCheckedExceptionInThrows: true
+      tooWideThrowType: true
+    reportUncheckedExceptionDeadCatch: true
+    checkedExceptionClasses:
+      - JsonMachine\Exception\PathNotFoundException
+      - JsonMachine\Exception\SyntaxErrorException
+      - JsonMachine\Exception\UnexpectedEndSyntaxErrorException
+    uncheckedExceptionClasses:
+      - JsonMachine\Exception\InvalidArgumentException
+      - JsonMachine\Exception\JsonMachineException

src/Exception/SyntaxErrorException.php

@@ -6,7 +6,7 @@
 
 class SyntaxErrorException extends JsonMachineException
 {
-    public function __construct($message, $position)
+    public function __construct(string $message, int $position)
     {
         parent::__construct($message." At position $position.");
     }

src/FileChunks.php

@@ -4,6 +4,9 @@
 
 namespace JsonMachine;
 
+/**
+ * @implements \IteratorAggregate<int, string>
+ */
 class FileChunks implements \IteratorAggregate
 {
     /** @var string */

src/Parser.php

@@ -37,13 +37,13 @@ class Parser implements \IteratorAggregate, PositionAware
     /** @var ItemDecoder */
     private $jsonDecoder;
 
-    /** @var string */
+    /** @var string|null */
     private $matchedJsonPointer;
 
     /** @var array */
     private $paths;
 
-    /** @var array */
+    /** @var array|null */
     private $currentPath;
 
     /** @var array */
@@ -247,7 +247,7 @@ public function getIterator()
         }
 
         if ($token === null) {
-            $this->error('Cannot iterate empty JSON', $token);
+            $this->error('Cannot iterate empty JSON', '');
         }
 
         if ($currentLevel > -1 && ! $subtreeEnded) {
@@ -352,7 +352,7 @@ public function getMatchedJsonPointer(): string
      */
     private function error($msg, $token, $exception = SyntaxErrorException::class)
     {
-        throw new $exception($msg." '".$token."'", $this->tokens->getPosition());
+        throw new $exception($msg." '".$token."'", $this->tokens instanceof PositionAware ? $this->tokens->getPosition() : 0);
     }
 
     /**

src/StreamChunks.php

@@ -6,6 +6,9 @@
 
 use JsonMachine\Exception\InvalidArgumentException;
 
+/**
+ * @implements \IteratorAggregate<int, string>
+ */
 class StreamChunks implements \IteratorAggregate
 {
     /** @var resource */

src/TokensWithDebugging.php

@@ -4,17 +4,25 @@
 
 namespace JsonMachine;
 
+/**
+ * @implements \IteratorAggregate<int, string>
+ */
 class TokensWithDebugging implements \IteratorAggregate, PositionAware
 {
-    /** @var iterable */
+    /** @var iterable<int, string> */
     private $jsonChunks;
 
+    /** @var int */
     private $position = 0;
+
+    /** @var int */
     private $line = 1;
+
+    /** @var int */
     private $column = 0;
 
     /**
-     * @param iterable<string> $jsonChunks
+     * @param iterable<int, string> $jsonChunks
      */
     public function __construct($jsonChunks)
     {
@@ -53,6 +61,7 @@ public function getIterator()
         foreach ($this->jsonChunks as $bytes) {
             $bytesLength = strlen($bytes);
             for ($i = 0; $i < $bytesLength; ++$i) {
+                /** @var string $byte */
                 $byte = $bytes[$i];
                 if ($inString) {
                     if ($byte == '"' && ! $escaping) {

src/ValidJsonPointers.php

@@ -8,16 +8,23 @@
 
 final class ValidJsonPointers
 {
+    /** @var string[] */
     private $jsonPointers = [];
 
+    /** @var bool */
     private $validated = false;
 
+    /**
+     * @param string[] $jsonPointers
+     */
     public function __construct(array $jsonPointers)
     {
         $this->jsonPointers = array_values($jsonPointers);
     }
 
     /**
+     * @return string[]
+     *
      * @throws InvalidArgumentException
      */
     public function toArray(): array
@@ -30,6 +37,8 @@ public function toArray(): array
     }
 
     /**
+     * @return void
+     *
      * @throws InvalidArgumentException
      */
     private function validate()
@@ -40,6 +49,8 @@ private function validate()
     }
 
     /**
+     * @return void
+     *
      * @throws InvalidArgumentException
      */
     private function validateFormat()
@@ -54,6 +65,8 @@ private function validateFormat()
     }
 
     /**
+     * @return void
+     *
      * @throws InvalidArgumentException
      */
     private function validateJsonPointersDoNotIntersect()

src/autoloader.php

@@ -19,7 +19,10 @@
  */
 class Autoloading
 {
-    static public function autoloader($class)
+    /**
+     * @return void
+     */
+    static public function autoloader(string $class)
     {
         $prefix = 'JsonMachine\\';
         $baseDir = __DIR__.DIRECTORY_SEPARATOR;

test/JsonMachineTest/Exception/SyntaxErrorExceptionTest.php

@@ -14,7 +14,7 @@ class SyntaxErrorExceptionTest extends TestCase
 {
     public function testMessageContainsDataFromConstructor()
     {
-        $exception = new SyntaxErrorException('msg 42', '24');
+        $exception = new SyntaxErrorException('msg 42', 24);
 
         $this->assertContains('msg 42', $exception->getMessage());
         $this->assertContains('24', $exception->getMessage());

test/JsonMachineTest/JsonDecoder/DecodingErrorTest.php

@@ -14,7 +14,7 @@ class DecodingErrorTest extends TestCase
 {
     public function testGetMalformedJson()
     {
-        $decodingError = new DecodingError('"json\"', null);
+        $decodingError = new DecodingError('"json\"', '');
 
         $this->assertSame('"json\"', $decodingError->getMalformedJson());
     }

test/JsonMachineTest/StreamChunksTest.php

@@ -15,6 +15,7 @@ class StreamChunksTest extends \PHPUnit_Framework_TestCase
     public function testThrowsIfNoResource()
     {
         $this->expectException(InvalidArgumentException::class);
+        /* @phpstan-ignore-next-line */
         new StreamChunks(false);
     }
 

test/JsonMachineTest/ValidJsonPointersTest.php

@@ -16,7 +16,6 @@ class ValidJsonPointersTest extends \PHPUnit_Framework_TestCase
      * @dataProvider data_testThrowsOnIntersectingPaths
      *
      * @param $jsonPointers
-     * @param ParserTest $parserTest
      */
     public function testThrowsOnIntersectingPaths($jsonPointers)
     {