Skip to content

Commit

Permalink
Merge pull request #10169 from robchett/fix_InheritorViolation
Browse files Browse the repository at this point in the history
  • Loading branch information
@weirdan
weirdan committed Aug 31, 2023
2 parents cc7ed95 + d0c4d17 commit c059997
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 35 deletions.
17 changes: 17 additions & 0 deletions src/Psalm/Internal/Analyzer/ClassAnalyzer.php
View file
Expand Up @@ -36,6 +36,7 @@
use Psalm\Issue\ExtensionRequirementViolation;
use Psalm\Issue\ImplementationRequirementViolation;
use Psalm\Issue\InaccessibleMethod;
use Psalm\Issue\InheritorViolation;
use Psalm\Issue\InternalClass;
use Psalm\Issue\InvalidEnumCaseValue;
use Psalm\Issue\InvalidExtendClass;
Expand Down Expand Up @@ -271,6 +272,22 @@ public function analyze(
);
}

$class_union = new Union([new TNamedObject($fq_class_name)]);
foreach ($storage->parent_classes + $storage->direct_class_interfaces as $parent_class) {
$parent_storage = $codebase->classlikes->getStorageFor($parent_class);
if ($parent_storage && $parent_storage->inheritors) {
if (!UnionTypeComparator::isContainedBy($codebase, $class_union, $parent_storage->inheritors)) {
IssueBuffer::maybeAdd(
new InheritorViolation(
'Class ' . $fq_class_name . ' is not an allowed inheritor of parent class ' . $parent_class,
new CodeLocation($this, $this->class),
),
$this->getSuppressedIssues(),
);
}
}
}


