Merge branch '1.10.x' into 1.11.x

phpstan · Aug 19, 2023 · d4ee76c · d4ee76c
2 parents 98908c9 + 26b3cbb
commit d4ee76c
Show file tree

Hide file tree

Showing 45 changed files with 335 additions and 37 deletions.
diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml
@@ -179,6 +179,14 @@ jobs:
             extensions: ""
           - script: "bin/phpstan analyse e2e/only-files-not-analysed-trait/src/Foo.php e2e/only-files-not-analysed-trait/src/BarTrait.php -c e2e/only-files-not-analysed-trait/no-ignore.neon"
             extensions: ""
+          - script: |
+              cd e2e/baseline-uninit-prop-trait
+              ../../bin/phpstan analyse --debug --configuration test-no-baseline.neon --generate-baseline test-baseline.neon
+              ../../bin/phpstan analyse --debug --configuration test.neon
+          - script: |
+              cd e2e/baseline-uninit-prop-trait
+              ../../bin/phpstan analyse --configuration test-no-baseline.neon --generate-baseline test-baseline.neon
+              ../../bin/phpstan analyse --configuration test.neon
 
     steps:
       - name: "Checkout"

diff --git a/bin/generate-rule-error-classes.php b/bin/generate-rule-error-classes.php
@@ -33,17 +33,13 @@ class RuleError%s implements %s
 		}
 		$properties = [];
 		$interfaces = [];
-		foreach ($ruleErrorTypes as $typeNumber => [$interface, $propertyName, $nativePropertyType, $phpDocPropertyType]) {
+		foreach ($ruleErrorTypes as $typeNumber => [$interface, $typeProperties]) {
 			if (!(($typeCombination & $typeNumber) === $typeNumber)) {
 				continue;
 			}
 
 			$interfaces[] = '\\' . $interface;
-			if ($propertyName === null || $nativePropertyType === null || $phpDocPropertyType === null) {
-				continue;
-			}
-
-			$properties[] = [$propertyName, $nativePropertyType, $phpDocPropertyType];
+			$properties = array_merge($properties, $typeProperties);
 		}
 
 		$phpClass = sprintf(

diff --git a/e2e/baseline-uninit-prop-trait/src/Foo.php b/e2e/baseline-uninit-prop-trait/src/Foo.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace Readonly\Uninit\Bug;
+
+trait Foo
+{
+	protected readonly int $x;
+
+	public function foo(): void
+	{
+		echo $this->x;
+	}
+
+	public function init(): void
+	{
+		$this->x = rand();
+	}
+}
diff --git a/e2e/baseline-uninit-prop-trait/src/HelloWorld.php b/e2e/baseline-uninit-prop-trait/src/HelloWorld.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Readonly\Uninit\Bug;
+
+class HelloWorld
+{
+	use Foo;
+
+	public function __construct()
+	{
+		$this->init();
+		$this->foo();
+	}
+}
diff --git a/e2e/baseline-uninit-prop-trait/test-no-baseline.neon b/e2e/baseline-uninit-prop-trait/test-no-baseline.neon
@@ -0,0 +1,4 @@
+parameters:
+    level: 9
+    paths:
+        - src
diff --git a/e2e/baseline-uninit-prop-trait/test.neon b/e2e/baseline-uninit-prop-trait/test.neon
@@ -0,0 +1,3 @@
+includes:
+    - test-baseline.neon
+    - test-no-baseline.neon
diff --git a/src/Analyser/RuleErrorTransformer.php b/src/Analyser/RuleErrorTransformer.php
@@ -53,7 +53,7 @@ public function transform(
 				$ruleError instanceof FileRuleError
 				&& $ruleError->getFile() !== ''
 			) {
-				$fileName = $ruleError->getFile();
+				$fileName = $ruleError->getFileDescription();
 				$filePath = $ruleError->getFile();
 				$traitFilePath = null;
 			}

diff --git a/src/Node/ClassPropertiesNode.php b/src/Node/ClassPropertiesNode.php
@@ -93,7 +93,7 @@ public function getClassReflection(): ClassReflection
 	/**
 	 * @param string[] $constructors
 	 * @param ReadWritePropertiesExtension[]|null $extensions
-	 * @return array{array<string, ClassPropertyNode>, array<array{string, int, ClassPropertyNode, string}>, array<array{string, int, ClassPropertyNode}>}
+	 * @return array{array<string, ClassPropertyNode>, array<array{string, int, ClassPropertyNode, string, string}>, array<array{string, int, ClassPropertyNode}>}
 	 */
 	public function getUninitializedProperties(
 		Scope $scope,
@@ -231,6 +231,7 @@ public function getUninitializedProperties(
 						$propertyName,
 						$fetch->getLine(),
 						$originalProperties[$propertyName],
+						$usageScope->getFile(),
 						$usageScope->getFileDescription(),
 					];
 				}

diff --git a/src/Rules/FileRuleError.php b/src/Rules/FileRuleError.php
@@ -8,4 +8,6 @@ interface FileRuleError extends RuleError
 
 	public function getFile(): string;
 
+	public function getFileDescription(): string;
+
 }
diff --git a/src/Rules/Properties/MissingReadOnlyByPhpDocPropertyAssignRule.php b/src/Rules/Properties/MissingReadOnlyByPhpDocPropertyAssignRule.php
@@ -47,7 +47,7 @@ public function processNode(Node $node, Scope $scope): array
 				->build();
 		}
 
