Specify generics in rules and rule tests

ondrejmirtes · ondrejmirtes · commit df11a5e16c8e · 2019-11-25T22:30:32.000+01:00
diff --git a/phpcs.xml b/phpcs.xml
@@ -23,7 +23,10 @@
 				@dataProvider,
 				@requires
 			"/>
+			<property name="enableObjectTypeHint" value="false"/>
 		</properties>
+		<exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableParameterTypeHintSpecification"/>
+		<exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableReturnTypeHintSpecification"/>
 	</rule>
 	<rule ref="SlevomatCodingStandard.ControlStructures.AssignmentInCondition"/>
 	<rule ref="SlevomatCodingStandard.ControlStructures.DisallowEqualOperators"/>
diff --git a/src/Rules/Deprecations/AccessDeprecatedPropertyRule.php b/src/Rules/Deprecations/AccessDeprecatedPropertyRule.php
@@ -9,6 +9,9 @@
 use PHPStan\Broker\Broker;
 use PHPStan\Type\TypeUtils;
 
+/**
+ * @implements \PHPStan\Rules\Rule<PropertyFetch>
+ */
 class AccessDeprecatedPropertyRule implements \PHPStan\Rules\Rule
 {
 
@@ -25,11 +28,6 @@ public function getNodeType(): string
 		return PropertyFetch::class;
 	}
 
-	/**
-	 * @param PropertyFetch $node
-	 * @param \PHPStan\Analyser\Scope $scope
-	 * @return string[] errors
-	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {
diff --git a/src/Rules/Deprecations/AccessDeprecatedStaticPropertyRule.php b/src/Rules/Deprecations/AccessDeprecatedStaticPropertyRule.php
@@ -12,6 +12,9 @@
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\Type;
 
+/**
+ * @implements \PHPStan\Rules\Rule<StaticPropertyFetch>
+ */
 class AccessDeprecatedStaticPropertyRule implements \PHPStan\Rules\Rule
 {
 
@@ -32,11 +35,6 @@ public function getNodeType(): string
 		return StaticPropertyFetch::class;
 	}
 
-	/**
-	 * @param StaticPropertyFetch $node
-	 * @param \PHPStan\Analyser\Scope $scope
-	 * @return string[] errors
-	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {
diff --git a/src/Rules/Deprecations/CallToDeprecatedFunctionRule.php b/src/Rules/Deprecations/CallToDeprecatedFunctionRule.php
@@ -7,6 +7,9 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Broker\Broker;
 
+/**
+ * @implements \PHPStan\Rules\Rule<FuncCall>
+ */
 class CallToDeprecatedFunctionRule implements \PHPStan\Rules\Rule
 {
 
@@ -23,11 +26,6 @@ public function getNodeType(): string
 		return FuncCall::class;
 	}
 
-	/**
-	 * @param FuncCall $node
-	 * @param \PHPStan\Analyser\Scope $scope
-	 * @return string[] errors
-	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {
diff --git a/src/Rules/Deprecations/CallToDeprecatedMethodRule.php b/src/Rules/Deprecations/CallToDeprecatedMethodRule.php
@@ -9,6 +9,9 @@
 use PHPStan\Broker\Broker;
 use PHPStan\Type\TypeUtils;
 
+/**
+ * @implements \PHPStan\Rules\Rule<MethodCall>
+ */
 class CallToDeprecatedMethodRule implements \PHPStan\Rules\Rule
 {
 
@@ -25,11 +28,6 @@ public function getNodeType(): string
 		return MethodCall::class;
 	}
 
-	/**
-	 * @param MethodCall $node
-	 * @param \PHPStan\Analyser\Scope $scope
-	 * @return string[] errors
-	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {
diff --git a/src/Rules/Deprecations/CallToDeprecatedStaticMethodRule.php b/src/Rules/Deprecations/CallToDeprecatedStaticMethodRule.php
@@ -12,6 +12,9 @@
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\Type;
 
+/**
+ * @implements \PHPStan\Rules\Rule<StaticCall>
+ */
 class CallToDeprecatedStaticMethodRule implements \PHPStan\Rules\Rule
 {
 
@@ -32,11 +35,6 @@ public function getNodeType(): string
 		return StaticCall::class;
 	}
 
