Use reflection (alt)

Author: olvlvl

CHANGELOG.md

@@ -9,6 +9,7 @@ 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.
+- The plugin can generate a file that uses reflection to create attributes instead of embedding their arguments.
 
 ### Backward Incompatible Changes
 

Dockerfile

@@ -1,5 +1,5 @@
 ARG PHP_VERSION=8.0
-FROM php:${PHP_VERSION}-cli-bookworm
+FROM php:${PHP_VERSION}-cli-buster
 
 RUN <<-EOF
 	docker-php-ext-enable opcache

README.md

@@ -15,7 +15,7 @@ to _discover_ attribute targets in a codebase—for known targets you can use re
 #### Features
 
 - Little configuration
-- No reflection in the generated file
+- No reflection in the generated file (as an option)
 - No impact on performance
 - No dependency (except Composer of course)
 - A single interface to get attribute targets: classes, methods, and properties
@@ -73,28 +73,29 @@ var_dump($attributes->methodsAttributes);
 var_dump($attributes->propertyAttributes);
 ```
 
+> [!NOTE]
+> The plugin supports class, method, and property targets. [Contribute](CONTRIBUTING.md) if you're
+> interested in expending its support.
+
 
 
 ## Getting started
 
 
+
 ### Installation
 
 ```shell
 composer require olvlvl/composer-attribute-collector
 ```
 
-The plugin is currently experimental and its interface subject to change. At the moment, it only
-supports class, method, and property targets. Please [contribute](CONTRIBUTING.md) if you're interested in
-shaping its future.
-
 
 
 ### Sample configuration
 
 The plugin only inspects paths and files specified in the configuration with the direction
-`include`. That's usually your "src" directory. Add this section to your `composer.json` file to
-enable the generation of the attributes file on autoload dump.
+`include`. That is usually your "src" directory. Add this section to your `composer.json` file to
+enable the generation of the "attributes" file on autoload dump.
 
 Check the [Configuration options](#configuration) for more details.
 
@@ -114,7 +115,7 @@ Check the [Configuration options](#configuration) for more details.
 
 ### Autoloading
 
-You can require the attributes file using `require_once 'vendor/attributes.php';` but you might
+You can require the "attributes" file using `require_once 'vendor/attributes.php';` but you might
 prefer using Composer's autoloading feature:
 
 ```json
@@ -134,7 +135,7 @@ prefer using Composer's autoloading feature:
 ### 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.
+property, the "attributes" file will be empty.
 
 The specified paths are relative to the `composer.json` file, and the `{vendor}` placeholder is
 replaced with the path to the vendor folder.
