Resolve include from autoload (#44)

Author: olvlvl

CHANGELOG.md

@@ -31,6 +31,8 @@ None
     }
     ```
 
+- [#44](https://github.com/olvlvl/composer-attribute-collector/pull/44) The collector automatically scans `autoload` paths of the root `composer.json` for a zero-configuration experience. (@olvlvl)
+
 ### Deprecated Features
 
 None

README.md

@@ -4,19 +4,19 @@
 [![Code Coverage](https://coveralls.io/repos/github/olvlvl/composer-attribute-collector/badge.svg?branch=main)](https://coveralls.io/r/olvlvl/composer-attribute-collector?branch=main)
 [![Downloads](https://img.shields.io/packagist/dt/olvlvl/composer-attribute-collector.svg)](https://packagist.org/packages/olvlvl/composer-attribute-collector)
 
-**composer-attribute-collector** is a plugin for [Composer][]. Its ambition is to provide a
-convenient way—and near zero cost—to retrieve targets of PHP 8 attributes. After the autoloader has
-been dumped, the plugin collects attribute targets and generates a static file. These targets can be
-retrieved through a convenient interface, without reflection. The plugin is useful when you need to
-_discover_ attribute targets in a codebase—for known targets you can use reflection.
+**composer-attribute-collector** is a [Composer][] plugin designed to effectively _discover_ PHP 8
+attribute targets, and later retrieve them at near zero cost, without runtime reflection. After the
+autoloader dump, it collects attributes and generates a static file for fast access. This provides a
+convenient way to _discover_ attribute-backed classes, methods, or properties—ideal for codebase
+analysis. (For known targets, traditional reflection remains an option.)
 
 
 
 #### Features
 
-- Little configuration
+- Zero configuration
 - No reflection in the generated file
-- No impact on performance
+- Might improve performance
 - No dependency (except Composer of course)
 - A single interface to get attribute targets: classes, methods, and properties
 - Can cache discoveries to speed up consecutive runs.
@@ -91,11 +91,11 @@ var_dump($attributes->propertyAttributes);
 
 Here are a few steps to get you started.
 
-### 1\. Configure the plugin
+### 1\. Configure the plugin (optional)
 
-The plugin only inspects paths and files specified in the configuration with the `include` property.
-That is usually your "src" directory. Add this section to your `composer.json` file to enable the
-generation of the "attributes" file when the autoloader is dumped.
+The collector automatically scans `autoload` paths of the root `composer.json` for a
+zero-configuration experience. You can override them via
+`extra.composer-attribute-collector.include`.
 
 ```json
 {
@@ -162,8 +162,8 @@ Here are a few ways you can configure the plugin.
 
 ### Including paths or files ([root-only][])
 
-Use the `include` property to define the paths or files to inspect for attributes. Without this
-property, the "attributes" file will be empty.
+The collector automatically scans `autoload` paths of the root `composer.json`, but you can override
+them via the `include` property.
 
 The specified paths are relative to the `composer.json` file, and the `{vendor}` placeholder is
 replaced with the path to the vendor folder.
@@ -182,7 +182,7 @@ replaced with the path to the vendor folder.
 
 ### Excluding paths or files ([root-only][])
 
-Use the `exclude` property to exclude paths or files from inspection. This is handy when files
+Use the `exclude` property to exclude paths or files from scanning. This is handy when files
 cause issues or have side effects.
 
 The specified paths are relative to the `composer.json` file, and the `{vendor}` placeholder is
@@ -277,9 +277,9 @@ PHP. If the plugin is too slow for your liking, try running the command with
 **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.
+attribute usage. If a class inherits its attributes from traits, properties, or methods, but doesn't
+use attributes itself, it will be ignored. Use the attribute
+`[#\olvlvl\ComposerAttributeCollector\InheritsAttributes]` to force the collection.
 
 ```php
 trait UrlTrait

src/Config.php

@@ -3,6 +3,7 @@
 namespace olvlvl\ComposerAttributeCollector;
 
 use Composer\Factory;
+use Composer\Package\PackageInterface;
 use Composer\PartialComposer;
 use Composer\Util\Platform;
 use InvalidArgumentException;
@@ -31,6 +32,7 @@ final class Config
     public const EXTRA_INCLUDE = 'include';
     public const EXTRA_EXCLUDE = 'exclude';
     public const ENV_USE_CACHE = 'COMPOSER_ATTRIBUTE_COLLECTOR_USE_CACHE';
+    public const FILENAME = 'attributes.php';
 
     /**
      * If a path starts with this placeholder, it is replaced with the absolute path to the vendor directory.
@@ -48,18 +50,24 @@ public static function from(PartialComposer $composer, bool $isDebug = false): s
         }
 
         $rootDir .= DIRECTORY_SEPARATOR;
+        $attributesFile = $vendorDir . DIRECTORY_SEPARATOR . self::FILENAME;
 
+        $package = $composer->getPackage();
         /** @var array{ include?: non-empty-string[], exclude?: non-empty-string[] } $extra */
-        $extra = $composer->getPackage()->getExtra()[self::EXTRA] ?? [];
+        $extra = $package->getExtra()[self::EXTRA] ?? [];
 
-        $include = self::expandPaths($extra[self::EXTRA_INCLUDE] ?? [], $vendorDir, $rootDir);
+        $include = self::expandPaths(
+            $extra[self::EXTRA_INCLUDE] ?? self::resolveInclude($package, $attributesFile),
+            $vendorDir,
+            $rootDir,
+        );
         $exclude = self::expandPaths($extra[self::EXTRA_EXCLUDE] ?? [], $vendorDir, $rootDir);
 
         $useCache = filter_var(Platform::getEnv(self::ENV_USE_CACHE), FILTER_VALIDATE_BOOL);
 
         return new self(
             $vendorDir,
-            attributesFile: "$vendorDir/attributes.php",
+            attributesFile: $attributesFile,
             include: $include,
             exclude: $exclude,
             useCache: $useCache,
@@ -81,6 +89,29 @@ public static function resolveVendorDir(PartialComposer $composer): string
         return $vendorDir;
     }
 
+    /**
+     * @param non-empty-string $attributesFile
+     *
+     * @return non-empty-string[]
+     */
+    public static function resolveInclude(PackageInterface $package, string $attributesFile): array
+    {
+        $include = [];
+
+        foreach ($package->getAutoload() as $paths) {
+            /** @var non-empty-string[] $paths */
+            foreach ($paths as $path) {
+                if (realpath($path) === $attributesFile) {
+                    continue;
+                }
+
+                $include[] = $path;
+            }
+        }
+
+        return $include;
+    }
+
     /**
      * @readonly
      * @var non-empty-string|null
@@ -142,6 +173,10 @@ private static function expandPaths(array $paths, string $vendorDir, string $roo
         $expanded = [];
 
         foreach ($paths as $path) {
+            if (str_starts_with($path, "./")) {
+                $path = substr($path, 2);
+            }
+
             if (str_starts_with($path, self::VENDOR_PLACEHOLDER)) {
                 $path = $vendorDir . substr($path, strlen(self::VENDOR_PLACEHOLDER));
             } else {

tests/ConfigTest.php

@@ -4,14 +4,11 @@
 
 use Composer\Package\RootPackageInterface;
 use Composer\PartialComposer;
+use Composer\Util\Platform;
 use olvlvl\ComposerAttributeCollector\Config;
 use PHPUnit\Framework\TestCase;
 use RuntimeException;
 
-use function assert;
-use function getcwd;
-use function is_string;
-
 final class ConfigTest extends TestCase
 {
     public function testFrom(): void
@@ -34,8 +31,7 @@ public function testFrom(): void
             ->method('getExtra')
             ->willReturn($extra);
 
-        $cwd = getcwd();
-        assert(is_string($cwd));
+        $cwd = Platform::getCwd();
         $config = $this->createMock(\Composer\Config::class);
         $config
             ->method('get')
@@ -66,6 +62,62 @@ public function testFrom(): void
         $this->assertEquals($expected, $actual);
     }
 
+    public function testResolveIncludeFromAutoload(): void
+    {
+        $package = $this->createMock(RootPackageInterface::class);
+        $package
+            ->method('getExtra')
+            ->willReturn([]);
+        $package
+            ->expects($this->once())
+            ->method('getAutoload')
+            ->willReturn([
+                'classmap' => [
+                    'src/classmap',
+                    'src/bootstrap.php',
+                ],
+                'psr-0' => [
+                    'Acme/PSR4' => './src/psr-0',
+                ],
+                'psr-4' => [
+                    'Acme/PSR4' => 'src/psr-4',
+                ],
+                'files' => [
+                    './src/files'
+                ]
+            ]);
+
+        $cwd = Platform::getCwd();
+        $config = $this->createMock(\Composer\Config::class);
+        $config
+            ->method('get')
+            ->with('vendor-dir')
+            ->willReturn("$cwd/vendor");
+
+        $composer = new PartialComposer();
+        $composer->setConfig($config);
+        $composer->setPackage($package);
+
+        $expected = new Config(
+            vendorDir: "$cwd/vendor",
+            attributesFile: "$cwd/vendor/attributes.php",
+            include: [
+                "$cwd/src/classmap",
+                "$cwd/src/bootstrap.php",
+                "$cwd/src/psr-0",
+                "$cwd/src/psr-4",
+                "$cwd/src/files",
+            ],
+            exclude: [],
+            useCache: false,
+            isDebug: false,
+        );
+
+        $actual = Config::from($composer);
+
+        $this->assertEquals($expected, $actual);
+    }
+
     public function testFromFailsOnMissingVendorDir(): void
     {
         $config = $this->createMock(\Composer\Config::class);