-	/**
-	 * @param StaticCall $node
-	 * @param \PHPStan\Analyser\Scope $scope
-	 * @return string[] errors
-	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {
diff --git a/src/Rules/Deprecations/FetchingClassConstOfDeprecatedClassRule.php b/src/Rules/Deprecations/FetchingClassConstOfDeprecatedClassRule.php
@@ -12,6 +12,9 @@
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\Type;
 
+/**
+ * @implements \PHPStan\Rules\Rule<ClassConstFetch>
+ */
 class FetchingClassConstOfDeprecatedClassRule implements \PHPStan\Rules\Rule
 {
 
@@ -32,11 +35,6 @@ public function getNodeType(): string
 		return ClassConstFetch::class;
 	}
 
-	/**
-	 * @param ClassConstFetch $node
-	 * @param \PHPStan\Analyser\Scope $scope
-	 * @return string[] errors
-	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {
diff --git a/src/Rules/Deprecations/ImplementationOfDeprecatedInterfaceRule.php b/src/Rules/Deprecations/ImplementationOfDeprecatedInterfaceRule.php
@@ -7,6 +7,9 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Broker\Broker;
 
+/**
+ * @implements \PHPStan\Rules\Rule<Class_>
+ */
 class ImplementationOfDeprecatedInterfaceRule implements \PHPStan\Rules\Rule
 {
 
@@ -23,11 +26,6 @@ public function getNodeType(): string
 		return Class_::class;
 	}
 
-	/**
-	 * @param Class_ $node
-	 * @param \PHPStan\Analyser\Scope $scope
-	 * @return string[] errors
-	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {
diff --git a/src/Rules/Deprecations/InheritanceOfDeprecatedClassRule.php b/src/Rules/Deprecations/InheritanceOfDeprecatedClassRule.php
@@ -7,6 +7,9 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Broker\Broker;
 
+/**
+ * @implements \PHPStan\Rules\Rule<Class_>
+ */
 class InheritanceOfDeprecatedClassRule implements \PHPStan\Rules\Rule
 {
 
@@ -23,11 +26,6 @@ public function getNodeType(): string
 		return Class_::class;
 	}
 
-	/**
-	 * @param Class_ $node
-	 * @param \PHPStan\Analyser\Scope $scope
-	 * @return string[] errors
-	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {
diff --git a/src/Rules/Deprecations/InheritanceOfDeprecatedInterfaceRule.php b/src/Rules/Deprecations/InheritanceOfDeprecatedInterfaceRule.php
@@ -7,6 +7,9 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Broker\Broker;
 
+/**
+ * @implements \PHPStan\Rules\Rule<Interface_>
+ */
 class InheritanceOfDeprecatedInterfaceRule implements \PHPStan\Rules\Rule
 {
 
@@ -23,11 +26,6 @@ public function getNodeType(): string
 		return Interface_::class;
 	}
 
-	/**
-	 * @param Interface_ $node
-	 * @param \PHPStan\Analyser\Scope $scope
-	 * @return string[] errors
-	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if ($node->extends === null) {
diff --git a/src/Rules/Deprecations/InstantiationOfDeprecatedClassRule.php b/src/Rules/Deprecations/InstantiationOfDeprecatedClassRule.php
@@ -11,6 +11,9 @@
 use PHPStan\Rules\RuleLevelHelper;
 use PHPStan\Type\ErrorType;
 
+/**
+ * @implements \PHPStan\Rules\Rule<New_>
+ */
 class InstantiationOfDeprecatedClassRule implements \PHPStan\Rules\Rule
 {
 
@@ -31,11 +34,6 @@ public function getNodeType(): string
 		return New_::class;
 	}
 