-		foreach ($prematureAccess as [$propertyName, $line, $propertyNode, $file]) {
+		foreach ($prematureAccess as [$propertyName, $line, $propertyNode, $file, $fileDescription]) {
 			if (!$propertyNode->isReadOnlyByPhpDoc() || $propertyNode->isReadOnly()) {
 				continue;
 			}
@@ -58,7 +58,7 @@ public function processNode(Node $node, Scope $scope): array
 			))
 				->identifier('property.uninitializedReadonlyByPhpDoc')
 				->line($line)
-				->file($file)
+				->file($file, $fileDescription)
 				->build();
 		}
 

diff --git a/src/Rules/Properties/MissingReadOnlyPropertyAssignRule.php b/src/Rules/Properties/MissingReadOnlyPropertyAssignRule.php
@@ -47,7 +47,7 @@ public function processNode(Node $node, Scope $scope): array
 				->build();
 		}
 
-		foreach ($prematureAccess as [$propertyName, $line, $propertyNode, $file]) {
+		foreach ($prematureAccess as [$propertyName, $line, $propertyNode, $file, $fileDescription]) {
 			if (!$propertyNode->isReadOnly()) {
 				continue;
 			}
@@ -57,7 +57,7 @@ public function processNode(Node $node, Scope $scope): array
 				$propertyName,
 			))
 				->line($line)
-				->file($file)
+				->file($file, $fileDescription)
 				->identifier('property.uninitializedReadonly')
 				->build();
 		}

diff --git a/src/Rules/Properties/UninitializedPropertyRule.php b/src/Rules/Properties/UninitializedPropertyRule.php
@@ -47,7 +47,7 @@ public function processNode(Node $node, Scope $scope): array
 				->build();
 		}
 
-		foreach ($prematureAccess as [$propertyName, $line, $propertyNode, $file]) {
+		foreach ($prematureAccess as [$propertyName, $line, $propertyNode, $file, $fileDescription]) {
 			if ($propertyNode->isReadOnly() || $propertyNode->isReadOnlyByPhpDoc()) {
 				continue;
 			}
@@ -57,7 +57,7 @@ public function processNode(Node $node, Scope $scope): array
 				$propertyName,
 			))
 				->line($line)
-				->file($file)
+				->file($file, $fileDescription)
 				->identifier('property.uninitialized')
 				->build();
 		}

diff --git a/src/Rules/RuleErrorBuilder.php b/src/Rules/RuleErrorBuilder.php
@@ -40,52 +40,79 @@ private function __construct(string $message)
 	}
 
 	/**
-	 * @return array<int, array{string, string|null, string|null, string|null}>
+	 * @return array<int, array{string, array<array{string|null, string|null, string|null}>}>
 	 */
 	public static function getRuleErrorTypes(): array
 	{
 		return [
 			self::TYPE_MESSAGE => [
 				RuleError::class,
-				'message',
-				'string',
-				'string',
+				[
+					[
+						'message',
+						'string',
+						'string',
+					],
+				],
 			],
 			self::TYPE_LINE => [
 				LineRuleError::class,
-				'line',
-				'int',
-				'int',
+				[
+					[
+						'line',
+						'int',
+						'int',
+					],
+				],
 			],
 			self::TYPE_FILE => [
 				FileRuleError::class,
-				'file',
-				'string',
-				'string',
+				[
+					[
+						'file',
+						'string',
+						'string',
+					],
+					[
+						'fileDescription',
+						'string',
+						'string',
+					],
+				],
 			],
 			self::TYPE_TIP => [
 				TipRuleError::class,
-				'tip',
-				'string',
-				'string',
+				[
+					[
+						'tip',
+						'string',
+						'string',
+					],
+				],
 			],
 			self::TYPE_IDENTIFIER => [
 				IdentifierRuleError::class,
-				'identifier',
-				'string',
-				'string',
+				[
+					[
+						'identifier',
+						'string',
+						'string',
+					],
+				],
 			],
 			self::TYPE_METADATA => [
 				MetadataRuleError::class,
-				'metadata',
-				'array',
-				'mixed[]',
+				[
+					[
+						'metadata',
+						'array',
+						'mixed[]',
+					],
+				],
 			],
 			self::TYPE_NON_IGNORABLE => [
 				NonIgnorableRuleError::class,
-				null,
-				null,
-				null,
+				[],
 			],
 		];
 	}
