Run the collector as a command (#35)

Author: olvlvl

CHANGELOG.md

@@ -8,11 +8,11 @@ None
 
 ### New features
 
-- [#38](https://github.com/olvlvl/composer-attribute-collector/pull/38) Attributes are now collected from interfaces as well as classes.
+- [#38](https://github.com/olvlvl/composer-attribute-collector/pull/38) Attributes are now collected from interfaces as well as classes. (@olvlvl)
 
 - [#37](https://github.com/olvlvl/composer-attribute-collector/pull/37) Parameter attributes are now collected. Use the method `findTargetParameters()` to find target parameters, and the method `filterTargetParameters()` to filter target parameters according to a predicate. (@staabm @olvlvl)
 
-- [#39](https://github.com/olvlvl/composer-attribute-collector/pull/39) 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.
+- [#39](https://github.com/olvlvl/composer-attribute-collector/pull/39) 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. (@olvlvl)
 
     ```php
     trait UrlTrait
@@ -41,7 +41,9 @@ None
 
 ### Other Changes
 
-None
+[#35](https://github.com/olvlvl/composer-attribute-collector/pull/35) The collector runs as a
+command to avoid clashes between packages used by Composer and those used by the application, such
+as incompatible signatures between different versions of the PSR Logger. (@olvlvl)
 
 
 

collector.php

@@ -0,0 +1,42 @@
+#!/usr/bin/env php
+<?php
+
+namespace olvlvl\ComposerAttributeCollector;
+
+require 'vendor/autoload.php';
+
+$serializedConfig = $argv[2]
+    ?? throw new \Exception("Configuration is missing");
+
+/** @var Config $config */
+$config = unserialize($serializedConfig);
+
+$log = new class($config->isDebug) implements Logger
+{
+    public function __construct(
+        private bool $isDebug,
+    ) {
+    }
+
+    public function debug(\Stringable|string $message): void
+    {
+        if (!$this->isDebug) {
+            return;
+        }
+
+        fwrite(STDERR, $message . PHP_EOL);
+    }
+
+    public function warning(\Stringable|string $message): void
+    {
+        fwrite(STDERR, "\033[33m$message\033[0m" . PHP_EOL);
+    }
+
+    public function error(\Stringable|string $message): void
+    {
+        fwrite(STDERR, "\033[31m$message\033[0m" . PHP_EOL);
+    }
+};
+
+$collector = new Collector($config, $log);
+$collector->dump();

composer.json

@@ -31,7 +31,8 @@
   },
   "require": {
     "php": ">=8.0",
-    "composer-plugin-api": "^2.0"
+    "composer-plugin-api": "^2.0",
+    "composer/class-map-generator": "^1.4"
   },
   "require-dev": {
     "composer/composer": ">=2.4",

src/Collector.php

@@ -0,0 +1,99 @@
+<?php
+
+namespace olvlvl\ComposerAttributeCollector;
+
+use olvlvl\ComposerAttributeCollector\Datastore\FileDatastore;
+use olvlvl\ComposerAttributeCollector\Datastore\RuntimeDatastore;
+use olvlvl\ComposerAttributeCollector\Filter\ClassFilter;
+use olvlvl\ComposerAttributeCollector\Filter\ContentFilter;
+use RuntimeException;
+
+/**
+ * @internal
+ * @readonly
+ */
+final class Collector
+{
+    public function __construct(
+        private Config $config,
+        private Logger $log,
+    ) {
+    }
+
+    /**
+     * Dumps the 'attributes.php' file.
+     */
+    public function dump(): void
+    {
+        $config = $this->config;
+        $log =  $this->log;
+
+        //
+        // Scan the included paths
+        //
+        $start = microtime(true);
+        $datastore = $this->buildDefaultDatastore();
+        $classMapGenerator = new MemoizeClassMapGenerator($datastore, $log);
+        foreach ($config->include as $include) {
+            $classMapGenerator->scanPaths($include, $config->excludeRegExp);
+        }
+        $classMap = $classMapGenerator->getMap();
+        $elapsed = ElapsedTime::render($start);
+        $log->debug("Generating attributes file: scanned paths in $elapsed");
+
+        //
+        // Filter the class map
+        //
+        $start = microtime(true);
+        $classMapFilter = new MemoizeClassMapFilter($datastore, $log);
+        $filter = $this->buildFileFilter();
+        $classMap = $classMapFilter->filter(
+            $classMap,
+            fn (string $class, string $filepath): bool => $filter->filter($filepath, $class, $log)
+        );
+        $elapsed = ElapsedTime::render($start);
+        $log->debug("Generating attributes file: filtered class map in $elapsed");
+
+        //
+        // Collect attributes
+        //
+        $start = microtime(true);
+        $attributeCollector = new MemoizeAttributeCollector(new ClassAttributeCollector($log), $datastore, $log);
+        $collection = $attributeCollector->collectAttributes($classMap);
+        $elapsed = ElapsedTime::render($start);
+        $log->debug("Generating attributes file: collected attributes in $elapsed");
+
+        //
+        // Render attributes
+        //
+        $start = microtime(true);
+        $code = $this->render($collection);
+        file_put_contents($config->attributesFile, $code);
+        $elapsed = ElapsedTime::render($start);
+        $log->debug("Generating attributes file: rendered code in $elapsed");
+    }
+
+    private function buildDefaultDatastore(): Datastore
+    {
+        if (!$this->config->useCache) {
+            return new RuntimeDatastore();
+        }
+
+        $basePath = getcwd() ?: throw new RuntimeException('Unable to locate base path');
+
+        return new FileDatastore($basePath . DIRECTORY_SEPARATOR . Plugin::CACHE_DIR, $this->log);
+    }
+
+    private function buildFileFilter(): Filter
+    {
+        return new Filter\Chain([
+            new ContentFilter(),
+            new ClassFilter()
+        ]);
+    }
+
+    private function render(TransientCollection $collector): string
+    {
+        return TransientCollectionRenderer::render($collector);
+    }
+}

src/Config.php

@@ -37,7 +37,7 @@ final class Config
      */
     public const VENDOR_PLACEHOLDER = '{vendor}';
 
-    public static function from(PartialComposer $composer): self
+    public static function from(PartialComposer $composer, bool $isDebug = false): self
     {
         $vendorDir = self::resolveVendorDir($composer);
         $composerFile = Factory::getComposerFile();
@@ -63,6 +63,7 @@ public static function from(PartialComposer $composer): self
             include: $include,
             exclude: $exclude,
             useCache: $useCache,
+            isDebug: $isDebug,
         );
     }
 
@@ -95,13 +96,16 @@ public static function resolveVendorDir(PartialComposer $composer): string
      *     Paths that should be excluded from the attribute collection.
      * @param bool $useCache
      *     Whether a cache should be used during the process.
+     * @param bool $isDebug
+     *     Whether debug messages should be logged.
      */
     public function __construct(
         public string $vendorDir,
         public string $attributesFile,
         public array $include,
         public array $exclude,
         public bool $useCache,
+        public bool $isDebug,
     ) {
         $this->excludeRegExp = count($exclude) ? self::compileExclude($this->exclude) : null;
     }

src/Datastore/RuntimeDatastore.php

@@ -4,6 +4,9 @@
 
 use olvlvl\ComposerAttributeCollector\Datastore;
 
+/**
+ * @internal
+ */
 final class RuntimeDatastore implements Datastore
 {
     /**

src/ElapsedTime.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace olvlvl\ComposerAttributeCollector;
+
+/**
+ * @internal
+ */
+final class ElapsedTime
+{
+    /**
+     * @param float $start
+     *     Start microtime.
+     */
+    public static function render(float $start): string
+    {
+        return sprintf("%.03f ms", (microtime(true) - $start) * 1000);
+    }
+}

src/Logger.php

@@ -2,6 +2,9 @@
 
 namespace olvlvl\ComposerAttributeCollector;
 
+/**
+ * @internal
+ */
 interface Logger
 {
     public function debug(string|\Stringable $message): void;

src/Logger/ComposerLogger.php

@@ -5,6 +5,10 @@
 use Composer\IO\IOInterface;
 use olvlvl\ComposerAttributeCollector\Logger;
 
+/**
+ * @internal
+ * @readonly
+ */
 final class ComposerLogger implements Logger
 {
     public function __construct(

src/Plugin.php

@@ -7,17 +7,11 @@
 use Composer\IO\IOInterface;
 use Composer\Plugin\PluginInterface;
 use Composer\Script\Event;
-use Composer\Util\Platform;
-use olvlvl\ComposerAttributeCollector\Datastore\FileDatastore;
-use olvlvl\ComposerAttributeCollector\Datastore\RuntimeDatastore;
-use olvlvl\ComposerAttributeCollector\Filter\ContentFilter;
-use olvlvl\ComposerAttributeCollector\Filter\ClassFilter;
-use olvlvl\ComposerAttributeCollector\Logger\ComposerLogger;
+use Symfony\Component\Process\Process;
 
 use function file_exists;
 use function file_put_contents;
 use function microtime;
-use function sprintf;
 
 use const DIRECTORY_SEPARATOR;
 
@@ -82,94 +76,22 @@ public function uninstall(Composer $composer, IOInterface $io): void
     public static function onPostAutoloadDump(Event $event): void
     {
         $composer = $event->getComposer();
-        $config = Config::from($composer);
         $io = $event->getIO();
+        $config = Config::from($composer, isDebug: $io->isDebug());
 
         require_once $config->vendorDir . "/autoload.php";
 
-        $start = microtime(true);
         $io->write('<info>Generating attributes file</info>');
-        $logger = new ComposerLogger($io);
-        self::dump($config, $logger);
-        $elapsed = self::renderElapsedTime($start);
-        $io->write("<info>Generated attributes file in $elapsed</info>");
-    }
-
-    public static function dump(Config $config, Logger $log): void
-    {
-        //
-        // Scan the included paths
-        //
-        $start = microtime(true);
-        $datastore = self::buildDefaultDatastore($config, $log);
-        $classMapGenerator = new MemoizeClassMapGenerator($datastore, $log);
-        foreach ($config->include as $include) {
-            $classMapGenerator->scanPaths($include, $config->excludeRegExp);
-        }
-        $classMap = $classMapGenerator->getMap();
-        $elapsed = self::renderElapsedTime($start);
-        $log->debug("Generating attributes file: scanned paths in $elapsed");
-
-        //
-        // Filter the class map
-        //
-        $start = microtime(true);
-        $classMapFilter = new MemoizeClassMapFilter($datastore, $log);
-        $filter = self::buildFileFilter();
-        $classMap = $classMapFilter->filter(
-            $classMap,
-            fn (string $class, string $filepath): bool => $filter->filter($filepath, $class, $log)
-        );
-        $elapsed = self::renderElapsedTime($start);
-        $log->debug("Generating attributes file: filtered class map in $elapsed");
-
-        //
-        // Collect attributes
-        //
         $start = microtime(true);
-        $attributeCollector = new MemoizeAttributeCollector(new ClassAttributeCollector($log), $datastore, $log);
-        $collection = $attributeCollector->collectAttributes($classMap);
-        $elapsed = self::renderElapsedTime($start);
-        $log->debug("Generating attributes file: collected attributes in $elapsed");
-
-        //
-        // Render attributes
-        //
-        $start = microtime(true);
-        $code = self::render($collection);
-        file_put_contents($config->attributesFile, $code);
-        $elapsed = self::renderElapsedTime($start);
-        $log->debug("Generating attributes file: rendered code in $elapsed");
-    }
-
-    private static function buildDefaultDatastore(Config $config, Logger $log): Datastore
-    {
-        if (!$config->useCache) {
-            return new RuntimeDatastore();
-        }
-
-        $basePath = Platform::getCwd();
-
-        assert($basePath !== '');
-
-        return new FileDatastore($basePath . DIRECTORY_SEPARATOR . self::CACHE_DIR, $log);
-    }
-
-    private static function renderElapsedTime(float $start): string
-    {
-        return sprintf("%.03f ms", (microtime(true) - $start) * 1000);
-    }
-
-    private static function buildFileFilter(): Filter
-    {
-        return new Filter\Chain([
-            new ContentFilter(),
-            new ClassFilter()
-        ]);
+        self::dump($config);
+        $elapsed = ElapsedTime::render($start);
+        $io->write("<info>Generated attributes file in $elapsed</info>");
     }
 
-    private static function render(TransientCollection $collector): string
+    public static function dump(Config $config): void
     {
-        return TransientCollectionRenderer::render($collector);
+        $cmd = __DIR__ . '/../collector.php';
+        $process = new Process([ $cmd, '--', serialize($config) ]);
+        $process->mustRun(fn (string $type, string $line) => print($line));
     }
 }