Decouple from IOInterface (#34)

olvlvl · web-flow · commit ca67a62ab644 · 2025-06-11T11:13:22.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 .composer-attribute-collector
 .phpunit.result.cache
+build
 composer.lock
 vendor
diff --git a/src/ClassAttributeCollector.php b/src/ClassAttributeCollector.php
@@ -3,7 +3,6 @@
 namespace olvlvl\ComposerAttributeCollector;
 
 use Attribute;
-use Composer\IO\IOInterface;
 use ReflectionAttribute;
 use ReflectionClass;
 use ReflectionException;
@@ -14,7 +13,7 @@
 class ClassAttributeCollector
 {
     public function __construct(
-        private IOInterface $io,
+        private Logger $log,
     ) {
     }
 
@@ -45,7 +44,7 @@ public function collectAttributes(string $class): array
                 continue;
             }
 
-            $this->io->debug("Found attribute {$attribute->getName()} on $class");
+            $this->log->debug("Found attribute {$attribute->getName()} on $class");
 
             $classAttributes[] = new TransientTargetClass(
                 $attribute->getName(),
@@ -63,7 +62,7 @@ public function collectAttributes(string $class): array
 
                 $method = $methodReflection->name;
 
-                $this->io->debug("Found attribute {$attribute->getName()} on $class::$method");
+                $this->log->debug("Found attribute {$attribute->getName()} on $class::$method");
 
                 $methodAttributes[] = new TransientTargetMethod(
                     $attribute->getName(),
@@ -84,7 +83,7 @@ public function collectAttributes(string $class): array
                 $property = $propertyReflection->name;
                 assert($property !== '');
 
-                $this->io->debug("Found attribute {$attribute->getName()} on $class::$property");
+                $this->log->debug("Found attribute {$attribute->getName()} on $class::$property");
 
                 $propertyAttributes[] = new TransientTargetProperty(
                     $attribute->getName(),
diff --git a/src/Datastore/FileDatastore.php b/src/Datastore/FileDatastore.php
@@ -2,8 +2,8 @@
 
 namespace olvlvl\ComposerAttributeCollector\Datastore;
 
-use Composer\IO\IOInterface;
 use olvlvl\ComposerAttributeCollector\Datastore;
+use olvlvl\ComposerAttributeCollector\Logger;
 use olvlvl\ComposerAttributeCollector\Plugin;
 
 use function file_exists;
@@ -29,7 +29,7 @@ final class FileDatastore implements Datastore
      */
     public function __construct(
         private string $dir,
-        private IOInterface $io,
+        private Logger $log,
     ) {
         if (!is_dir($dir)) {
             mkdir($dir);
@@ -70,7 +70,7 @@ private function safeGet(string $filename): array
         set_error_handler(function (int $errno, string $errstr) use (&$errored, $filename): bool {
             $errored = true;
 
-            $this->io->warning("Unable to unserialize cache item $filename: $errstr");
+            $this->log->warning("Unable to unserialize cache item $filename: $errstr");
 
             return true;
         });
diff --git a/src/Filter.php b/src/Filter.php
@@ -2,8 +2,6 @@
 
 namespace olvlvl\ComposerAttributeCollector;
 
-use Composer\IO\IOInterface;
-
 /**
  * @internal
  */
@@ -12,5 +10,5 @@ interface Filter
     /**
      * @param class-string $class
      */
-    public function filter(string $filepath, string $class, IOInterface $io): bool;
+    public function filter(string $filepath, string $class, Logger $log): bool;
 }
diff --git a/src/Filter/Chain.php b/src/Filter/Chain.php
@@ -2,8 +2,8 @@
 
 namespace olvlvl\ComposerAttributeCollector\Filter;
 
-use Composer\IO\IOInterface;
 use olvlvl\ComposerAttributeCollector\Filter;
+use olvlvl\ComposerAttributeCollector\Logger;
 
 final class Chain implements Filter
 {
@@ -15,10 +15,10 @@ public function __construct(
     ) {
     }
 
-    public function filter(string $filepath, string $class, IOInterface $io): bool
+    public function filter(string $filepath, string $class, Logger $log): bool
     {
         foreach ($this->filters as $filter) {
-            if ($filter->filter($filepath, $class, $io) === false) {
+            if ($filter->filter($filepath, $class, $log) === false) {
                 return false;
             }
         }
diff --git a/src/Filter/ContentFilter.php b/src/Filter/ContentFilter.php
@@ -2,8 +2,8 @@
 
 namespace olvlvl\ComposerAttributeCollector\Filter;
 
-use Composer\IO\IOInterface;
 use olvlvl\ComposerAttributeCollector\Filter;
+use olvlvl\ComposerAttributeCollector\Logger;
 
 use function assert;
 use function file_get_contents;
@@ -13,7 +13,7 @@
 
 final class ContentFilter implements Filter
 {
-    public function filter(string $filepath, string $class, IOInterface $io): bool
+    public function filter(string $filepath, string $class, Logger $log): bool
     {
         $content = file_get_contents($filepath);
 
@@ -26,7 +26,7 @@ public function filter(string $filepath, string $class, IOInterface $io): bool
 
         // Hint of an attribute class.
         if (preg_match('/#\[\\\?Attribute[\]\(]/', $content)) {
-            $io->debug("Discarding '$class' because it looks like an attribute");
+            $log->debug("Discarding '$class' because it looks like an attribute");
             return false;
         }
 
diff --git a/src/Filter/InterfaceFilter.php b/src/Filter/InterfaceFilter.php
@@ -2,22 +2,22 @@
 
 namespace olvlvl\ComposerAttributeCollector\Filter;
 
-use Composer\IO\IOInterface;
 use olvlvl\ComposerAttributeCollector\Filter;
+use olvlvl\ComposerAttributeCollector\Logger;
 use Throwable;
 
 use function interface_exists;
 
 final class InterfaceFilter implements Filter
 {
-    public function filter(string $filepath, string $class, IOInterface $io): bool
+    public function filter(string $filepath, string $class, Logger $log): bool
     {
         try {
             if (interface_exists($class)) {
                 return false;
             }
         } catch (Throwable $e) {
-            $io->warning("Discarding '$class' because an error occurred during loading: {$e->getMessage()}");
+            $log->warning("Discarding '$class' because an error occurred during loading: {$e->getMessage()}");
 
             return false;
         }
diff --git a/src/Logger.php b/src/Logger.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace olvlvl\ComposerAttributeCollector;
+
+interface Logger
+{
+    public function debug(string|\Stringable $message): void;
+    public function warning(string|\Stringable $message): void;
+    public function error(string|\Stringable $message): void;
+}
diff --git a/src/Logger/ComposerLogger.php b/src/Logger/ComposerLogger.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace olvlvl\ComposerAttributeCollector\Logger;
+
+use Composer\IO\IOInterface;
+use olvlvl\ComposerAttributeCollector\Logger;
+
+final class ComposerLogger implements Logger
+{
+    public function __construct(
+        private IOInterface $io
+    ) {
+    }
+
+    public function debug(\Stringable|string $message): void
+    {
+        $this->io->debug($message);
+    }
+
+    public function warning(\Stringable|string $message): void
+    {
+        $this->io->warning($message);
+    }
+
+    public function error(\Stringable|string $message): void
+    {
+        $this->io->error($message);
+    }
+}
diff --git a/src/MemoizeAttributeCollector.php b/src/MemoizeAttributeCollector.php
@@ -2,7 +2,6 @@
 
 namespace olvlvl\ComposerAttributeCollector;
 
-use Composer\IO\IOInterface;
 use Throwable;
 
 use function array_filter;
@@ -35,7 +34,7 @@ class MemoizeAttributeCollector
     public function __construct(
         private ClassAttributeCollector $classAttributeCollector,
         private Datastore $datastore,
-        private IOInterface $io,
+        private Logger $log,
     ) {
         /** @phpstan-ignore-next-line */
         $this->state = $this->datastore->get(self::KEY);
@@ -66,9 +65,9 @@ public function collectAttributes(array $classMap): TransientCollection
             if ($timestamp < $mtime) {
                 if ($timestamp) {
                     $diff = $mtime - $timestamp;
-                    $this->io->debug("Refresh attributes of class '$class' in '$filepath' ($diff sec ago)");
+                    $this->log->debug("Refresh attributes of class '$class' in '$filepath' ($diff sec ago)");
                 } else {
-                    $this->io->debug("Collect attributes of class '$class' in '$filepath'");
+                    $this->log->debug("Collect attributes of class '$class' in '$filepath'");
                 }
 
                 try {
@@ -78,7 +77,7 @@ public function collectAttributes(array $classMap): TransientCollection
                         $propertyAttributes,
                     ] = $classAttributeCollector->collectAttributes($class);
                 } catch (Throwable $e) {
-                    $this->io->error(
+                    $this->log->error(
                         "Attribute collection failed for $class: {$e->getMessage()}",
                     );
                 }
diff --git a/src/MemoizeClassMapFilter.php b/src/MemoizeClassMapFilter.php
@@ -3,7 +3,6 @@
 namespace olvlvl\ComposerAttributeCollector;
 
 use Closure;
-use Composer\IO\IOInterface;
 
 use function array_filter;
 use function filemtime;
@@ -26,7 +25,7 @@ class MemoizeClassMapFilter
 
     public function __construct(
         private Datastore $datastore,
-        private IOInterface $io,
+        private Logger $io,
     ) {
         /** @phpstan-ignore-next-line */
         $this->state = $this->datastore->get(self::KEY);
diff --git a/src/MemoizeClassMapGenerator.php b/src/MemoizeClassMapGenerator.php
@@ -3,7 +3,6 @@
 namespace olvlvl\ComposerAttributeCollector;
 
 use Composer\ClassMapGenerator\ClassMapGenerator;
-use Composer\IO\IOInterface;
 use DirectoryIterator;
 use RuntimeException;
 
@@ -38,7 +37,7 @@ class MemoizeClassMapGenerator
 
     public function __construct(
         private Datastore $datastore,
-        private IOInterface $io,
+        private Logger $log,
     ) {
         /** @phpstan-ignore-next-line */
         $this->state = $this->datastore->get(self::KEY);
@@ -107,7 +106,7 @@ private function shouldUpdate(int $timestamp, string $path): bool
 
         if ($timestamp < $mtime) {
             $diff = $mtime - $timestamp;
-            $this->io->debug("Refresh class map for path '$path' ($diff sec ago)");
+            $this->log->debug("Refresh class map for path '$path' ($diff sec ago)");
 
             return true;
         }
diff --git a/src/Plugin.php b/src/Plugin.php
@@ -12,6 +12,7 @@
 use olvlvl\ComposerAttributeCollector\Datastore\RuntimeDatastore;
 use olvlvl\ComposerAttributeCollector\Filter\ContentFilter;
 use olvlvl\ComposerAttributeCollector\Filter\InterfaceFilter;
+use olvlvl\ComposerAttributeCollector\Logger\ComposerLogger;
 
 use function file_exists;
 use function file_put_contents;
@@ -88,47 +89,48 @@ public static function onPostAutoloadDump(Event $event): void
 
         $start = microtime(true);
         $io->write('<info>Generating attributes file</info>');
-        self::dump($config, $io);
+        $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, IOInterface $io): void
+    public static function dump(Config $config, Logger $log): void
     {
         //
         // Scan the included paths
         //
         $start = microtime(true);
-        $datastore = self::buildDefaultDatastore($config, $io);
-        $classMapGenerator = new MemoizeClassMapGenerator($datastore, $io);
+        $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);
-        $io->debug("Generating attributes file: scanned paths in $elapsed");
+        $log->debug("Generating attributes file: scanned paths in $elapsed");
 
         //
         // Filter the class map
         //
         $start = microtime(true);
-        $classMapFilter = new MemoizeClassMapFilter($datastore, $io);
+        $classMapFilter = new MemoizeClassMapFilter($datastore, $log);
         $filter = self::buildFileFilter();
         $classMap = $classMapFilter->filter(
             $classMap,
-            fn (string $class, string $filepath): bool => $filter->filter($filepath, $class, $io)
+            fn (string $class, string $filepath): bool => $filter->filter($filepath, $class, $log)
         );
         $elapsed = self::renderElapsedTime($start);
-        $io->debug("Generating attributes file: filtered class map in $elapsed");
+        $log->debug("Generating attributes file: filtered class map in $elapsed");
 
         //
         // Collect attributes
         //
         $start = microtime(true);
-        $attributeCollector = new MemoizeAttributeCollector(new ClassAttributeCollector($io), $datastore, $io);
+        $attributeCollector = new MemoizeAttributeCollector(new ClassAttributeCollector($log), $datastore, $log);
         $collection = $attributeCollector->collectAttributes($classMap);
         $elapsed = self::renderElapsedTime($start);
-        $io->debug("Generating attributes file: collected attributes in $elapsed");
+        $log->debug("Generating attributes file: collected attributes in $elapsed");
 
         //
         // Render attributes
@@ -137,10 +139,10 @@ public static function dump(Config $config, IOInterface $io): void
         $code = self::render($collection);
         file_put_contents($config->attributesFile, $code);
         $elapsed = self::renderElapsedTime($start);
-        $io->debug("Generating attributes file: rendered code in $elapsed");
+        $log->debug("Generating attributes file: rendered code in $elapsed");
     }
 
-    private static function buildDefaultDatastore(Config $config, IOInterface $io): Datastore
+    private static function buildDefaultDatastore(Config $config, Logger $log): Datastore
     {
         if (!$config->useCache) {
             return new RuntimeDatastore();
@@ -150,7 +152,7 @@ private static function buildDefaultDatastore(Config $config, IOInterface $io):
 
         assert($basePath !== '');
 
-        return new FileDatastore($basePath . DIRECTORY_SEPARATOR . self::CACHE_DIR, $io);
+        return new FileDatastore($basePath . DIRECTORY_SEPARATOR . self::CACHE_DIR, $log);
     }
 
     private static function renderElapsedTime(float $start): string
diff --git a/tests/ClassAttributeCollectorTest.php b/tests/ClassAttributeCollectorTest.php
@@ -8,7 +8,6 @@
 use Acme\PSR4\Presentation\ArticleController;
 use Acme\PSR4\SubscriberA;
 use Attribute;
-use Composer\IO\NullIO;
 use olvlvl\ComposerAttributeCollector\ClassAttributeCollector;
 use olvlvl\ComposerAttributeCollector\TransientTargetClass;
 use olvlvl\ComposerAttributeCollector\TransientTargetMethod;
@@ -24,7 +23,7 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        $this->sut = new ClassAttributeCollector(new NullIO());
+        $this->sut = new ClassAttributeCollector(new FakeLogger());
     }
 
     /**
diff --git a/tests/FakeLogger.php b/tests/FakeLogger.php
diff --git a/tests/FileDatastoreTest.php b/tests/FileDatastoreTest.php
diff --git a/tests/Filter/ChainTest.php b/tests/Filter/ChainTest.php
diff --git a/tests/Filter/ContentFilterTest.php b/tests/Filter/ContentFilterTest.php
diff --git a/tests/Logger/ComposerLoggerTest.php b/tests/Logger/ComposerLoggerTest.php
diff --git a/tests/MemoizeClassMapGeneratorTest.php b/tests/MemoizeClassMapGeneratorTest.php
diff --git a/tests/PluginTest.php b/tests/PluginTest.php

Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,8 @@`
`2`	`2`
`3`	`3`	`namespace olvlvl\ComposerAttributeCollector\Filter;`
`4`	`4`
`5`		`-use Composer\IO\IOInterface;`
`6`	`5`	`use olvlvl\ComposerAttributeCollector\Filter;`
	`6`	`+use olvlvl\ComposerAttributeCollector\Logger;`
`7`	`7`
`8`	`8`	`final class Chain implements Filter`
`9`	`9`	`{`
`@@ -15,10 +15,10 @@ public function __construct(`
`15`	`15`	`) {`
`16`	`16`	`}`
`17`	`17`
`18`		`- public function filter(string $filepath, string $class, IOInterface $io): bool`
	`18`	`+ public function filter(string $filepath, string $class, Logger $log): bool`
`19`	`19`	`{`
`20`	`20`	`foreach ($this->filters as $filter) {`
`21`		`- if ($filter->filter($filepath, $class, $io) === false) {`
	`21`	`+ if ($filter->filter($filepath, $class, $log) === false) {`
`22`	`22`	`return false;`
`23`	`23`	`}`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,22 +2,22 @@`
`2`	`2`
`3`	`3`	`namespace olvlvl\ComposerAttributeCollector\Filter;`
`4`	`4`
`5`		`-use Composer\IO\IOInterface;`
`6`	`5`	`use olvlvl\ComposerAttributeCollector\Filter;`
	`6`	`+use olvlvl\ComposerAttributeCollector\Logger;`
`7`	`7`	`use Throwable;`
`8`	`8`
`9`	`9`	`use function interface_exists;`
`10`	`10`
`11`	`11`	`final class InterfaceFilter implements Filter`
`12`	`12`	`{`
`13`		`- public function filter(string $filepath, string $class, IOInterface $io): bool`
	`13`	`+ public function filter(string $filepath, string $class, Logger $log): bool`
`14`	`14`	`{`
`15`	`15`	`try {`
`16`	`16`	`if (interface_exists($class)) {`
`17`	`17`	`return false;`
`18`	`18`	`}`
`19`	`19`	`} catch (Throwable $e) {`
`20`		`- $io->warning("Discarding '$class' because an error occurred during loading: {$e->getMessage()}");`
	`20`	`+ $log->warning("Discarding '$class' because an error occurred during loading: {$e->getMessage()}");`
`21`	`21`
`22`	`22`	`return false;`
`23`	`23`	`}`