if ($storage->template_types) {
foreach ($storage->template_types as $param_name => $_) {
Expand Down
19 changes: 0 additions & 19 deletions src/Psalm/Internal/Analyzer/ClassLikeAnalyzer.php
View file
Expand Up @@ -14,7 +14,6 @@
use Psalm\Internal\Type\TemplateResult;
use Psalm\Internal\Type\TemplateStandinTypeReplacer;
use Psalm\Issue\InaccessibleProperty;
use Psalm\Issue\InheritorViolation;
use Psalm\Issue\InvalidClass;
use Psalm\Issue\InvalidTemplateParam;
use Psalm\Issue\MissingDependency;
Expand All @@ -29,7 +28,6 @@
use Psalm\StatementsSource;
use Psalm\Storage\ClassLikeStorage;
use Psalm\Type;
use Psalm\Type\Atomic\TNamedObject;
use Psalm\Type\Atomic\TTemplateParam;
use Psalm\Type\Union;
use UnexpectedValueException;
Expand Down Expand Up @@ -332,23 +330,6 @@ public static function checkFullyQualifiedClassLikeName(
return null;
}


$classUnion = new Union([new TNamedObject($fq_class_name)]);
foreach ($class_storage->parent_classes + $class_storage->direct_class_interfaces as $parent_class) {
$parent_storage = $codebase->classlikes->getStorageFor($parent_class);
if ($parent_storage && $parent_storage->inheritors) {
if (!UnionTypeComparator::isContainedBy($codebase, $classUnion, $parent_storage->inheritors)) {
IssueBuffer::maybeAdd(
new InheritorViolation(
'Class ' . $fq_class_name . ' is not an allowed inheritor of parent class ' . $parent_class,
$code_location,
),
$suppressed_issues,
);
}
}
}

foreach ($class_storage->invalid_dependencies as $dependency_class_name => $_) {
// if the implemented/extended class is stubbed, it may not yet have
// been hydrated
Expand Down
21 changes: 21 additions & 0 deletions src/Psalm/Internal/Analyzer/InterfaceAnalyzer.php
View file
Expand Up @@ -11,9 +11,13 @@
use Psalm\Internal\Analyzer\Statements\Expression\ClassConstAnalyzer;
use Psalm\Internal\FileManipulation\FileManipulationBuffer;
use Psalm\Internal\Provider\NodeDataProvider;
use Psalm\Internal\Type\Comparator\UnionTypeComparator;
use Psalm\Issue\InheritorViolation;
use Psalm\Issue\ParseError;
use Psalm\Issue\UndefinedInterface;
use Psalm\IssueBuffer;
use Psalm\Type\Atomic\TNamedObject;
use Psalm\Type\Union;
use UnexpectedValueException;

use function strtolower;
Expand Down Expand Up @@ -109,6 +113,23 @@ public function analyze(): void
}
}

$class_union = new Union([new TNamedObject($fq_interface_name)]);
foreach ($class_storage->direct_interface_parents as $parent_interface) {
$parent_storage = $codebase->classlikes->getStorageFor($parent_interface);
if ($parent_storage && $parent_storage->inheritors) {
if (!UnionTypeComparator::isContainedBy($codebase, $class_union, $parent_storage->inheritors)) {
IssueBuffer::maybeAdd(
new InheritorViolation(
'Interface ' . $fq_interface_name . '
is not an allowed inheritor of parent interface ' . $parent_interface,
new CodeLocation($this, $this->class),
),
$this->getSuppressedIssues(),
);
}
}
}

$fq_interface_name = $this->getFQCLN();

if (!$fq_interface_name) {
Expand Down
40 changes: 24 additions & 16 deletions tests/ClassTest.php
View file
Expand Up @@ -857,7 +857,6 @@ private final function __construct() {}
*/
class BaseClass {}
class FooClass extends BaseClass {}
$a = new FooClass();
PHP,
],
'unionInheritorIsAllowed' => [
Expand All @@ -868,9 +867,7 @@ class FooClass extends BaseClass {}
*/
class BaseClass {}
class FooClass extends BaseClass {}
$a = new FooClass();
class BarClass extends FooClass {}
$b = new BarClass();
PHP,
],
'multiInheritorIsAllowed' => [
Expand All @@ -881,9 +878,7 @@ class BarClass extends FooClass {}
*/
class BaseClass {}
class FooClass extends BaseClass {}
$a = new FooClass();
class BarClass extends FooClass {}
$b = new BarClass();
PHP,
],
'skippedInheritorIsAllowed' => [
Expand All @@ -894,9 +889,7 @@ class BarClass extends FooClass {}
*/
class BaseClass {}
class FooClass extends BaseClass {}
$a = new FooClass();
class BarClass extends FooClass {}
$b = new BarClass();
PHP,
],
'CompositeInheritorIsAllowed' => [
Expand All @@ -908,7 +901,6 @@ class BarClass extends FooClass {}
class BaseClass {}
interface FooInterface {}
class BarClass extends BaseClass implements FooInterface {}
$b = new BarClass();
PHP,
],
'InterfaceInheritorIsAllowed' => [
Expand All @@ -919,12 +911,10 @@ class BarClass extends BaseClass implements FooInterface {}
*/
interface BaseInterface {}
class FooClass implements BaseInterface {}
$a = new FooClass();
class BarClass implements BaseInterface {}
$b = new BarClass();
PHP,
],
'MultiInterfaceInheritorIsAllowed' => [
],
'MultiInterfaceInheritorIsAllowed' => [
'code' => <<<'PHP'
<?php
/**
Expand All @@ -936,7 +926,16 @@ interface InterfaceA {}
*/
interface InterfaceB {}
class FooClass implements InterfaceA, InterfaceB {}
$a = new FooClass();
PHP,
],
'InterfaceOfInterfaceInheritorIsAllowed' => [
'code' => <<<'PHP'
<?php
/**
* @psalm-inheritors InterfaceB
*/
interface InterfaceA {}
interface InterfaceB extends InterfaceA {}
PHP,
],
];
Expand Down Expand Up @@ -1393,7 +1392,6 @@ class Bar extends Foo {}
*/
class BaseClass {}
class BazClass extends BaseClass {} // this is an error
$a = new BazClass();
PHP,
'error_message' => 'InheritorViolation',
'ignored_issues' => [],
Expand All @@ -1406,7 +1404,18 @@ class BazClass extends BaseClass {} // this is an error
*/
interface BaseInterface {}
class BazClass implements BaseInterface {}
$a = new BazClass();
PHP,
'error_message' => 'InheritorViolation',
'ignored_issues' => [],
],
'interfaceCannotImplementIfNotInInheritors' => [
'code' => <<<'PHP'
<?php
/**
* @psalm-inheritors FooClass|BarClass
*/
interface BaseInterface {}
interface BazInterface extends BaseInterface {}
PHP,
'error_message' => 'InheritorViolation',
'ignored_issues' => [],
Expand All @@ -1423,7 +1432,6 @@ interface InterfaceA {}
*/
interface InterfaceB {}
class BazClass implements InterFaceA, InterFaceB {}
$a = new BazClass();
PHP,
'error_message' => 'InheritorViolation',
'ignored_issues' => [],
Expand Down

0 comments on commit c059997

Please sign in to comment.