Bleeding edge - check @mixin PHPDoc tag above traits

Author: ondrejmirtes

conf/config.level2.neon

@@ -55,6 +55,10 @@ conditionalTags:
 		phpstan.rules.rule: %featureToggles.absentTypeChecks%
 	PHPStan\Rules\Classes\MethodTagTraitUseRule:
 		phpstan.rules.rule: %featureToggles.absentTypeChecks%
+	PHPStan\Rules\Classes\MixinTraitRule:
+		phpstan.rules.rule: %featureToggles.absentTypeChecks%
+	PHPStan\Rules\Classes\MixinTraitUseRule:
+		phpstan.rules.rule: %featureToggles.absentTypeChecks%
 	PHPStan\Rules\Classes\PropertyTagRule:
 		phpstan.rules.rule: %featureToggles.absentTypeChecks%
 	PHPStan\Rules\Classes\PropertyTagTraitRule:
@@ -86,6 +90,12 @@ services:
 		tags:
 			- phpstan.rules.rule
 
+	-
+		class: PHPStan\Rules\Classes\MixinTraitRule
+
+	-
+		class: PHPStan\Rules\Classes\MixinTraitUseRule
+
 	-
 		class: PHPStan\Rules\Classes\MethodTagRule
 

src/PhpDoc/StubValidator.php

@@ -33,6 +33,8 @@
 use PHPStan\Rules\Classes\MethodTagTraitUseRule;
 use PHPStan\Rules\Classes\MixinCheck;
 use PHPStan\Rules\Classes\MixinRule;
+use PHPStan\Rules\Classes\MixinTraitRule;
+use PHPStan\Rules\Classes\MixinTraitUseRule;
 use PHPStan\Rules\Classes\PropertyTagCheck;
 use PHPStan\Rules\Classes\PropertyTagRule;
 use PHPStan\Rules\Classes\PropertyTagTraitRule;
@@ -259,6 +261,8 @@ private function getRuleRegistry(Container $container): RuleRegistry
 			$rules[] = new PropertyTagTraitRule($propertyTagCheck, $reflectionProvider);
 			$rules[] = new PropertyTagTraitUseRule($propertyTagCheck);
 			$rules[] = new MixinRule($mixinCheck);
+			$rules[] = new MixinTraitRule($mixinCheck, $reflectionProvider);
+			$rules[] = new MixinTraitUseRule($mixinCheck);
 			$rules[] = new LocalTypeTraitUseAliasesRule($localTypeAliasesCheck);
 			$rules[] = new MethodTagTemplateTypeTraitRule($methodTagTemplateTypeCheck, $reflectionProvider);
 		}

src/Rules/Classes/MixinTraitRule.php

@@ -0,0 +1,41 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Classes;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Rules\Rule;
+
+/**
+ * @implements Rule<Node\Stmt\Trait_>
+ */
+final class MixinTraitRule implements Rule
+{
+
+	public function __construct(private MixinCheck $check, private ReflectionProvider $reflectionProvider)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return Node\Stmt\Trait_::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$traitName = $node->namespacedName;
+		if ($traitName === null) {
+			return [];
+		}
+
+		if (!$this->reflectionProvider->hasClass($traitName->toString())) {
+			return [];
+		}
+
+		return $this->check->checkInTraitDefinitionContext(
+			$this->reflectionProvider->getClass($traitName->toString()),
+		);
+	}
+
+}

src/Rules/Classes/MixinTraitUseRule.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Classes;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\InTraitNode;
+use PHPStan\Rules\Rule;
+
+/**
+ * @implements Rule<InTraitNode>
+ */
+final class MixinTraitUseRule implements Rule
+{
+
+	public function __construct(private MixinCheck $check)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return InTraitNode::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		return $this->check->checkInTraitUseContext(
+			$node->getTraitReflection(),
+			$node->getImplementingClassReflection(),
+			$node->getOriginalNode(),
+		);
+	}
+
+}

tests/PHPStan/Analyser/NodeScopeResolverTest.php

