Merge pull request #885 from dbrumann/attribute_collector

Add new Attribute-Collector

config/services.php

@@ -48,6 +48,7 @@
 use Qossmic\Deptrac\File\YmlFileLoader;
 use Qossmic\Deptrac\InputCollector\FileInputCollector;
 use Qossmic\Deptrac\InputCollector\InputCollectorInterface;
+use Qossmic\Deptrac\Layer\Collector\AttributeCollector;
 use Qossmic\Deptrac\Layer\Collector\BoolCollector;
 use Qossmic\Deptrac\Layer\Collector\ClassCollector;
 use Qossmic\Deptrac\Layer\Collector\ClassLikeCollector;
@@ -198,6 +199,9 @@
         ]);
     $services->set(CollectorResolver::class);
     $services->alias(CollectorResolverInterface::class, CollectorResolver::class);
+    $services
+        ->set(AttributeCollector::class)
+        ->tag('collector', ['type' => CollectorTypes::TYPE_ATTRIBUTE]);
     $services
         ->set(BoolCollector::class)
         ->tag('collector', ['type' => CollectorTypes::TYPE_BOOL]);

docs/collectors.md

@@ -3,6 +3,21 @@
 Collectors decide if a node (typically a class) is part of a layer. You can use
 multiple different collectors for a layer.
 
+## `attribute` Collector
+
+The `attribute` collector finds all class-likes, functions or files using the
+provided attribute. You can provide the full attribute name or a substring that
+should be matched.
+
+```yaml
+parameters:
+  layers:
+    - name: Entities
+      collectors:
+        - type: attribute
+          value: Doctrine\ORM\Mapping\Entity
+```
+
 ## `bool` Collector
 
 The `bool` collector allows combining other collectors with or without negation.

src/Layer/Collector/AttributeCollector.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Qossmic\Deptrac\Layer\Collector;
+
+use LogicException;
+use Qossmic\Deptrac\Ast\AstMap\AstMap;
+use Qossmic\Deptrac\Ast\AstMap\ClassLike\ClassLikeReference;
+use Qossmic\Deptrac\Ast\AstMap\DependencyToken;
+use Qossmic\Deptrac\Ast\AstMap\File\FileReference;
+use Qossmic\Deptrac\Ast\AstMap\FunctionLike\FunctionLikeReference;
+use Qossmic\Deptrac\Ast\AstMap\TokenReferenceInterface;
+
+class AttributeCollector implements CollectorInterface
+{
+    public function satisfy(array $config, TokenReferenceInterface $reference, AstMap $astMap): bool
+    {
+        if (!$reference instanceof FileReference
+            && !$reference instanceof ClassLikeReference
+            && !$reference instanceof FunctionLikeReference
+        ) {
+            return false;
+        }
+
+        $match = $this->getSearchedSubstring($config);
+
+        foreach ($reference->getDependencies() as $dependency) {
+            if (DependencyToken::ATTRIBUTE !== $dependency->getType()) {
+                continue;
+            }
+
+            $usedAttribute = $dependency->getToken()->toString();
+
+            if (str_contains($usedAttribute, $match)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @param array<string, string|array<string, string>> $config
+     */
+    private function getSearchedSubstring(array $config): string
+    {
+        if (!isset($config['value']) || !is_string($config['value'])) {
+            throw new LogicException('AttributeCollector needs the attribute name as a string.');
+        }
+
+        return $config['value'];
+    }
+}

src/Layer/Collector/CollectorTypes.php

@@ -6,6 +6,7 @@
 
 final class CollectorTypes
 {
+    public const TYPE_ATTRIBUTE = 'attribute';
     public const TYPE_BOOL = 'bool';
     public const TYPE_CLASS = 'class';
     public const TYPE_CLASSLIKE = 'classLike';

src/Layer/Collector/UsesCollector.php

@@ -18,10 +18,10 @@ public function satisfy(array $config, TokenReferenceInterface $reference, AstMa
             return false;
         }
 
-        $interfaceName = $this->getInterfaceName($config);
+        $traitName = $this->getTraitName($config);
 
         foreach ($astMap->getClassInherits($reference->getToken()) as $inherit) {
-            if ($inherit->isUses() && $inherit->getClassLikeName()->equals($interfaceName)) {
+            if ($inherit->isUses() && $inherit->getClassLikeName()->equals($traitName)) {
                 return true;
             }
         }
@@ -32,7 +32,7 @@ public function satisfy(array $config, TokenReferenceInterface $reference, AstMa
     /**
      * @param array<string, string|array<string, string>> $config
      */
-    private function getInterfaceName(array $config): ClassLikeToken
+    private function getTraitName(array $config): ClassLikeToken
     {
         if (isset($config['uses']) && !isset($config['value'])) {
             trigger_deprecation('qossmic/deptrac', '0.20.0', 'UsesCollector should use the "value" key from this version');

tests/Layer/Collector/AttributeCollectorTest.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Qossmic\Deptrac\Layer\Collector;
+
+use PHPUnit\Framework\TestCase;
+use Qossmic\Deptrac\Ast\AstMap\AstMap;
+use Qossmic\Deptrac\Ast\AstMap\File\FileReferenceBuilder;
+use Qossmic\Deptrac\Layer\Collector\AttributeCollector;
+
+final class AttributeCollectorTest extends TestCase
+{
+    private AttributeCollector $collector;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->collector = new AttributeCollector();
+    }
+
+    public function dataProviderSatisfy(): iterable
+    {
+        yield 'matches usage of attribute with only partial name' => [
+            ['value' => 'MyAttribute'],
+            true,
+        ];
+        yield 'does not match unescaped fully qualified class name' => [
+            ['value' => 'App\MyAttribute'],
+            true,
+        ];
+        yield 'does not match other attributes' => [
+            ['value' => 'OtherAttribute'],
+            false,
+        ];
+    }
+
+    /**
+     * @dataProvider dataProviderSatisfy
+     */
+    public function testSatisfy(array $config, bool $expected): void
+    {
+        $classLikeReference = FileReferenceBuilder::create('Foo.php')
+            ->newClass('App\Foo')
+            ->attribute('App\MyAttribute', 2)
+            ->attribute('MyAttribute', 3)
+            ->build();
+        $actual = $this->collector->satisfy($config, $classLikeReference, new AstMap([]));
+
+        self::assertSame($expected, $actual);
+    }
+}