-	/**
-	 * @param New_ $node
-	 * @param \PHPStan\Analyser\Scope $scope
-	 * @return string[] errors
-	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {
diff --git a/src/Rules/Deprecations/TypeHintDeprecatedInClassMethodSignatureRule.php b/src/Rules/Deprecations/TypeHintDeprecatedInClassMethodSignatureRule.php
@@ -8,6 +8,9 @@
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 
+/**
+ * @implements \PHPStan\Rules\Rule<InClassMethodNode>
+ */
 class TypeHintDeprecatedInClassMethodSignatureRule implements \PHPStan\Rules\Rule
 {
 
@@ -24,11 +27,6 @@ public function getNodeType(): string
 		return InClassMethodNode::class;
 	}
 
-	/**
-	 * @param InClassMethodNode $node
-	 * @param \PHPStan\Analyser\Scope $scope
-	 * @return string[] errors
-	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {
diff --git a/src/Rules/Deprecations/TypeHintDeprecatedInClosureSignatureRule.php b/src/Rules/Deprecations/TypeHintDeprecatedInClosureSignatureRule.php
@@ -5,9 +5,11 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\InClosureNode;
-use PHPStan\Node\InFunctionNode;
 use PHPStan\Reflection\ParametersAcceptor;
 
+/**
+ * @implements \PHPStan\Rules\Rule<InClosureNode>
+ */
 class TypeHintDeprecatedInClosureSignatureRule implements \PHPStan\Rules\Rule
 {
 
@@ -24,11 +26,6 @@ public function getNodeType(): string
 		return InClosureNode::class;
 	}
 
-	/**
-	 * @param InFunctionNode $node
-	 * @param \PHPStan\Analyser\Scope $scope
-	 * @return string[] errors
-	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {
diff --git a/src/Rules/Deprecations/TypeHintDeprecatedInFunctionSignatureRule.php b/src/Rules/Deprecations/TypeHintDeprecatedInFunctionSignatureRule.php
@@ -8,6 +8,9 @@
 use PHPStan\Reflection\FunctionReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 
+/**
+ * @implements \PHPStan\Rules\Rule<InFunctionNode>
+ */
 class TypeHintDeprecatedInFunctionSignatureRule implements \PHPStan\Rules\Rule
 {
 
@@ -24,11 +27,6 @@ public function getNodeType(): string
 		return InFunctionNode::class;
 	}
 
-	/**
-	 * @param InFunctionNode $node
-	 * @param \PHPStan\Analyser\Scope $scope
-	 * @return string[] errors
-	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {
diff --git a/src/Rules/Deprecations/UsageOfDeprecatedTraitRule.php b/src/Rules/Deprecations/UsageOfDeprecatedTraitRule.php
@@ -7,6 +7,9 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Broker\Broker;
 
+/**
+ * @implements \PHPStan\Rules\Rule<TraitUse>
+ */
 class UsageOfDeprecatedTraitRule implements \PHPStan\Rules\Rule
 {
 
@@ -23,11 +26,6 @@ public function getNodeType(): string
 		return TraitUse::class;
 	}
 
