Add ExpressionValues

Author: HypeMC

config/services.php

@@ -28,6 +28,7 @@
 use Sofascore\PurgatoryBundle\RouteParamValueResolver\CompoundValuesResolver;
 use Sofascore\PurgatoryBundle\RouteParamValueResolver\DynamicValuesResolver;
 use Sofascore\PurgatoryBundle\RouteParamValueResolver\EnumValuesResolver;
+use Sofascore\PurgatoryBundle\RouteParamValueResolver\ExpressionValuesResolver;
 use Sofascore\PurgatoryBundle\RouteParamValueResolver\PropertyValuesResolver;
 use Sofascore\PurgatoryBundle\RouteParamValueResolver\RawValuesResolver;
 use Sofascore\PurgatoryBundle\RouteProvider\AbstractEntityRouteProvider;
@@ -224,6 +225,12 @@
                 service('sofascore.purgatory.property_accessor'),
             ])
 
+        ->set('sofascore.purgatory.route_parameter_resolver.expression', ExpressionValuesResolver::class)
+            ->tag('purgatory.route_param_value_resolver')
+            ->args([
+                service('sofascore.purgatory.expression_language')->nullOnInvalid(),
+            ])
+
         ->set('sofascore.purgatory.property_accessor', PurgatoryPropertyAccessor::class)
             ->args([
                 service('property_accessor'),

src/Attribute/RouteParamValue/ExpressionValues.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sofascore\PurgatoryBundle\Attribute\RouteParamValue;
+
+use Sofascore\PurgatoryBundle\Exception\LogicException;
+use Symfony\Component\ExpressionLanguage\Expression;
+
+final class ExpressionValues extends AbstractValues
+{
+    private readonly Expression $expression;
+
+    public function __construct(
+        string $expression,
+    ) {
+        $this->expression = self::normalizeExpression($expression);
+    }
+
+    /**
+     * @return array{0: Expression}
+     */
+    public function getValues(): array
+    {
+        return [$this->expression];
+    }
+
+    public static function type(): string
+    {
+        return 'expression';
+    }
+
+    private static function normalizeExpression(string $expression): Expression
+    {
+        if (!class_exists(Expression::class)) {
+            throw new LogicException(\sprintf('You cannot use "%s" because the Symfony ExpressionLanguage component is not installed. Try running "composer require symfony/expression-language".', self::class));
+        }
+
+        return new Expression($expression);
+    }
+}

src/Cache/RouteMetadata/YamlMetadataProvider.php

@@ -8,6 +8,7 @@
 use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\CompoundValues;
 use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\DynamicValues;
 use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\EnumValues;
+use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\ExpressionValues;
 use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\PropertyValues;
 use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\RawValues;
 use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\ValuesInterface;
@@ -182,12 +183,14 @@ private function buildRouteParam(string|array|TaggedValue $routeParam): string|a
             CompoundValues::type() => new CompoundValues(...array_map($this->buildRouteParam(...), $value)),
             DynamicValues::type() => new DynamicValues(...((array) $value)),
             EnumValues::type() => new EnumValues($value),
+            ExpressionValues::type() => new ExpressionValues($value),
             PropertyValues::type() => new PropertyValues(...((array) $value)),
             RawValues::type() => new RawValues(...((array) $value)),
             default => throw new UnknownYamlTagException($tag, [
                 CompoundValues::type(),
                 DynamicValues::type(),
                 EnumValues::type(),
+                ExpressionValues::type(),
                 PropertyValues::type(),
                 RawValues::type(),
             ]),

src/Cache/Subscription/PurgeSubscriptionProvider.php

@@ -6,6 +6,7 @@
 
 use Doctrine\Persistence\ManagerRegistry;
 use Psr\Container\ContainerInterface;
+use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\ExpressionValues;
 use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\PropertyValues;
 use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\ValuesInterface;
 use Sofascore\PurgatoryBundle\Attribute\Target\TargetInterface;
@@ -58,7 +59,7 @@ private function provideFromMetadata(RouteMetadataProviderInterface $routeMetada
             $purgeOn = $routeMetadata->purgeOn;
 
             if (null !== $purgeOn->if) {
-                $this->validateIfExpression($purgeOn->if, $routeMetadata->routeName);
+                $this->validateExpression($purgeOn->if, $routeMetadata->routeName);
             }
 
             // if route parameters are not specified, they are same as path variables
@@ -73,6 +74,11 @@ private function provideFromMetadata(RouteMetadataProviderInterface $routeMetada
                     $routeParams[$pathVariable] = new PropertyValues($pathVariable);
                 }
             } else {
+                foreach ($purgeOn->routeParams as $values) {
+                    if ($values instanceof ExpressionValues) {
+                        $this->validateExpression($values->getValues()[0], $routeMetadata->routeName);
+                    }
+                }
                 $this->validateRouteParams(array_keys($purgeOn->routeParams), $routeMetadata);
                 $routeParams = $purgeOn->routeParams;
             }
@@ -140,7 +146,7 @@ private function validateRouteParams(array $routeParams, RouteMetadata $routeMet
         }
     }
 
-    private function validateIfExpression(Expression $expression, string $routeName): void
+    private function validateExpression(Expression $expression, string $routeName): void
     {
         try {
             $this->expressionLanguage?->lint($expression, ['obj']);

src/RouteParamValueResolver/ExpressionValuesResolver.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sofascore\PurgatoryBundle\RouteParamValueResolver;
+
+use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\ExpressionValues;
+use Sofascore\PurgatoryBundle\Exception\LogicException;
+use Symfony\Component\ExpressionLanguage\Expression;
+use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
+
+/**
+ * @implements ValuesResolverInterface<array{0: Expression}>
+ */
+final class ExpressionValuesResolver implements ValuesResolverInterface
+{
+    public function __construct(
+        private readonly ?ExpressionLanguage $expressionLanguage,
+    ) {
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public static function for(): string
+    {
+        return ExpressionValues::type();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function resolve(array $unresolvedValues, object $entity): array
+    {
+        $expression = $unresolvedValues[0];
+
+        $values = $this->getExpressionLanguage()->evaluate($expression, ['obj' => $entity]);
+
+        return \is_array($values) ? $values : [$values];
+    }
+
+    private function getExpressionLanguage(): ExpressionLanguage
+    {
+        return $this->expressionLanguage
+            ?? throw new LogicException('You cannot use expressions because the Symfony ExpressionLanguage component is not installed. Try running "composer require symfony/expression-language".');
+    }
+}

tests/Cache/RouteMetadata/YamlMetadataProviderTest.php

@@ -255,7 +255,7 @@ public function testExceptionIsThrownForInvalidRoute(): void
     }
 
     #[TestWith(['purge_on_with_unknown_target_tag.yaml', 'Unknown YAML tag "for_unknown" provided, known tags are "for_groups", "for_properties".'])]
-    #[TestWith(['purge_on_with_unknown_route_param_tag.yaml', 'Unknown YAML tag "unknown" provided, known tags are "compound", "dynamic", "enum", "property", "raw".'])]
+    #[TestWith(['purge_on_with_unknown_route_param_tag.yaml', 'Unknown YAML tag "unknown" provided, known tags are "compound", "dynamic", "enum", "expression", "property", "raw".'])]
     public function testExceptionIsThrownForUnknownTags(string $file, string $message): void
     {
         $collection = new RouteCollection();