@@ -184,6 +184,7 @@ public function dataFileAsserts(): iterable
 		yield from $this->gatherAssertTypes(__DIR__ . '/../Rules/Classes/data/bug-11591.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/../Rules/Classes/data/bug-11591-method-tag.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/../Rules/Classes/data/bug-11591-property-tag.php');
+		yield from $this->gatherAssertTypes(__DIR__ . '/../Rules/Classes/data/mixin-trait-use.php');
 	}
 
 	/**

tests/PHPStan/Rules/Classes/MixinTraitRuleTest.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Classes;
+
+use PHPStan\Rules\ClassCaseSensitivityCheck;
+use PHPStan\Rules\ClassForbiddenNameCheck;
+use PHPStan\Rules\ClassNameCheck;
+use PHPStan\Rules\Generics\GenericObjectTypeCheck;
+use PHPStan\Rules\MissingTypehintCheck;
+use PHPStan\Rules\PhpDoc\UnresolvableTypeHelper;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<MixinTraitRule>
+ */
+class MixinTraitRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		$reflectionProvider = $this->createReflectionProvider();
+
+		return new MixinTraitRule(
+			new MixinCheck(
+				$reflectionProvider,
+				new ClassNameCheck(
+					new ClassCaseSensitivityCheck($reflectionProvider, true),
+					new ClassForbiddenNameCheck(self::getContainer()),
+				),
+				new GenericObjectTypeCheck(),
+				new MissingTypehintCheck(true, true, true, true, []),
+				new UnresolvableTypeHelper(),
+				true,
+				true,
+			),
+			$reflectionProvider,
+		);
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/mixin-trait.php'], [
+			[
+				'Trait MixinTrait\FooTrait has PHPDoc tag @mixin with no value type specified in iterable type array.',
+				14,
+				MissingTypehintCheck::MISSING_ITERABLE_VALUE_TYPE_TIP,
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Classes/MixinTraitUseRuleTest.php

@@ -0,0 +1,50 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Classes;
+
+use PHPStan\Rules\ClassCaseSensitivityCheck;
+use PHPStan\Rules\ClassForbiddenNameCheck;
+use PHPStan\Rules\ClassNameCheck;
+use PHPStan\Rules\Generics\GenericObjectTypeCheck;
+use PHPStan\Rules\MissingTypehintCheck;
+use PHPStan\Rules\PhpDoc\UnresolvableTypeHelper;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<MixinTraitUseRule>
+ */
+class MixinTraitUseRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		$reflectionProvider = $this->createReflectionProvider();
+
+		return new MixinTraitUseRule(
+			new MixinCheck(
+				$reflectionProvider,
+				new ClassNameCheck(
+					new ClassCaseSensitivityCheck($reflectionProvider, true),
+					new ClassForbiddenNameCheck(self::getContainer()),
+				),
+				new GenericObjectTypeCheck(),
+				new MissingTypehintCheck(true, true, true, true, []),
+				new UnresolvableTypeHelper(),
+				true,
+				true,
+			),
+		);
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/mixin-trait-use.php'], [
+			[
+				'PHPDoc tag @mixin contains unresolvable type.',
+				22,
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Classes/data/mixin-trait-use.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace MixinTraitUse;
+
+use function PHPStan\Testing\assertType;
+
+/**
+ * @template T
+ */
+interface Foo
+{
+
+	/** @return T */
+	public function get();
+
+}
+
+/**
+ * @mixin Foo<static>
+ * @mixin string&int
+ */
+trait FooTrait
+{
+
+}
+
+class Usages
+{
+
+	use FooTrait;
+
+}
+
+function (Usages $u): void {
+	assertType(Usages::class, $u->get());
+};

tests/PHPStan/Rules/Classes/data/mixin-trait.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace MixinTrait;
+
+/** @template T */
+class Foo
+{
+
+}
+
+/**
+ * @mixin Foo<array>
+ */
+trait FooTrait
+{
+
+}