@@ -114,9 +141,10 @@ public function line(int $line): self
 	 * @phpstan-this-out self<T&FileRuleError>
 	 * @return self<T&FileRuleError>
 	 */
-	public function file(string $file): self
+	public function file(string $file, ?string $fileDescription = null): self
 	{
 		$this->properties['file'] = $file;
+		$this->properties['fileDescription'] = $fileDescription ?? $file;
 		$this->type |= self::TYPE_FILE;
 
 		return $this;

diff --git a/src/Rules/RuleErrors/RuleError101.php b/src/Rules/RuleErrors/RuleError101.php
@@ -17,6 +17,8 @@ class RuleError101 implements RuleError, FileRuleError, MetadataRuleError, NonIg
 
 	public string $file;
 
+	public string $fileDescription;
+
 	/** @var mixed[] */
 	public array $metadata;
 
@@ -30,6 +32,11 @@ public function getFile(): string
 		return $this->file;
 	}
 
+	public function getFileDescription(): string
+	{
+		return $this->fileDescription;
+	}
+
 	/**
 	 * @return mixed[]
 	 */

diff --git a/src/Rules/RuleErrors/RuleError103.php b/src/Rules/RuleErrors/RuleError103.php
@@ -20,6 +20,8 @@ class RuleError103 implements RuleError, LineRuleError, FileRuleError, MetadataR
 
 	public string $file;
 
+	public string $fileDescription;
+
 	/** @var mixed[] */
 	public array $metadata;
 
@@ -38,6 +40,11 @@ public function getFile(): string
 		return $this->file;
 	}
 
+	public function getFileDescription(): string
+	{
+		return $this->fileDescription;
+	}
+
 	/**
 	 * @return mixed[]
 	 */

diff --git a/src/Rules/RuleErrors/RuleError109.php b/src/Rules/RuleErrors/RuleError109.php
@@ -18,6 +18,8 @@ class RuleError109 implements RuleError, FileRuleError, TipRuleError, MetadataRu
 
 	public string $file;
 
+	public string $fileDescription;
+
 	public string $tip;
 
 	/** @var mixed[] */
@@ -33,6 +35,11 @@ public function getFile(): string
 		return $this->file;
 	}
 
+	public function getFileDescription(): string
+	{
+		return $this->fileDescription;
+	}
+
 	public function getTip(): string
 	{
 		return $this->tip;

diff --git a/src/Rules/RuleErrors/RuleError111.php b/src/Rules/RuleErrors/RuleError111.php
@@ -21,6 +21,8 @@ class RuleError111 implements RuleError, LineRuleError, FileRuleError, TipRuleEr
 
 	public string $file;
 
+	public string $fileDescription;
+
 	public string $tip;
 
 	/** @var mixed[] */
@@ -41,6 +43,11 @@ public function getFile(): string
 		return $this->file;
 	}
 
+	public function getFileDescription(): string
+	{
+		return $this->fileDescription;
+	}
+
 	public function getTip(): string
 	{
 		return $this->tip;

diff --git a/src/Rules/RuleErrors/RuleError117.php b/src/Rules/RuleErrors/RuleError117.php
@@ -18,6 +18,8 @@ class RuleError117 implements RuleError, FileRuleError, IdentifierRuleError, Met
 
 	public string $file;
 
+	public string $fileDescription;
+
 	public string $identifier;
 
 	/** @var mixed[] */
@@ -33,6 +35,11 @@ public function getFile(): string
 		return $this->file;
 	}
 
+	public function getFileDescription(): string
+	{
+		return $this->fileDescription;
+	}
+
 	public function getIdentifier(): string
 	{
 		return $this->identifier;