parsing interfaces and return type (#335)

Author: AlessandroMinoccheri

src/Analyzer/ClassDescription.php

@@ -26,6 +26,9 @@ class ClassDescription
     /** @var bool */
     private $abstract;
 
+    /** @var bool */
+    private $interface;
+
     /** @var list<string> */
     private $docBlock;
 
@@ -45,6 +48,7 @@ public function __construct(
         ?FullyQualifiedClassName $extends,
         bool $final,
         bool $abstract,
+        bool $interface,
         array $docBlock = [],
         array $attributes = []
     ) {
@@ -57,6 +61,7 @@ public function __construct(
         $this->fullPath = '';
         $this->docBlock = $docBlock;
         $this->attributes = $attributes;
+        $this->interface = $interface;
     }
 
     public function setFullPath(string $fullPath): void
@@ -166,6 +171,11 @@ public function isAbstract(): bool
         return $this->abstract;
     }
 
+    public function isInterface(): bool
+    {
+        return $this->interface;
+    }
+
     public function getDocBlock(): array
     {
         return $this->docBlock;

src/Analyzer/ClassDescriptionBuilder.php

@@ -34,6 +34,9 @@ class ClassDescriptionBuilder
     /** @var list<FullyQualifiedClassName> */
     private $attributes;
 
+    /** @var bool */
+    private $interface;
+
     /**
      * @param list<ClassDependency>         $classDependencies
      * @param list<FullyQualifiedClassName> $interfaces
@@ -47,6 +50,7 @@ private function __construct(
         array $interfaces,
         bool $final,
         bool $abstract,
+        bool $interface,
         array $docBlock = [],
         array $attributes = []
     ) {
@@ -58,6 +62,7 @@ private function __construct(
         $this->abstract = $abstract;
         $this->docBlock = $docBlock;
         $this->attributes = $attributes;
+        $this->interface = $interface;
     }
 
     public static function create(): self
@@ -69,6 +74,7 @@ public static function create(): self
             [],
             false,
             false,
+            false,
             [],
             []
         );
@@ -89,6 +95,7 @@ public function clear(): void
         $this->abstract = false;
         $this->docBlock = [];
         $this->attributes = [];
+        $this->interface = false;
     }
 
     public function setFilePath(string $filePath): self
@@ -132,6 +139,7 @@ public function get(): ClassDescription
             $this->extend,
             $this->final,
             $this->abstract,
+            $this->interface,
             $this->docBlock,
             $this->attributes
         );
@@ -154,6 +162,13 @@ public function setAbstract(bool $abstract): self
         return $this;
     }
 
+    public function setInterface(bool $interface): self
+    {
+        $this->interface = $interface;
+
+        return $this;
+    }
+
     public function addDocBlock(string $docBlock): self
     {
         $this->docBlock[] = $docBlock;

src/Analyzer/FileVisitor.php

@@ -166,6 +166,30 @@ public function enterNode(Node $node): void
         if ($node instanceof Node\Param) {
             $this->addParamDependency($node);
         }
+
+        if ($node instanceof Node\Stmt\Interface_) {
+            if (null === $node->namespacedName) {
+                return;
+            }
+
+            $this->classDescriptionBuilder->setClassName($node->namespacedName->toCodeString());
+            $this->classDescriptionBuilder->setInterface(true);
+
+            foreach ($node->attrGroups as $attributeGroup) {
+                foreach ($attributeGroup->attrs as $attribute) {
+                    $this->classDescriptionBuilder
+                        ->addAttribute($attribute->name->toString(), $attribute->getLine());
+                }
+            }
+        }
+
+        if ($node instanceof Node\Stmt\ClassMethod) {
+            $returnType = $node->returnType;
+            if ($returnType instanceof Node\Name\FullyQualified) {
+                $this->classDescriptionBuilder
+                  ->addDependency(new ClassDependency($returnType->toCodeString(), $returnType->getLine()));
+            }
+        }
     }
 
     public function getClassDescriptions(): array
@@ -189,6 +213,11 @@ public function leaveNode(Node $node): void
             $this->classDescriptions[] = $this->classDescriptionBuilder->get();
             $this->classDescriptionBuilder->clear();
         }
+
+        if ($node instanceof Node\Stmt\Interface_) {
+            $this->classDescriptions[] = $this->classDescriptionBuilder->get();
+            $this->classDescriptionBuilder->clear();
+        }
     }
 
     private function isSelfOrStaticOrParent(string $dependencyClass): bool

src/Expression/ForClasses/Implement.php

@@ -29,6 +29,10 @@ public function describe(ClassDescription $theClass, string $because): Descripti
 
     public function evaluate(ClassDescription $theClass, Violations $violations, string $because): void
     {
+        if ($theClass->isInterface()) {
+            return;
+        }
+
         $interface = $this->interface;
         $interfaces = $theClass->getInterfaces();
         $implements = function (FullyQualifiedClassName $FQCN) use ($interface): bool {

src/Expression/ForClasses/NotImplement.php

@@ -29,6 +29,10 @@ public function describe(ClassDescription $theClass, string $because): Descripti
 
     public function evaluate(ClassDescription $theClass, Violations $violations, string $because): void
     {
+        if ($theClass->isInterface()) {
+            return;
+        }
+
         $interface = $this->interface;
         $interfaces = $theClass->getInterfaces();
         $implements = function (FullyQualifiedClassName $FQCN) use ($interface): bool {

tests/E2E/Cli/DebugExpressionCommandTest.php

@@ -70,6 +70,7 @@ public function test_parse_error_dont_stop_execution(): void
         $appTester = $this->createAppTester();
         $appTester->run(['debug:expression', 'expression' => 'NotExtend', 'arguments' => ['NotFound'], '--from-dir' => __DIR__.'/../_fixtures/parse_error']);
         $errorMessage = <<<END
+ContainerAwareInterface
 WARNING: Some files could not be parsed for these errors:
  - Syntax error, unexpected T_STRING, expecting '{' on line 8: Services/CartService.php
 

tests/Unit/Analyzer/ClassDescriptionBuilderTest.php

@@ -133,4 +133,32 @@ public function test_it_should_set_file_path(): void
         $classDescription = $classDescriptionBuilder->get();
         $this->assertEquals($filePath, $classDescription->fullPath());
     }
+
+    public function test_it_should_create_interface(): void
+    {
+        $FQCN = 'HappyIsland';
+        $classDescriptionBuilder = ClassDescriptionBuilder::create();
+        $classDescriptionBuilder->setClassName($FQCN);
+        $classDescriptionBuilder->setInterface(true);
+
+        $classDescription = $classDescriptionBuilder->get();
+
+        $this->assertInstanceOf(ClassDescription::class, $classDescription);
+
+        $this->assertTrue($classDescription->isInterface());
+    }
+
+    public function test_it_should_create_not_interface(): void
+    {
+        $FQCN = 'HappyIsland';
+        $classDescriptionBuilder = ClassDescriptionBuilder::create();
+        $classDescriptionBuilder->setClassName($FQCN);
+        $classDescriptionBuilder->setInterface(false);
+
+        $classDescription = $classDescriptionBuilder->get();
+
+        $this->assertInstanceOf(ClassDescription::class, $classDescription);
+
+        $this->assertFalse($classDescription->isInterface());
+    }
 }

tests/Unit/Analyzer/FileVisitorTest.php

@@ -669,8 +669,8 @@ class test implements Order
 
         $violations = new Violations();
 
-        $notHaveDependencyOutsideNamespace = new Implement('Foo\Order');
-        $notHaveDependencyOutsideNamespace->evaluate($cd[0], $violations, 'we want to add this rule for our software');
+        $implement = new Implement('Foo\Order');
+        $implement->evaluate($cd[0], $violations, 'we want to add this rule for our software');
 
         $this->assertCount(0, $violations, $violations->toString());
     }
@@ -704,4 +704,30 @@ class ApplicationLevelDto
 
         $this->assertCount(1, $violations);
     }
+
+    public function test_it_parse_interfaces(): void
+    {
+        $code = <<< 'EOF'
+<?php
+namespace MyProject\AppBundle\Application;
+use Doctrine\ORM\QueryBuilder;
+interface BookRepositoryInterface
+{
+    public function getBookList(): QueryBuilder;
+}
+EOF;
+
+        /** @var FileParser $fp */
+        $fp = FileParserFactory::createFileParser(TargetPhpVersion::create('8.1'));
+        $fp->parse($code, 'relativePathName');
+
+        $cd = $fp->getClassDescriptions();
+
+        $violations = new Violations();
+
+        $dependsOnTheseNamespaces = new DependsOnlyOnTheseNamespaces('MyProject\AppBundle\Application');
+        $dependsOnTheseNamespaces->evaluate($cd[0], $violations, 'we want to add this rule for our software');
+
+        $this->assertCount(1, $violations);
+    }
 }

tests/Unit/Expressions/ForClasses/ContainDocBlockLikeTest.php

@@ -23,6 +23,7 @@ public function test_it_should_return_true_if_contains_doc_block(): void
             null,
             false,
             false,
+            false,
             ['/**  */myDocBlock with other information']
         );
         $because = 'we want to add this rule for our software';
@@ -47,6 +48,7 @@ public function test_it_should_return_true_if_contains_doc_block_without_because
             null,
             false,
             false,
+            false,
             ['/**  */myDocBlock with other information']
         );
         $violations = new Violations();
@@ -70,6 +72,7 @@ public function test_it_should_return_false_if_not_contains_doc_block(): void
             null,
             false,
             false,
+            false,
             ['/**  */myDocBlock with other information']
         );
         $because = 'we want to add this rule for our software';

tests/Unit/Expressions/ForClasses/ExtendTest.php

@@ -22,6 +22,7 @@ public function test_it_should_return_violation_error(): void
             [],
             FullyQualifiedClassName::fromString('My\AnotherClass'),
             false,
+            false,
             false
         );
 
@@ -45,6 +46,7 @@ public function test_it_should_return_violation_error_if_extend_is_null(): void
             [],
             null,
             false,
+            false,
             false
         );