makes phpstan happy

Author: svnldwg

dev/phpstan.neon

@@ -2,6 +2,7 @@ includes:
 parameters:
   level: max
   inferPrivatePropertyTypeFromConstructor: true
+  checkGenericClassInNonGenericObjectType: false
   paths:
     - %currentWorkingDirectory%/src/
     - %currentWorkingDirectory%/test/

docker/Makefile

@@ -2,8 +2,8 @@ export PROJECT_NAME = phpstan-rules
 export SHELL = bash
 
 DOCKER_COMPOSE = docker-compose
-CLI = $(DOCKER_COMPOSE) exec -T ${PROJECT_NAME}
-CLI_COMPOSER = $(DOCKER_COMPOSE) exec -T ${PROJECT_NAME} php -d memory_limit=-1 /usr/bin/composer
+CLI = $(DOCKER_COMPOSE) run -T ${PROJECT_NAME}
+CLI_COMPOSER = $(DOCKER_COMPOSE) run -T ${PROJECT_NAME} php -d memory_limit=-1 /usr/bin/composer
 
 start:
 	$(DOCKER_COMPOSE) up -d
@@ -47,4 +47,7 @@ php-cs-fixer: ##@development run php-cs-fixer
 
 tests:
 	$(CLI) ./vendor/bin/phpunit --configuration=test/Integration/phpunit.xml
-.PHONY: tests
+.PHONY: tests
+
+check: php-cs-fixer phpstan tests
+.PHONY: check

src/Helper/Converter.php

@@ -16,7 +16,12 @@ class Converter
     public static function propertyStringNames(array $properties)
     {
         return array_map(static function (Node\Stmt\Property $property): string {
-            return (string)reset($property->props)->name;
+            $firstProp = reset($property->props);
+            if ($firstProp === false) {
+                return '';
+            }
+
+            return (string)$firstProp->name;
         }, $properties);
     }
 }

src/Helper/NodeParser.php

@@ -59,6 +59,11 @@ public static function getClassProperties(Node\Stmt\Class_ $classNode): array
         return $properties;
     }
 
+    /**
+     * @param Node\Stmt\Class_ $classNode
+     *
+     * @return array<Node\Stmt\Property>
+     */
     public static function getNonPrivateProperties(Node\Stmt\Class_ $classNode): array
     {
         $properties = self::getClassProperties($classNode);

src/Rules/ImmutableObjectRule.php

@@ -48,7 +48,7 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        [$immutableProperties, $hasImmutableParent] = $this->getInheritedImmutableProperties($scope);
+        ['properties' => $immutableProperties, 'hasImmutableParent' => $hasImmutableParent] = $this->getInheritedImmutableProperties($scope);
 
         $nodes = $this->parser->parseFile($scope->getFile());
         $hasImmutableClassAnnotation = AnnotationParser::classHasAnnotation(self::WHITELISTED_ANNOTATIONS, $nodes);
@@ -124,12 +124,12 @@ public function processNode(Node $node, Scope $scope): array
     /**
      * @param Scope $scope
      *
-     * @return array<string[]>
+     * @return array{properties: string[], hasImmutableParent: bool}
      */
     private function getInheritedImmutableProperties(Scope $scope): array
     {
         if ($scope->getClassReflection() === null) {
-            return [];
+            return ['properties' => [], 'hasImmutableParent' => false];
         }
 
         $immutableParentProperties = [];
@@ -158,6 +158,6 @@ private function getInheritedImmutableProperties(Scope $scope): array
             // @TODO: detect non private parent properties annotated as immutable (instead of whole class)
         }
 
-        return [$immutableParentProperties, $hasImmutableParent];
+        return ['properties' => $immutableParentProperties, 'hasImmutableParent' => $hasImmutableParent];
     }
 }

test/Integration/AbstractTestCase.php

@@ -26,8 +26,8 @@ final public function testAnalysisSucceeds(string $path): void
     /**
      * @dataProvider provideCasesWhereAnalysisShouldFail
      *
-     * @param string $path
-     * @param array  $error
+     * @param string            $path
+     * @param array<string|int> $error
      */
     final public function testAnalysisFails(string $path, array $error): void
     {
@@ -41,7 +41,13 @@ final public function testAnalysisFails(string $path, array $error): void
         );
     }
 
+    /**
+     * @return iterable<string,string[]>
+     */
     abstract public function provideCasesWhereAnalysisShouldSucceed(): iterable;
 
+    /**
+     * @return iterable<string,array>
+     */
     abstract public function provideCasesWhereAnalysisShouldFail(): iterable;
 }

test/Integration/Rules/ImmutableObjectRuleTest.php

@@ -40,6 +40,9 @@ public function provideCasesWhereAnalysisShouldSucceed(): iterable
         }
     }
 
+    /**
+     * @return iterable<string,array>
+     */
     public function provideCasesWhereAnalysisShouldFail(): iterable
     {
         $paths = [
@@ -95,6 +98,9 @@ public function provideCasesWhereAnalysisShouldFail(): iterable
         }
     }
 
+    /**
+     * @return Rule<\PhpParser\Node>
+     */
     protected function getRule(): Rule
     {
         $lexer = new Lexer();