Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support contravariant template types #2051

Merged
merged 6 commits into from Dec 5, 2022
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/PhpDoc/PhpDocNodeResolver.php
Expand Up @@ -264,6 +264,8 @@ public function resolveTemplateTags(PhpDocNode $phpDocNode, NameScope $nameScope
$variance = TemplateTypeVariance::createInvariant();
} elseif (in_array($tagName, ['@template-covariant', '@psalm-template-covariant', '@phpstan-template-covariant'], true)) {
$variance = TemplateTypeVariance::createCovariant();
} elseif (in_array($tagName, ['@template-contravariant', '@psalm-template-contravariant', '@phpstan-template-contravariant'], true)) {
$variance = TemplateTypeVariance::createContravariant();
} else {
continue;
}
Expand Down
2 changes: 1 addition & 1 deletion src/Type/Generic/TemplateTypeVariance.php
Expand Up @@ -85,7 +85,7 @@ public function compose(self $other): self

if ($this->covariant()) {
if ($other->contravariant()) {
return self::createCovariant();
return self::createContravariant();
}
if ($other->covariant()) {
return self::createCovariant();
Expand Down
134 changes: 125 additions & 9 deletions tests/PHPStan/Rules/Generics/MethodSignatureVarianceRuleTest.php
Expand Up @@ -22,25 +22,141 @@ public function testRule(): void
{
$this->analyse([__DIR__ . '/data/method-signature-variance.php'], [
[
'Template type T is declared as covariant, but occurs in contravariant position in parameter a of method MethodSignatureVariance\C::a().',
25,
'Variance annotation is only allowed for type parameters of classes and interfaces, but occurs in template type U in in method MethodSignatureVariance\C::b().',
16,
],
[
'Variance annotation is only allowed for type parameters of classes and interfaces, but occurs in template type U in in method MethodSignatureVariance\C::c().',
22,
],
]);

$this->analyse([__DIR__ . '/data/method-signature-variance-invariant.php'], []);

$this->analyse([__DIR__ . '/data/method-signature-variance-covariant.php'], [
[
'Template type T is declared as covariant, but occurs in invariant position in parameter b of method MethodSignatureVariance\C::a().',
25,
'Template type X is declared as covariant, but occurs in contravariant position in parameter a of method MethodSignatureVariance\Covariant\C::a().',
35,
],
[
'Template type T is declared as covariant, but occurs in contravariant position in parameter c of method MethodSignatureVariance\C::a().',
25,
'Template type X is declared as covariant, but occurs in contravariant position in parameter c of method MethodSignatureVariance\Covariant\C::a().',
35,
],
[
'Template type W is declared as covariant, but occurs in contravariant position in parameter d of method MethodSignatureVariance\C::a().',
25,
'Template type X is declared as covariant, but occurs in invariant position in parameter e of method MethodSignatureVariance\Covariant\C::a().',
35,
],
[
'Variance annotation is only allowed for type parameters of classes and interfaces, but occurs in template type U in in method MethodSignatureVariance\C::b().',
'Template type X is declared as covariant, but occurs in contravariant position in parameter f of method MethodSignatureVariance\Covariant\C::a().',
35,
],
[
'Template type X is declared as covariant, but occurs in contravariant position in parameter h of method MethodSignatureVariance\Covariant\C::a().',
35,
],
[
'Template type X is declared as covariant, but occurs in invariant position in parameter i of method MethodSignatureVariance\Covariant\C::a().',
35,
],
[
'Template type X is declared as covariant, but occurs in invariant position in parameter j of method MethodSignatureVariance\Covariant\C::a().',
35,
],
[
'Template type X is declared as covariant, but occurs in contravariant position in parameter k of method MethodSignatureVariance\Covariant\C::a().',
35,
],
[
'Template type X is declared as covariant, but occurs in contravariant position in return type of method MethodSignatureVariance\Covariant\C::c().',
41,
],
[
'Template type X is declared as covariant, but occurs in contravariant position in return type of method MethodSignatureVariance\Covariant\C::e().',
47,
],
[
'Template type X is declared as covariant, but occurs in invariant position in return type of method MethodSignatureVariance\Covariant\C::f().',
50,
],
[
'Template type X is declared as covariant, but occurs in contravariant position in return type of method MethodSignatureVariance\Covariant\C::h().',
56,
],
[
'Template type X is declared as covariant, but occurs in invariant position in return type of method MethodSignatureVariance\Covariant\C::j().',
62,
],
[
'Template type X is declared as covariant, but occurs in invariant position in return type of method MethodSignatureVariance\Covariant\C::k().',
65,
],
[
'Template type X is declared as covariant, but occurs in contravariant position in return type of method MethodSignatureVariance\Covariant\C::l().',
68,
],
]);

$this->analyse([__DIR__ . '/data/method-signature-variance-contravariant.php'], [
[
'Template type X is declared as contravariant, but occurs in covariant position in parameter b of method MethodSignatureVariance\Contravariant\C::a().',
35,
],
[
'Template type X is declared as contravariant, but occurs in covariant position in parameter d of method MethodSignatureVariance\Contravariant\C::a().',
35,
],
[
'Template type X is declared as contravariant, but occurs in invariant position in parameter e of method MethodSignatureVariance\Contravariant\C::a().',
35,
],
[
'Template type X is declared as contravariant, but occurs in covariant position in parameter g of method MethodSignatureVariance\Contravariant\C::a().',
35,
],
[
'Template type X is declared as contravariant, but occurs in invariant position in parameter i of method MethodSignatureVariance\Contravariant\C::a().',
35,
],
[
'Template type X is declared as contravariant, but occurs in invariant position in parameter j of method MethodSignatureVariance\Contravariant\C::a().',
35,
],
[
'Template type X is declared as contravariant, but occurs in covariant position in parameter l of method MethodSignatureVariance\Contravariant\C::a().',
35,
],
[
'Template type X is declared as contravariant, but occurs in covariant position in return type of method MethodSignatureVariance\Contravariant\C::b().',
38,
],
[
'Template type X is declared as contravariant, but occurs in covariant position in return type of method MethodSignatureVariance\Contravariant\C::d().',
44,
],
[
'Template type X is declared as contravariant, but occurs in invariant position in return type of method MethodSignatureVariance\Contravariant\C::f().',
50,
],
[
'Template type X is declared as contravariant, but occurs in covariant position in return type of method MethodSignatureVariance\Contravariant\C::g().',
53,
],
[
'Template type X is declared as contravariant, but occurs in covariant position in return type of method MethodSignatureVariance\Contravariant\C::i().',
59,
],
[
'Template type X is declared as contravariant, but occurs in invariant position in return type of method MethodSignatureVariance\Contravariant\C::j().',
62,
],
[
'Template type X is declared as contravariant, but occurs in invariant position in return type of method MethodSignatureVariance\Contravariant\C::k().',
65,
],
[
'Template type X is declared as contravariant, but occurs in covariant position in return type of method MethodSignatureVariance\Contravariant\C::m().',
71,
],
]);
}

Expand Down
@@ -0,0 +1,72 @@
<?php

namespace MethodSignatureVariance\Contravariant;

/** @template-contravariant T */
interface In {
}

/** @template-covariant T */
interface Out {
}

/** @template T */
interface Invariant {
}

/**
* @template-contravariant X
*/
class C {
/**
* @param X $a
* @param In<X> $b
* @param In<In<X>> $c
* @param In<Out<X>> $d
* @param In<Invariant<X>> $e
* @param Out<X> $f
* @param Out<In<X>> $g
* @param Out<Out<X>> $h
* @param Out<Invariant<X>> $i
* @param Invariant<X> $j
* @param Invariant<In<X>> $k
* @param Invariant<Out<X>> $l
*/
function a($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k, $l) {}

/** @return X */
function b() {}

/** @return In<X> */
function c() {}

/** @return In<In<X>> */
function d() {}

/** @return In<Out<X>> */
function e() {}

/** @return In<Invariant<X>> */
function f() {}

/** @return Out<X> */
function g() {}

/** @return Out<In<X>> */
function h() {}

/** @return Out<Out<X>> */
function i() {}

/** @return Out<Invariant<X>> */
function j() {}

/** @return Invariant<X> */
function k() {}

/** @return Invariant<In<X>> */
function l() {}

/** @return Invariant<Out<X>> */
function m() {}
}
@@ -0,0 +1,72 @@
<?php

namespace MethodSignatureVariance\Covariant;

/** @template-contravariant T */
interface In {
}

/** @template-covariant T */
interface Out {
}

/** @template T */
interface Invariant {
}

/**
* @template-covariant X
*/
class C {
/**
* @param X $a
* @param In<X> $b
* @param In<In<X>> $c
* @param In<Out<X>> $d
* @param In<Invariant<X>> $e
* @param Out<X> $f
* @param Out<In<X>> $g
* @param Out<Out<X>> $h
* @param Out<Invariant<X>> $i
* @param Invariant<X> $j
* @param Invariant<In<X>> $k
* @param Invariant<Out<X>> $l
*/
function a($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k, $l) {}

/** @return X */
function b() {}

/** @return In<X> */
function c() {}

/** @return In<In<X>> */
function d() {}

/** @return In<Out<X>> */
function e() {}

/** @return In<Invariant<X>> */
function f() {}

/** @return Out<X> */
function g() {}

/** @return Out<In<X>> */
function h() {}

/** @return Out<Out<X>> */
function i() {}

/** @return Out<Invariant<X>> */
function j() {}

/** @return Invariant<X> */
function k() {}

/** @return Invariant<In<X>> */
function l() {}

/** @return Invariant<Out<X>> */
function m() {}
}
@@ -0,0 +1,70 @@
<?php

namespace MethodSignatureVariance\Invariant;

/** @template-contravariant T */
interface In {
}

/** @template-covariant T */
interface Out {
}

/** @template T */
interface Invariant {
}

/**
* @template X
*/
class C {
/**
* @param X $a
* @param In<X> $b
* @param In<In<X>> $c
* @param In<Out<X>> $d
* @param In<Invariant<X> $e
* @param Out<X> $f
* @param Out<In<X>> $g
* @param Out<Out<X>> $h
* @param Out<Invariant<X> $i
* @param Invariant<X> $j
* @param Invariant<In<X>> $k
* @param Invariant<Out<X>> $l
* @return X
*/
function a($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k, $l) {}

/** @return In<X> */
function b() {}

/** @return In<In<X>>*/
function c() {}

/** @return In<Out<X>>*/
function d() {}

/** @return In<Invariant<X> */
function e() {}

/** @return Out<X> */
function f() {}

/** @return Out<In<X>>*/
function g() {}

/** @return Out<Out<X>>*/
function h() {}

/** @return Out<Invariant<X> */
function i() {}

/** @return Invariant<X> */
function j() {}

/** @return Invariant<In<X>>*/
function k() {}

/** @return Invariant<Out<X>>*/
function l() {}
}