-	/**
-	 * @param TraitUse $node
-	 * @param \PHPStan\Analyser\Scope $scope
-	 * @return string[] errors
-	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {
diff --git a/tests/Rules/Deprecations/AccessDeprecatedPropertyRuleTest.php b/tests/Rules/Deprecations/AccessDeprecatedPropertyRuleTest.php
@@ -2,6 +2,9 @@
 
 namespace PHPStan\Rules\Deprecations;
 
+/**
+ * @extends \PHPStan\Testing\RuleTestCase<AccessDeprecatedPropertyRule>
+ */
 class AccessDeprecatedPropertyRuleTest extends \PHPStan\Testing\RuleTestCase
 {
 
diff --git a/tests/Rules/Deprecations/AccessDeprecatedStaticPropertyRuleTest.php b/tests/Rules/Deprecations/AccessDeprecatedStaticPropertyRuleTest.php
@@ -4,6 +4,9 @@
 
 use PHPStan\Rules\RuleLevelHelper;
 
+/**
+ * @extends \PHPStan\Testing\RuleTestCase<AccessDeprecatedStaticPropertyRule>
+ */
 class AccessDeprecatedStaticPropertyRuleTest extends \PHPStan\Testing\RuleTestCase
 {
 
diff --git a/tests/Rules/Deprecations/CallToDeprecatedFunctionRuleTest.php b/tests/Rules/Deprecations/CallToDeprecatedFunctionRuleTest.php
@@ -2,6 +2,9 @@
 
 namespace PHPStan\Rules\Deprecations;
 
+/**
+ * @extends \PHPStan\Testing\RuleTestCase<CallToDeprecatedFunctionRule>
+ */
 class CallToDeprecatedFunctionRuleTest extends \PHPStan\Testing\RuleTestCase
 {
 
diff --git a/tests/Rules/Deprecations/CallToDeprecatedMethodRuleTest.php b/tests/Rules/Deprecations/CallToDeprecatedMethodRuleTest.php
@@ -2,6 +2,9 @@
 
 namespace PHPStan\Rules\Deprecations;
 
+/**
+ * @extends \PHPStan\Testing\RuleTestCase<CallToDeprecatedMethodRule>
+ */
 class CallToDeprecatedMethodRuleTest extends \PHPStan\Testing\RuleTestCase
 {
 
diff --git a/tests/Rules/Deprecations/CallToDeprecatedStaticMethodRuleTest.php b/tests/Rules/Deprecations/CallToDeprecatedStaticMethodRuleTest.php
@@ -4,6 +4,9 @@
 
 use PHPStan\Rules\RuleLevelHelper;
 
+/**
+ * @extends \PHPStan\Testing\RuleTestCase<CallToDeprecatedStaticMethodRule>
+ */
 class CallToDeprecatedStaticMethodRuleTest extends \PHPStan\Testing\RuleTestCase
 {
 
diff --git a/tests/Rules/Deprecations/FetchingClassConstOfDeprecatedClassRuleTest.php b/tests/Rules/Deprecations/FetchingClassConstOfDeprecatedClassRuleTest.php
@@ -4,6 +4,9 @@
 
 use PHPStan\Rules\RuleLevelHelper;
 
+/**
+ * @extends \PHPStan\Testing\RuleTestCase<FetchingClassConstOfDeprecatedClassRule>
+ */
 class FetchingClassConstOfDeprecatedClassRuleTest extends \PHPStan\Testing\RuleTestCase
 {
 
diff --git a/tests/Rules/Deprecations/ImplementationOfDeprecatedInterfaceRuleTest.php b/tests/Rules/Deprecations/ImplementationOfDeprecatedInterfaceRuleTest.php
@@ -2,6 +2,9 @@
 
 namespace PHPStan\Rules\Deprecations;
 
+/**
+ * @extends \PHPStan\Testing\RuleTestCase<ImplementationOfDeprecatedInterfaceRule>
+ */
 class ImplementationOfDeprecatedInterfaceRuleTest extends \PHPStan\Testing\RuleTestCase
 {
 
diff --git a/tests/Rules/Deprecations/InheritanceOfDeprecatedClassRuleTest.php b/tests/Rules/Deprecations/InheritanceOfDeprecatedClassRuleTest.php
diff --git a/tests/Rules/Deprecations/InheritanceOfDeprecatedInterfaceRuleTest.php b/tests/Rules/Deprecations/InheritanceOfDeprecatedInterfaceRuleTest.php
diff --git a/tests/Rules/Deprecations/InstantiationOfDeprecatedClassRuleTest.php b/tests/Rules/Deprecations/InstantiationOfDeprecatedClassRuleTest.php
diff --git a/tests/Rules/Deprecations/TypeHintDeprecatedInClassMethodSignatureRuleTest.php b/tests/Rules/Deprecations/TypeHintDeprecatedInClassMethodSignatureRuleTest.php
diff --git a/tests/Rules/Deprecations/TypeHintDeprecatedInClosureSignatureRuleTest.php b/tests/Rules/Deprecations/TypeHintDeprecatedInClosureSignatureRuleTest.php
diff --git a/tests/Rules/Deprecations/TypeHintDeprecatedInFunctionSignatureRuleTest.php b/tests/Rules/Deprecations/TypeHintDeprecatedInFunctionSignatureRuleTest.php
diff --git a/tests/Rules/Deprecations/UsageOfDeprecatedTraitRuleTest.php b/tests/Rules/Deprecations/UsageOfDeprecatedTraitRuleTest.php

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,9 @@`
`9`	`9`	`use PHPStan\Broker\Broker;`
`10`	`10`	`use PHPStan\Type\TypeUtils;`
`11`	`11`
	`12`	`+/**`
	`13`	`+ * @implements \PHPStan\Rules\Rule<PropertyFetch>`
	`14`	`+ */`
`12`	`15`	`class AccessDeprecatedPropertyRule implements \PHPStan\Rules\Rule`
`13`	`16`	`{`
`14`	`17`
`@@ -25,11 +28,6 @@ public function getNodeType(): string`
`25`	`28`	`return PropertyFetch::class;`
`26`	`29`	`}`
`27`	`30`
`28`		`- /**`
`29`		`- * @param PropertyFetch $node`
`30`		`- * @param \PHPStan\Analyser\Scope $scope`
`31`		`- * @return string[] errors`
`32`		`- */`
`33`	`31`	`public function processNode(Node $node, Scope $scope): array`
`34`	`32`	`{`
`35`	`33`	`if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,9 @@`
`12`	`12`	`use PHPStan\Type\ErrorType;`
`13`	`13`	`use PHPStan\Type\Type;`
`14`	`14`
	`15`	`+/**`
	`16`	`+ * @implements \PHPStan\Rules\Rule<StaticPropertyFetch>`
	`17`	`+ */`
`15`	`18`	`class AccessDeprecatedStaticPropertyRule implements \PHPStan\Rules\Rule`
`16`	`19`	`{`
`17`	`20`
`@@ -32,11 +35,6 @@ public function getNodeType(): string`
`32`	`35`	`return StaticPropertyFetch::class;`
`33`	`36`	`}`
`34`	`37`
`35`		`- /**`
`36`		`- * @param StaticPropertyFetch $node`
`37`		`- * @param \PHPStan\Analyser\Scope $scope`
`38`		`- * @return string[] errors`
`39`		`- */`
`40`	`38`	`public function processNode(Node $node, Scope $scope): array`
`41`	`39`	`{`
`42`	`40`	`if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,9 @@`
`7`	`7`	`use PHPStan\Analyser\Scope;`
`8`	`8`	`use PHPStan\Broker\Broker;`
`9`	`9`
	`10`	`+/**`
	`11`	`+ * @implements \PHPStan\Rules\Rule<FuncCall>`
	`12`	`+ */`
`10`	`13`	`class CallToDeprecatedFunctionRule implements \PHPStan\Rules\Rule`
`11`	`14`	`{`
`12`	`15`
`@@ -23,11 +26,6 @@ public function getNodeType(): string`
`23`	`26`	`return FuncCall::class;`
`24`	`27`	`}`
`25`	`28`
`26`		`- /**`
`27`		`- * @param FuncCall $node`
`28`		`- * @param \PHPStan\Analyser\Scope $scope`
`29`		`- * @return string[] errors`
`30`		`- */`
`31`	`29`	`public function processNode(Node $node, Scope $scope): array`
`32`	`30`	`{`
`33`	`31`	`if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {`