collect extends also for interfaces

micheleorselli · micheleorselli · commit a193b3d9e9ec · 2025-03-14T23:14:18.000+01:00
diff --git a/src/Analyzer/ClassDescription.php b/src/Analyzer/ClassDescription.php
@@ -6,54 +6,47 @@
 
 class ClassDescription
 {
-    /** @var FullyQualifiedClassName */
-    private $FQCN;
+    private FullyQualifiedClassName $FQCN;
 
     /** @var list<ClassDependency> */
-    private $dependencies;
+    private array $dependencies;
 
     /** @var list<FullyQualifiedClassName> */
-    private $interfaces;
+    private array $interfaces;
 
-    /** @var ?FullyQualifiedClassName */
-    private $extends;
+    /** @var list<FullyQualifiedClassName> */
+    private array $extends;
 
-    /** @var bool */
-    private $final;
+    /** @var list<string> */
+    private array $docBlock;
 
-    /** @var bool */
-    private $readonly;
+    /** @var list<FullyQualifiedClassName> */
+    private array $attributes;
 
-    /** @var bool */
-    private $abstract;
+    private bool $final;
 
-    /** @var bool */
-    private $interface;
+    private bool $readonly;
 
-    /** @var bool */
-    private $trait;
+    private bool $abstract;
 
-    /** @var bool */
-    private $enum;
+    private bool $interface;
 
-    /** @var list<string> */
-    private $docBlock;
+    private bool $trait;
 
-    /** @var list<FullyQualifiedClassName> */
-    private $attributes;
+    private bool $enum;
 
     /**
      * @param list<ClassDependency>         $dependencies
      * @param list<FullyQualifiedClassName> $interfaces
-     * @param ?FullyQualifiedClassName      $extends
+     * @param list<FullyQualifiedClassName> $extends
      * @param list<FullyQualifiedClassName> $attributes
      * @param list<string>                  $docBlock
      */
     public function __construct(
         FullyQualifiedClassName $FQCN,
         array $dependencies,
         array $interfaces,
-        ?FullyQualifiedClassName $extends,
+        array $extends,
         bool $final,
         bool $readonly,
         bool $abstract,
@@ -127,7 +120,10 @@ public function getInterfaces(): array
         return $this->interfaces;
     }
 
-    public function getExtends(): ?FullyQualifiedClassName
+    /**
+     * @return list<FullyQualifiedClassName>
+     */
+    public function getExtends(): array
     {
         return $this->extends;
     }
diff --git a/src/Analyzer/ClassDescriptionBuilder.php b/src/Analyzer/ClassDescriptionBuilder.php
@@ -8,47 +8,40 @@
 class ClassDescriptionBuilder
 {
     /** @var list<ClassDependency> */
-    private $classDependencies = [];
+    private array $classDependencies = [];
 
-    /** @var ?FullyQualifiedClassName */
-    private $FQCN;
+    private ?FullyQualifiedClassName $FQCN = null;
 
     /** @var list<FullyQualifiedClassName> */
-    private $interfaces = [];
+    private array $interfaces = [];
 
-    /** @var ?FullyQualifiedClassName */
-    private $extend;
+    /** @var list<FullyQualifiedClassName> */
+    private array $extend = [];
 
-    /** @var bool */
-    private $final = false;
+    private bool $final = false;
 
-    /** @var bool */
-    private $readonly = false;
+    private bool $readonly = false;
 
-    /** @var bool */
-    private $abstract = false;
+    private bool $abstract = false;
 
     /** @var list<string> */
-    private $docBlock = [];
+    private array $docBlock = [];
 
     /** @var list<FullyQualifiedClassName> */
-    private $attributes = [];
+    private array $attributes = [];
 
-    /** @var bool */
-    private $interface = false;
+    private bool $interface = false;
 
-    /** @var bool */
-    private $trait = false;
+    private bool $trait = false;
 
-    /** @var bool */
-    private $enum = false;
+    private bool $enum = false;
 
     public function clear(): void
     {
         $this->FQCN = null;
         $this->classDependencies = [];
         $this->interfaces = [];
-        $this->extend = null;
+        $this->extend = [];
         $this->final = false;
         $this->readonly = false;
         $this->abstract = false;
@@ -81,10 +74,10 @@ public function addDependency(ClassDependency $cd): self
         return $this;
     }
 
-    public function setExtends(string $FQCN, int $line): self
+    public function addExtends(string $FQCN, int $line): self
     {
         $this->addDependency(new ClassDependency($FQCN, $line));
-        $this->extend = FullyQualifiedClassName::fromString($FQCN);
+        $this->extend[] = FullyQualifiedClassName::fromString($FQCN);
 
         return $this;
     }
diff --git a/src/Analyzer/FileVisitor.php b/src/Analyzer/FileVisitor.php
@@ -35,7 +35,7 @@ public function enterNode(Node $node): void
 
             if (!$node->isAnonymous() && null !== $node->extends) {
                 $this->classDescriptionBuilder
-                    ->setExtends($node->extends->toString(), $node->getLine());
+                    ->addExtends($node->extends->toString(), $node->getLine());
             }
 
             if ($node->isFinal()) {
@@ -182,6 +182,11 @@ public function enterNode(Node $node): void
 
             $this->classDescriptionBuilder->setClassName($node->namespacedName->toCodeString());
             $this->classDescriptionBuilder->setInterface(true);
+
+            foreach ($node->extends as $interface) {
+                $this->classDescriptionBuilder
+                    ->addExtends($interface->toString(), $interface->getLine());
+            }
         }
 
         if ($node instanceof Node\Stmt\Trait_) {
diff --git a/src/Expression/ForClasses/Extend.php b/src/Expression/ForClasses/Extend.php
@@ -14,7 +14,7 @@
 class Extend implements Expression
 {
     /** @var string[] */
-    private $classNames;
+    private array $classNames;
 
     public function __construct(string ...$classNames)
     {
@@ -34,8 +34,10 @@ public function evaluate(ClassDescription $theClass, Violations $violations, str
 
         /** @var string $className */
         foreach ($this->classNames as $className) {
-            if (null !== $extends && $extends->matches($className)) {
-                return;
+            foreach ($extends as $extend) {
+                if ($extend->matches($className)) {
+                    return;
+                }
             }
         }
 
diff --git a/src/Expression/ForClasses/NotExtend.php b/src/Expression/ForClasses/NotExtend.php
@@ -14,7 +14,7 @@
 class NotExtend implements Expression
 {
     /** @var string[] */
-    private $classNames;
+    private array $classNames;
 
     public function __construct(string ...$classNames)
     {
@@ -34,15 +34,15 @@ public function evaluate(ClassDescription $theClass, Violations $violations, str
 
         /** @var string $className */
         foreach ($this->classNames as $className) {
-            if (null !== $extends && $extends->matches($className)) {
-                $violation = Violation::create(
-                    $theClass->getFQCN(),
-                    ViolationMessage::selfExplanatory($this->describe($theClass, $because))
-                );
-
-                $violations->add($violation);
-
-                return;
+            foreach ($extends as $extend) {
+                if ($extend->matches($className)) {
+                    $violation = Violation::create(
+                        $theClass->getFQCN(),
+                        ViolationMessage::selfExplanatory($this->describe($theClass, $because))
+                    );
+
+                    $violations->add($violation);
+                }
             }
         }
     }
diff --git a/tests/Unit/Analyzer/FileVisitorTest.php b/tests/Unit/Analyzer/FileVisitorTest.php
@@ -106,27 +106,27 @@ class Cat implements AnInterface
     public function test_it_should_parse_extends_class(): void
     {
         $code = <<< 'EOF'
-<?php
+        <?php
 
-namespace Root\Animals;
+        namespace Root\Animals;
 
-class Animal
-{
-}
+        class Animal
+        {
+        }
 
-class Cat extends Animal
-{
+        class Cat extends Animal
+        {
 
-}
-EOF;
+        }
+        EOF;
 
         /** @var FileParser $fp */
         $fp = FileParserFactory::createFileParser(TargetPhpVersion::create('7.4'));
         $fp->parse($code, 'relativePathName');
 
         $cd = $fp->getClassDescriptions()[1];
 
-        $this->assertEquals('Root\Animals\Animal', $cd->getExtends()->toString());
+        $this->assertEquals('Root\Animals\Animal', $cd->getExtends()[0]->toString());
     }
 
     public function test_it_should_not_parse_extends_from_insider_anonymousclass(): void
@@ -155,7 +155,7 @@ public function methodWithAnonymous(): void
 
         $cd = $fp->getClassDescriptions()[1];
 
-        $this->assertEquals('Root\Animals\Animal', $cd->getExtends()->toString());
+        $this->assertEquals('Root\Animals\Animal', $cd->getExtends()[0]->toString());
     }
 
     public function test_should_depends_on_these_namespaces(): void
@@ -882,6 +882,40 @@ public function getBookList(): QueryBuilder;
         $this->assertCount(1, $violations);
     }
 
+    public function test_it_parse_interface_extends(): void
+    {
+        $code = <<< 'EOF'
+        <?php
+        namespace MyProject\AppBundle\Application;
+
+        interface FooAble
+        {
+            public function foo();
+        }
+            +
+        interface BarAble
+        {
+            public function bar();
+        }
+
+
+        interface ForBarAble extends FooAble, BarAble
+        {
+            public function foobar();
+        }
+        EOF;
+
+        /** @var FileParser $fp */
+        $fp = FileParserFactory::createFileParser(TargetPhpVersion::create('8.1'));
+        $fp->parse($code, 'relativePathName');
+
+        $cd = $fp->getClassDescriptions();
+
+        $this->assertCount(3, $cd);
+        $this->assertEquals('MyProject\AppBundle\Application\FooAble', $cd[2]->getExtends()[0]->toString());
+        $this->assertEquals('MyProject\AppBundle\Application\BarAble', $cd[2]->getExtends()[1]->toString());
+    }
+
     public function test_it_handles_return_types(): void
     {
         $code = <<< 'EOF'
diff --git a/tests/Unit/Expressions/ForClasses/ExtendTest.php b/tests/Unit/Expressions/ForClasses/ExtendTest.php
@@ -17,7 +17,7 @@ public function test_it_should_return_no_violation_on_success(): void
 
         $classDescription = (new ClassDescriptionBuilder())
             ->setClassName('My\Class')
-            ->setExtends('My\BaseClass', 10)
+            ->addExtends('My\BaseClass', 10)
             ->build();
 
         $violations = new Violations();
@@ -32,7 +32,7 @@ public function test_it_should_work_with_wildcards(): void
 
         $classDescription = (new ClassDescriptionBuilder())
             ->setClassName('My\Class')
-            ->setExtends('My\B14Class', 10)
+            ->addExtends('My\B14Class', 10)
             ->build();
 
         $violations = new Violations();
@@ -47,7 +47,7 @@ public function test_it_should_return_violation_error_when_argument_is_a_regex()
 
         $classDescription = (new ClassDescriptionBuilder())
             ->setClassName('My\Class')
-            ->setExtends('My\BaseClass', 10)
+            ->addExtends('My\BaseClass', 10)
             ->build();
 
         $violations = new Violations();
@@ -61,7 +61,7 @@ public function test_it_should_return_violation_error_when_class_not_extend(): v
 
         $classDescription = (new ClassDescriptionBuilder())
             ->setClassName('HappyIsland')
-            ->setExtends('My\AnotherClass', 10)
+            ->addExtends('My\AnotherClass', 10)
             ->build();
 
         $violations = new Violations();
@@ -95,7 +95,7 @@ public function test_it_should_accept_multiple_extends(): void
 
         $classDescription = (new ClassDescriptionBuilder())
             ->setClassName('My\Class')
-            ->setExtends('My\SecondExtend', 10)
+            ->addExtends('My\SecondExtend', 10)
             ->build();
 
         $violations = new Violations();
diff --git a/tests/Unit/Expressions/ForClasses/NotExtendTest.php b/tests/Unit/Expressions/ForClasses/NotExtendTest.php
@@ -17,7 +17,7 @@ public function test_it_should_return_violation_error(): void
 
         $classDescription = (new ClassDescriptionBuilder())
             ->setClassName('HappyIsland')
-            ->setExtends('My\BaseClass', 1)
+            ->addExtends('My\BaseClass', 1)
             ->build();
 
         $because = 'we want to add this rule for our software';
@@ -36,7 +36,7 @@ public function test_it_should_not_return_violation_error_if_extends_another_cla
 
         $classDescription = (new ClassDescriptionBuilder())
             ->setClassName('HappyIsland')
-            ->setExtends('My\AnotherClass', 1)
+            ->addExtends('My\AnotherClass', 1)
             ->build();
 
         $because = 'we want to add this rule for our software';
@@ -53,7 +53,7 @@ public function test_it_should_return_violation_error_for_multiple_extends(): vo
 
         $classDescription = (new ClassDescriptionBuilder())
             ->setClassName('HappyIsland')
-            ->setExtends('My\SecondExtend', 1)
+            ->addExtends('My\SecondExtend', 1)
             ->build();
 
         $because = 'we want to add this rule for our software';
diff --git a/tests/Unit/Expressions/ForClasses/NotImplementTest.php b/tests/Unit/Expressions/ForClasses/NotImplementTest.php

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`class Extend implements Expression`
`15`	`15`	`{`
`16`	`16`	`/** @var string[] */`
`17`		`- private $classNames;`
	`17`	`+ private array $classNames;`
`18`	`18`
`19`	`19`	`public function __construct(string ...$classNames)`
`20`	`20`	`{`
`@@ -34,8 +34,10 @@ public function evaluate(ClassDescription $theClass, Violations $violations, str`
`34`	`34`
`35`	`35`	`/** @var string $className */`
`36`	`36`	`foreach ($this->classNames as $className) {`
`37`		`- if (null !== $extends && $extends->matches($className)) {`
`38`		`- return;`
	`37`	`+ foreach ($extends as $extend) {`
	`38`	`+ if ($extend->matches($className)) {`
	`39`	`+ return;`
	`40`	`+ }`
`39`	`41`	`}`
`40`	`42`	`}`
`41`	`43`