Add the InheritsAttributes attribute

Author: olvlvl

CHANGELOG.md

@@ -1,5 +1,29 @@
 # CHANGELOG
 
+## v2.0 to v2.1
+
+### New Requirements
+
+None
+
+### New features
+
+- The `InheritsAttributes` attribute can be used on classes that inherit their attributes from traits, properties, or methods, and were previously ignored by the collection process.
+
+### Backward Incompatible Changes
+
+None
+
+### Deprecated Features
+
+None
+
+### Other Changes
+
+- Just like interfaces, traits are excluded from the collection.
+
+
+
 ## v1.2 to v2.0
 
 ### New Requirements

README.md

@@ -271,6 +271,11 @@ You could also use [spatie/file-system-watcher][], it only requires PHP. If the
 for your liking, try running the command with `COMPOSER_ATTRIBUTE_COLLECTOR_USE_CACHE=yes`, it will
 enable caching and speed up consecutive runs.
 
+**How do I include a class that inherits its attributes?**
+
+To speed up the collection process, the plugin first looks at PHP files as plain text for hints of attribute usage. If a
+class inherits its attributes from traits, properties, or methods, it is ignored. Use the attribute
+`[#\olvlvl\ComposerAttributeCollector\InheritsAttributes]` to force the collection.
 
 
 ----------

src/ClassAttributeCollector.php

@@ -7,7 +7,6 @@
 use ReflectionAttribute;
 use ReflectionClass;
 use ReflectionException;
-use Throwable;
 
 /**
  * @internal
@@ -124,6 +123,7 @@ private static function isAttributeIgnored(ReflectionAttribute $attribute): bool
     {
         static $ignored = [
             \ReturnTypeWillChange::class => true,
+            InheritsAttributes::class => true,
         ];
 
         return isset($ignored[$attribute->getName()]);

src/Filter/InterfaceFilter.php renamed to src/Filter/ClassFilter.php

@@ -15,12 +15,15 @@
 
 use function interface_exists;
 
-final class InterfaceFilter implements Filter
+/**
+ * Filters classes—removes interfaces and traits.
+ */
+final class ClassFilter implements Filter
 {
     public function filter(string $filepath, string $class, IOInterface $io): bool
     {
         try {
-            if (interface_exists($class)) {
+            if (!class_exists($class)) {
                 return false;
             }
         } catch (Throwable $e) {

src/InheritsAttributes.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace olvlvl\ComposerAttributeCollector;
+
+use Attribute;
+
+/**
+ * Use this attribute when a class inherits attributes from traits or parents and is ignored by the collector.
+ */
+#[Attribute(Attribute::TARGET_CLASS)]
+final class InheritsAttributes
+{
+}

src/Plugin.php

@@ -11,7 +11,7 @@
 use olvlvl\ComposerAttributeCollector\Datastore\FileDatastore;
 use olvlvl\ComposerAttributeCollector\Datastore\RuntimeDatastore;
 use olvlvl\ComposerAttributeCollector\Filter\ContentFilter;
-use olvlvl\ComposerAttributeCollector\Filter\InterfaceFilter;
+use olvlvl\ComposerAttributeCollector\Filter\ClassFilter;
 
 use function file_exists;
 use function file_put_contents;
@@ -162,7 +162,7 @@ private static function buildFileFilter(): Filter
     {
         return new Filter\Chain([
             new ContentFilter(),
-            new InterfaceFilter()
+            new ClassFilter()
         ]);
     }
 

tests/Acme/Attribute/Routing/UrlGetter.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Acme\Attribute\Routing;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_METHOD)]
+final class UrlGetter
+{
+}

tests/Acme/PSR4/InheritedAttributeSample.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Acme\PSR4;
+
+use Acme\PSR4\Routing\UrlTrait;
+use olvlvl\ComposerAttributeCollector\InheritsAttributes;
+
+#[InheritsAttributes]
+class InheritedAttributeSample
+{
+    use UrlTrait;
+}

tests/Acme/PSR4/Routing/UrlTrait.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Acme\PSR4\Routing;
+
+use Acme\Attribute\Routing\UrlGetter;
+
+trait UrlTrait
+{
+    #[UrlGetter]
+    public function get_url(): string
+    {
+        return '/url';
+    }
+}

tests/PluginTest.php

@@ -1,12 +1,5 @@
 <?php
 
-/*
- * (c) Olivier Laviale <olivier.laviale@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
 namespace tests\olvlvl\ComposerAttributeCollector;
 
 use Acme\Attribute\ActiveRecord\Boolean;
@@ -21,6 +14,7 @@
 use Acme\Attribute\Permission;
 use Acme\Attribute\Resource;
 use Acme\Attribute\Route;
+use Acme\Attribute\Routing\UrlGetter;
 use Acme\Attribute\Subscribe;
 use Acme\PSR4\Presentation\ArticleController;
 use Composer\IO\NullIO;
@@ -44,9 +38,6 @@ final class PluginTest extends TestCase
 {
     private static bool $initialized = false;
 
-    /**
-     * @throws ReflectionException
-     */
     protected function setUp(): void
     {
         parent::setUp();
@@ -184,6 +175,12 @@ public static function provideTargetMethods(): array
                     [ new Subscribe(), 'Acme\PSR4\SubscriberB::onEventA' ],
                 ]
             ],
+            [
+                UrlGetter::class,
+                [
+                    [ new UrlGetter(), 'Acme\PSR4\InheritedAttributeSample::get_url' ]
+                ]
+            ],
 
         ];
     }