Ignore paths (Fixes #3, #4) (#5)

Author: olvlvl

MIGRATION.md

@@ -1,5 +1,28 @@
 # Migration
 
+## v1.0 to v1.1
+
+### New Requirements
+
+None
+
+### New features
+
+- File paths matching `symfony/cache/Traits` are ignored.
+- The option `extra.composer-attribute-collection.ignore-paths` can be used to ignore paths.
+
+### Backward Incompatible Changes
+
+None
+
+### Deprecated Features
+
+None
+
+### Other Changes
+
+None
+
 <!--
 
 ## vX.x to vX.x

README.md

@@ -88,6 +88,29 @@ could also use [spatie/file-system-watcher][], it only requires PHP.
 
 
 
+## Configuration
+
+### Ignoring paths ([root-only][])
+
+composer-attribute-collector inspects files that participate in the autoload process. This can cause
+issues with files that have side effects. For instance, `symfony/cache` is known to cause issues, so
+we're excluding paths matching `symfony/cache/Traits` from inspection. Additional paths can be
+specified using the `extra` section of `composer.json`:
+
+```json
+{
+  "extra": {
+    "composer-attribute-collector": {
+      "ignore-paths": [
+        "path/to/ignore"
+      ]
+    }
+  }
+}
+```
+
+
+
 ## Test drive with a Symfony app
 
 You can try the plugin with a fresh installation of Symfony.
@@ -125,6 +148,8 @@ Attributes::with(fn () => new Collection(
             [ ['translation:pull', 'Pull translations from a given provider.'], \Symfony\Component\Translation\Command\TranslationPullCommand::class ],
 ```
 
+We also have [a repository to test the Symfony usecase](https://github.com/olvlvl/composer-attribute-collector-usecase-symfony).
+
 
 
 ## Use cases
@@ -270,7 +295,8 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 
 
-[Composer]: https://getcomposer.org/
+[Composer]:  https://getcomposer.org/
+[root-only]: https://getcomposer.org/doc/04-schema.md#root-package
 [ICanBoogie/MessageBus]: https://github.com/ICanBoogie/MessageBus
 [spatie/file-system-watcher]: https://github.com/spatie/file-system-watcher
 [phpstorm-watchers]: https://www.jetbrains.com/help/phpstorm/using-file-watchers.html

composer.json

@@ -35,6 +35,11 @@
         "phpunit/phpunit": "^9.5"
     },
     "extra": {
-        "class": "olvlvl\\ComposerAttributeCollector\\Plugin"
+        "class": "olvlvl\\ComposerAttributeCollector\\Plugin",
+        "composer-attribute-collector": {
+            "ignore-paths": [
+                "IncompatibleSignature"
+            ]
+        }
     }
 }

src/Filter.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace olvlvl\ComposerAttributeCollector;
+
+use Composer\IO\IOInterface;
+
+interface Filter
+{
+    /**
+     * @param class-string $class
+     */
+    public function filter(string $filepath, string $class, IOInterface $io): bool;
+}

src/Filter/Chain.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * (c) Olivier Laviale <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace olvlvl\ComposerAttributeCollector\Filter;
+
+use Composer\IO\IOInterface;
+use olvlvl\ComposerAttributeCollector\Filter;
+
+final class Chain implements Filter
+{
+    /**
+     * @param iterable<Filter> $filters
+     */
+    public function __construct(
+        private iterable $filters
+    ) {
+    }
+
+    public function filter(string $filepath, string $class, IOInterface $io): bool
+    {
+        foreach ($this->filters as $filter) {
+            if ($filter->filter($filepath, $class, $io) === false) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+}

src/Filter/ContentFilter.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * (c) Olivier Laviale <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace olvlvl\ComposerAttributeCollector\Filter;
+
+use Composer\IO\IOInterface;
+use olvlvl\ComposerAttributeCollector\Filter;
+
+use function assert;
+use function file_get_contents;
+use function is_string;
+use function preg_match;
+use function str_contains;
+
+final class ContentFilter implements Filter
+{
+    public function filter(string $filepath, string $class, IOInterface $io): bool
+    {
+        $content = file_get_contents($filepath);
+
+        assert(is_string($content));
+
+        // No hint of attribute usage.
+        if (!str_contains($content, '#[')) {
+            return false;
+        }
+
+        // Hint of an attribute class.
+        if (preg_match('/#\[\\\?Attribute[\]\(]/', $content)) {
+            $io->debug("Discarding '$class' because it looks like an attribute");
+            return false;
+        }
+
+        return true;
+    }
+}

src/Filter/InterfaceFilter.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * (c) Olivier Laviale <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace olvlvl\ComposerAttributeCollector\Filter;
+
+use Composer\IO\IOInterface;
+use olvlvl\ComposerAttributeCollector\Filter;
+use Throwable;
+
+use function interface_exists;
+
+final class InterfaceFilter implements Filter
+{
+    public function filter(string $filepath, string $class, IOInterface $io): bool
+    {
+        try {
+            if (interface_exists($class)) {
+                return false;
+            }
+        } catch (Throwable $e) {
+            $io->warning("Discarding '$class' because an error occurred during loading: {$e->getMessage()}");
+
+            return false;
+        }
+
+        return true;
+    }
+}

src/Filter/PathFilter.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * (c) Olivier Laviale <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace olvlvl\ComposerAttributeCollector\Filter;
+
+use Composer\IO\IOInterface;
+use olvlvl\ComposerAttributeCollector\Filter;
+
+use function str_contains;
+
+final class PathFilter implements Filter
+{
+    /**
+     * @param string[] $matches
+     */
+    public function __construct(
+        private array $matches
+    ) {
+    }
+
+    public function filter(string $filepath, string $class, IOInterface $io): bool
+    {
+        foreach ($this->matches as $match) {
+            if (str_contains($filepath, $match)) {
+                $io->debug("Discarding '$class' because its path matches '$match'");
+
+                return false;
+            }
+        }
+
+        return true;
+    }
+}

src/Plugin.php

@@ -15,27 +15,38 @@
 use Composer\IO\IOInterface;
 use Composer\Plugin\PluginInterface;
 use Composer\Script\Event;
+use olvlvl\ComposerAttributeCollector\Filter\ContentFilter;
+use olvlvl\ComposerAttributeCollector\Filter\InterfaceFilter;
+use olvlvl\ComposerAttributeCollector\Filter\PathFilter;
 use ReflectionAttribute;
 use ReflectionClass;
 use ReflectionException;
 use ReflectionMethod;
-use Throwable;
 
+use function array_filter;
 use function array_map;
-use function file_get_contents;
+use function array_merge;
 use function file_put_contents;
 use function implode;
-use function interface_exists;
 use function is_string;
 use function spl_autoload_register;
-use function str_contains;
 use function var_export;
 
+use const ARRAY_FILTER_USE_BOTH;
+
 /**
  * @internal
  */
 final class Plugin implements PluginInterface, EventSubscriberInterface
 {
+    public const EXTRA = 'composer-attribute-collector';
+    public const EXTRA_IGNORE_PATHS = 'ignore-paths';
+
+    private const PROBLEMATIC_PATHS = [
+        // https://github.com/olvlvl/composer-attribute-collector/issues/4
+        'symfony/cache/Traits'
+    ];
+
     /**
      * @uses onPostAutoloadDump
      *
@@ -97,6 +108,13 @@ public static function dump(
 
         self::setupAutoload($classMap);
 
+        $filter = self::buildClassMapFilter($composer);
+        $classMap = array_filter(
+            $classMap,
+            fn ($class, $filepath) => $filter->filter($class, $filepath, $io),
+            ARRAY_FILTER_USE_BOTH
+        );
+
         $collection = self::collectAttributes($classMap, $io);
         $code = self::render($collection);
 
@@ -116,6 +134,23 @@ private static function setupAutoload(array $classMap): void
         });
     }
 
+    private static function buildClassMapFilter(Composer $composer): Filter
+    {
+        $extra = $composer->getPackage()->getExtra()[self::EXTRA] ?? [];
+        /** @var string[] $ignore_paths */
+        $ignore_paths = array_merge(
+            // @phpstan-ignore-next-line
+            $extra[self::EXTRA_IGNORE_PATHS] ?? [],
+            self::PROBLEMATIC_PATHS
+        );
+
+        return new Filter\Chain([
+            new PathFilter($ignore_paths),
+            new ContentFilter(),
+            new InterfaceFilter()
+        ]);
+    }
+
     /**
      * @param array<class-string, non-empty-string> $classMap
      *
@@ -126,24 +161,6 @@ private static function collectAttributes(array $classMap, IOInterface $io): Col
         $collector = new Collector();
 
         foreach ($classMap as $class => $filepath) {
-            $content = file_get_contents($filepath);
-
-            assert(is_string($content));
-
-            if (!str_contains($content, '#[')) {
-                continue;
-            }
-
-            try {
-                if (interface_exists($class)) {
-                    continue;
-                }
-            } catch (Throwable $e) {
-                $io->warning("Discarding '$class' because an error occurred during loading: {$e->getMessage()}");
-
-                continue;
-            }
-
             $classReflection = new ReflectionClass($class);
 
             if (self::isAttribute($classReflection)) {

tests/Acme/PSR4/IncompatibleSignature.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Acme\PSR4;
+
+use Acme\Attribute\Handler;
+use IteratorAggregate;
+
+#[Handler]
+class IncompatibleSignature implements IteratorAggregate
+{
+    public function getIterator(string $invalid): void
+    {
+        // TODO: Implement getIterator() method.
+    }
+}