From 5dbc93d5e2a6eec55a6c334a8a5c79db29adcd3e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=A9my=20DECOOL?= <contact@jdecool.fr>
Date: Fri, 26 Jul 2024 21:16:04 +0200
Subject: [PATCH] Load constants from AsTwigConstant attribute

---
 composer.json                                       |  1 +
 src/Accessor/ConstantResolver.php                   |  4 ++--
 src/Attribute/AsTwigConstant.php                    | 13 +++++++++++++
 .../TwigConstantAccessorExtension.php               |  8 +++++++-
 tests/Fixtures/AttributeConstant.php                | 12 ++++++++++++
 tests/Fixtures/ConstantAccessFunctionalTest.php     |  1 +
 tests/Fixtures/Resources/views/index.html.twig      |  4 ++++
 tests/Fixtures/TemplateKernel.php                   |  2 +-
 8 files changed, 41 insertions(+), 4 deletions(-)
 create mode 100644 src/Attribute/AsTwigConstant.php
 create mode 100644 tests/Fixtures/AttributeConstant.php

diff --git a/composer.json b/composer.json
index 5c5fad3..7235150 100644
--- a/composer.json
+++ b/composer.json
@@ -18,6 +18,7 @@
     "homepage": "http://github.com/jdecool/TwigConstantAccessorBundle",
     "require": {
         "php": "^8.1",
+        "kcs/class-finder": "^0.5.0",
         "symfony/dependency-injection": "^5.4 || ^6.4 || ^7.0",
         "symfony/framework-bundle": "^5.4 || ^6.4 || ^7.0",
         "symfony/twig-bundle": "^5.4 || ^6.4 || ^7.0",
diff --git a/src/Accessor/ConstantResolver.php b/src/Accessor/ConstantResolver.php
index f3894dd..205f328 100644
--- a/src/Accessor/ConstantResolver.php
+++ b/src/Accessor/ConstantResolver.php
@@ -8,11 +8,11 @@
 class ConstantResolver
 {
     /**
-     * @param list<ConstantConfiguration> $classes
+     * @param iterable<ConstantConfiguration> $classes
      *
      * @return array<string, mixed>
      */
-    public function fromClassList(array $classes): array
+    public function fromClassList(iterable $classes): array
     {
         $constants = [];
 
diff --git a/src/Attribute/AsTwigConstant.php b/src/Attribute/AsTwigConstant.php
new file mode 100644
index 0000000..786a9f5
--- /dev/null
+++ b/src/Attribute/AsTwigConstant.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace JDecool\Bundle\TwigConstantAccessorBundle\Attribute;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+final class AsTwigConstant
+{
+    public function __construct(
+        public readonly ?string $alias = null,
+        public readonly ?string $matches = null,
+    ) {
+    }
+}
diff --git a/src/DependencyInjection/TwigConstantAccessorExtension.php b/src/DependencyInjection/TwigConstantAccessorExtension.php
index 4d5c89d..f54b828 100644
--- a/src/DependencyInjection/TwigConstantAccessorExtension.php
+++ b/src/DependencyInjection/TwigConstantAccessorExtension.php
@@ -3,7 +3,9 @@
 namespace JDecool\Bundle\TwigConstantAccessorBundle\DependencyInjection;
 
 use JDecool\Bundle\TwigConstantAccessorBundle\Accessor\ConstantResolver;
+use JDecool\Bundle\TwigConstantAccessorBundle\Attribute\AsTwigConstant;
 use JDecool\Bundle\TwigConstantAccessorBundle\Twig\ConstantExtension;
+use Kcs\ClassFinder\Finder\ComposerFinder;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Extension\Extension;
@@ -23,8 +25,12 @@ public function load(array $configs, ContainerBuilder $container): void
 
     private function resolveConstants(array $config): array
     {
+        $finder = new ComposerFinder();
         $resolver = new ConstantResolver();
 
-        return $resolver->fromClassList($config['classes']);
+        return array_merge(
+            $resolver->fromClassList($config['classes']),
+            $resolver->fromClassList($finder->withAttribute(AsTwigConstant::class)),
+        );
     }
 }
diff --git a/tests/Fixtures/AttributeConstant.php b/tests/Fixtures/AttributeConstant.php
new file mode 100644
index 0000000..2021598
--- /dev/null
+++ b/tests/Fixtures/AttributeConstant.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace Fixtures;
+
+use JDecool\Bundle\TwigConstantAccessorBundle\Attribute\AsTwigConstant;
+
+#[AsTwigConstant]
+class AttributeConstant
+{
+    public const FROM_ATTRIBUTE_1 = 'from_attribute_1';
+    public const FROM_ATTRIBUTE_2 = 'from_attribute_2';
+}
diff --git a/tests/Fixtures/ConstantAccessFunctionalTest.php b/tests/Fixtures/ConstantAccessFunctionalTest.php
index c492747..802c3af 100644
--- a/tests/Fixtures/ConstantAccessFunctionalTest.php
+++ b/tests/Fixtures/ConstantAccessFunctionalTest.php
@@ -32,6 +32,7 @@ public function testConstantsAreAccessibleInView(): void
         $content = $this->render('index.html.twig');
 
         $this->assertStringContainsString('my_constant.my_constant_value', $content);
+        $this->assertStringContainsString('from_attribute_1', $content);
     }
 
     private function render(string $template): string
diff --git a/tests/Fixtures/Resources/views/index.html.twig b/tests/Fixtures/Resources/views/index.html.twig
index fd9cf31..6a98963 100644
--- a/tests/Fixtures/Resources/views/index.html.twig
+++ b/tests/Fixtures/Resources/views/index.html.twig
@@ -1 +1,5 @@
+{# From `class` configuration #}
 {{ MyConstant.MY_CONSTANT_VALUE }}
+
+{# From Fixtures\AttributeConstant class registered with AsTwigConstant attribute #}
+{{ AttributeConstant.FROM_ATTRIBUTE_1 }}
diff --git a/tests/Fixtures/TemplateKernel.php b/tests/Fixtures/TemplateKernel.php
index 3a9a1ec..c1e8c5a 100644
--- a/tests/Fixtures/TemplateKernel.php
+++ b/tests/Fixtures/TemplateKernel.php
@@ -61,6 +61,6 @@ public function getLogDir(): string
 
     public function getBasePath(): string
     {
-        return sprintf('%s/%s/TemplateKernel', sys_get_temp_dir(), Kernel::VERSION);
+        return sprintf('%s/TwigConstantAccessor/%s/TemplateKernel', sys_get_temp_dir(), Kernel::VERSION);
     }
 }