Add PHPStan at level 2

Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>

Author: MauricioFauth

.gitignore

@@ -10,3 +10,4 @@ coverage.xml
 phpunit.xml
 phpcs.xml
 /.phpunit.result.cache
+phpstan.neon

composer.json

@@ -22,6 +22,9 @@
     "require-dev": {
         "phpmyadmin/coding-standard": "^1.0",
         "phpmyadmin/motranslator": "^4.0",
+        "phpstan/extension-installer": "^1.0",
+        "phpstan/phpstan": "^0.12.3",
+        "phpstan/phpstan-phpunit": "^0.12.1",
         "phpunit/php-code-coverage": "*",
         "phpunit/phpunit": "^7.4 || ^8"
     },

phpstan.neon.dist

@@ -0,0 +1,10 @@
+parameters:
+    level: 2
+    paths:
+        - src
+        - tests
+        - bin
+    reportUnmatchedIgnoredErrors: true
+    inferPrivatePropertyTypeFromConstructor: true
+    ignoreErrors:
+        - '#Unsafe usage of new static\(\)\.#'

src/Components/GroupKeyword.php

@@ -16,6 +16,8 @@
  */
 class GroupKeyword extends Component
 {
+    public $type;
+
     /**
      * The expression that is used for grouping.
      *

src/Components/IndexHint.php

@@ -48,7 +48,7 @@ class IndexHint extends Component
      * @param string $type       the type of hint (USE/FORCE/IGNORE)
      * @param string $indexOrKey What the hint is for (INDEX/KEY)
      * @param string $for        the clause for which this hint is (JOIN/ORDER BY/GROUP BY)
-     * @param string $indexes    List of indexes in this hint
+     * @param array  $indexes    List of indexes in this hint
      */
     public function __construct(string $type = null, string $indexOrKey = null, string $for = null, array $indexes = [])
     {
@@ -168,8 +168,8 @@ public static function parse(Parser $parser, TokensList $list, array $options =
     }
 
     /**
-     * @param ArrayObj|ArrayObj[] $component the component to be built
-     * @param array               $options   parameters for building
+     * @param IndexHint|IndexHint[] $component the component to be built
+     * @param array                 $options   parameters for building
      *
      * @return string
      */

src/Components/LockExpression.php

@@ -35,7 +35,7 @@ class LockExpression extends Component
      * @param TokensList $list    the list of tokens that are being parsed
      * @param array      $options parameters for parsing
      *
-     * @return CaseExpression
+     * @return LockExpression
      */
     public static function parse(Parser $parser, TokensList $list, array $options = [])
     {

src/Utils/Error.php

@@ -6,6 +6,8 @@
 
 namespace PhpMyAdmin\SqlParser\Utils;
 
+use PhpMyAdmin\SqlParser\Exceptions\LexerException;
+use PhpMyAdmin\SqlParser\Exceptions\ParserException;
 use PhpMyAdmin\SqlParser\Lexer;
 use PhpMyAdmin\SqlParser\Parser;
 
@@ -32,6 +34,7 @@ public static function get($objs)
 
         foreach ($objs as $obj) {
             if ($obj instanceof Lexer) {
+                /** @var LexerException $err */
                 foreach ($obj->errors as $err) {
                     $ret[] = [
                         $err->getMessage(),
@@ -41,6 +44,7 @@ public static function get($objs)
                     ];
                 }
             } elseif ($obj instanceof Parser) {
+                /** @var ParserException $err */
                 foreach ($obj->errors as $err) {
                     $ret[] = [
                         $err->getMessage(),

tests/Components/ArrayObjTest.php

@@ -4,6 +4,7 @@
 namespace PhpMyAdmin\SqlParser\Tests\Components;
 
 use PhpMyAdmin\SqlParser\Components\ArrayObj;
+use PhpMyAdmin\SqlParser\Components\Expression;
 use PhpMyAdmin\SqlParser\Parser;
 use PhpMyAdmin\SqlParser\Tests\TestCase;
 
@@ -27,12 +28,14 @@ public function testParseType()
             new Parser(),
             $this->getTokensList('(1 + 2, 3 + 4)'),
             [
-                'type' => 'PhpMyAdmin\\SqlParser\\Components\\Expression',
+                'type' => Expression::class,
                 'typeOptions' => [
                     'breakOnParentheses' => true,
                 ],
             ]
         );
+        $this->assertInstanceOf(Expression::class, $components[0]);
+        $this->assertInstanceOf(Expression::class, $components[1]);
         $this->assertEquals($components[0]->expr, '1 + 2');
         $this->assertEquals($components[1]->expr, '3 + 4');
     }

tests/Components/CreateDefinitionTest.php

@@ -5,6 +5,7 @@
 
 use PhpMyAdmin\SqlParser\Components\CreateDefinition;
 use PhpMyAdmin\SqlParser\Parser;
+use PhpMyAdmin\SqlParser\Statements\CreateStatement;
 use PhpMyAdmin\SqlParser\Tests\TestCase;
 
 class CreateDefinitionTest extends TestCase
@@ -59,6 +60,7 @@ public function testBuild()
             'CONSTRAINT `fk_payment_customer` FOREIGN KEY (`customer_id`) REFERENCES `customer` (`customer_id`) ON UPDATE CASCADE' .
             ') ENGINE=InnoDB"'
         );
+        $this->assertInstanceOf(CreateStatement::class, $parser->statements[0]);
         $this->assertEquals(
             'CONSTRAINT `fk_payment_customer` FOREIGN KEY (`customer_id`) REFERENCES `customer` (`customer_id`) ON UPDATE CASCADE',
             CreateDefinition::build($parser->statements[0]->fields[1])
@@ -75,6 +77,7 @@ public function testBuild2()
             'CONSTRAINT `fk_payment_customer` FOREIGN KEY (`customer_id`) REFERENCES `customer` (`customer_id`) ON UPDATE CASCADE' .
             ') ENGINE=InnoDB"'
         );
+        $this->assertInstanceOf(CreateStatement::class, $parser->statements[0]);
         $this->assertEquals(
             'CONSTRAINT `fk_payment_customer` FOREIGN KEY (`customer_id`) REFERENCES `customer` (`customer_id`) ON UPDATE CASCADE',
             CreateDefinition::build($parser->statements[0]->fields[2])

tests/TestCase.php

@@ -6,6 +6,8 @@
 
 namespace PhpMyAdmin\SqlParser\Tests;
 
+use PhpMyAdmin\SqlParser\Exceptions\LexerException;
+use PhpMyAdmin\SqlParser\Exceptions\ParserException;
 use PhpMyAdmin\SqlParser\Lexer;
 use PhpMyAdmin\SqlParser\Parser;
 use PhpMyAdmin\SqlParser\TokensList;
@@ -42,6 +44,7 @@ public function getTokensList($query)
     public function getErrorsAsArray($obj)
     {
         $ret = [];
+        /** @var LexerException|ParserException $err */
         foreach ($obj->errors as $err) {
             $ret[] = $obj instanceof Lexer
                 ? [