@@ -178,6 +179,35 @@ set the environment variable `COMPOSER_ATTRIBUTE_COLLECTOR_USE_CACHE` to `1`, `y
 Cache items are persisted in the `.composer-attribute-collector` directory, you might want to add
 it to your `.gitignore` file.
 
+```shell
+COMPOSER_ATTRIBUTE_COLLECTOR_USE_CACHE=1 composer dump-autoload
+```
+
+### Use reflection
+
+> [!NOTE]
+> New in v2.1
+
+By default, the "attributes" file embeds arguments to instantiate attributes without using
+reflection. This can cause issues when the arguments are sophisticated types that don't support var
+export. Alternatively, attributes can be instantiated using reflection.
+
+The API remains the same whether reflections are used or not. You can safely switch between modes
+and see what works best for you.
+
+Use the `use-reflection` property for the "attributes" file to use reflection.
+
+```json
+{
+  "extra": {
+    "composer-attribute-collector": {
+      "use-reflection": true
+    }
+  }
+}
+```
+
+
 
 
 ## Test drive with the Symfony Demo
@@ -261,9 +291,9 @@ to Composer to find classes. Anything that works with Composer should work with
 
 **Can I use the plugin during development?**
 
-Yes, you can use the plugin during development, but keep in mind the attributes file is only
-generated after the autoloader is dumped. If you modify attributes you'll have to run
-`composer dump` to refresh the attributes file.
+Yes, you can use the plugin during development, but keep in mind the "attributes" file is only
+generated after the autoloader is dumped. If you modify attributes you will have to run
+`composer dump` to refresh the "attributes" file.
 
 As a workaround you could have watchers on the directories that contain classes with attributes to
 run `XDEBUG_MODE=off composer dump` when you make changes. [PhpStorm offers file watchers][phpstorm-watchers].

composer.json

@@ -35,7 +35,7 @@
   },
   "require-dev": {
     "composer/composer": ">=2.4",
-    "phpstan/phpstan": "^1.9",
+    "phpstan/phpstan": "^2.0",
     "phpunit/phpunit": "^9.5"
   },
   "extra": {

phpcs.xml

@@ -18,6 +18,8 @@
         <exclude-pattern>tests/bootstrap.php</exclude-pattern>
     </rule>
     <rule ref="Generic.Files.LineLength.TooLong">
+        <exclude-pattern>src/Static/TransientCollectionRenderer.php</exclude-pattern>
+        <exclude-pattern>src/Reflexive/TransientCollectionRenderer.php</exclude-pattern>
         <exclude-pattern>tests/*</exclude-pattern>
     </rule>
     <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">

phpstan.neon

@@ -2,6 +2,6 @@
 parameters:
   bootstrapFiles:
     - tests/bootstrap.php
-  level: max
+  level: 9
   paths:
     - src

src/Attributes.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 olvlvl\ComposerAttributeCollector;
 
 use Closure;

src/ClassAttributeCollector.php

@@ -13,8 +13,14 @@
  */
 class ClassAttributeCollector
 {
+    /**
+     * @param bool $ignoreArguments
+     *     Attribute arguments aren't used when generating a file that uses reflection.
+     *     Setting `$ignoreArguments` to `true` ignores arguments during the attribute collection.
+     */
     public function __construct(
         private IOInterface $io,
+        private bool $ignoreArguments,
     ) {
     }
 
@@ -26,8 +32,6 @@ public function __construct(
      *     array<TransientTargetMethod>,
      *     array<TransientTargetProperty>,
      * }
-     *     Where `0` is an array of class attributes, `1` is an array of method attributes,
-     *     and `2` is an array of property attributes.
      *
      * @throws ReflectionException
      */
@@ -51,7 +55,7 @@ public function collectAttributes(string $class): array
 
             $classAttributes[] = new TransientTargetClass(
                 $attribute->getName(),
-                $attribute->getArguments(),
+                $this->getArguments($attribute),
             );
         }
 
@@ -64,13 +68,12 @@ public function collectAttributes(string $class): array
                 }
 
                 $method = $methodReflection->name;
-                assert($method !== '');
 
                 $this->io->debug("Found attribute {$attribute->getName()} on $class::$method");
 
                 $methodAttributes[] = new TransientTargetMethod(
                     $attribute->getName(),
-                    $attribute->getArguments(),
+                    $this->getArguments($attribute),
                     $method,
                 );
             }
@@ -91,7 +94,7 @@ public function collectAttributes(string $class): array
 
                 $propertyAttributes[] = new TransientTargetProperty(
                     $attribute->getName(),
-                    $attribute->getArguments(),
+                    $this->getArguments($attribute),
                     $property,
                 );
             }
@@ -128,4 +131,18 @@ private static function isAttributeIgnored(ReflectionAttribute $attribute): bool
 
         return isset($ignored[$attribute->getName()]);
     }
+
+    /**
+     * @param ReflectionAttribute<object> $attribute
+     *
+     * @return array<string, mixed>
+     */
+    private function getArguments(ReflectionAttribute $attribute): array
+    {
+        if ($this->ignoreArguments) {
+            return [];
+        }
+
+        return $attribute->getArguments();
+    }
 }