add expression field

Author: Florian-Merle

docs/field_types.md

@@ -319,3 +319,82 @@ $field->setOptions([
     // Your options here
 ]);
 ```
+
+Expression
+----------
+
+The **Expression** column provides flexibility by allowing you to specify an expression that will be evaluated on the fly.
+This feature uses Symfony's expression language, making it versatile and powerful without needing to create additional callbacks or templates.
+
+The expression will be evaluated with the following context:
+
+- `value`: The value of the row.
+- `container`: The Symfony container (only if the `container` option is enabled).
+
+You can also control whether special characters in the output are escaped by setting the `htmlspecialchars` option.
+By default, this is enabled, but you can disable it if the output contains HTML elements that should render as HTML.
+
+<details open><summary>Yaml</summary>
+
+```yaml
+# config/packages/sylius_grid.yaml
+
+sylius_grid:
+    grids:
+        app_user:
+            fields:
+                price:
+                    type: expression
+                    label: app.ui.price
+                    options:
+                        expression: 'value ~ "$"'
+
+                role:
+                    type: expression
+                    label: app.ui.price
+                    options:
+                        expression: '"<strong>" ~ value ~ "</strong>"'
+                        htmlspecialchars: false
+
+                most_exensive_order_total:
+                    type: expression
+                    label: app.ui.most_exensive_order_total
+                    options:
+                        expression: 'container.get("sylius.repository.order").findMostExpensiveOrder(value).getTotal()'
+                        needContainer: true
+```
+
+</details>
+
+
+<details open><summary>PHP</summary>
+<?php
+// config/packages/sylius_grid.php
+
+use Sylius\Bundle\GridBundle\Builder\Field\ExpressionField;
+use Sylius\Bundle\GridBundle\Builder\GridBuilder;
+use Sylius\Bundle\GridBundle\Config\GridConfig;
+
+return static function (GridConfig $grid): void {
+    $grid->addGrid(GridBuilder::create('app_user', '%app.model.user.class%')
+            ->addField(
+                ExpressionField::create('price', 'value ~ "$"')
+                    ->setLabel('app.ui.price')
+            )
+            ->addField(
+                ExpressionField::create('role', '"<strong>" ~ value ~ "</strong>"', htmlspecialchars: false)
+                    ->setLabel('app.ui.role')
+            )
+            ->addField(
+                ExpressionField::create(
+                    'most_expensive_order_total',
+                    'container.get("sylius.repository.order").findMostExpensiveOrder(value).getTotal()',
+                    needContainer: true,
+                )
+                    ->setLabel('app.ui.most_exensive_order_total')
+            )
+    );
+};
+```
+
+</details>

src/Bundle/Builder/Field/ExpressionField.php

@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\GridBundle\Builder\Field;
+
+final class ExpressionField
+{
+    public static function create(
+        string $name,
+        string $expression,
+        bool $needsContainer = false,
+        bool $htmlspecialchars = true,
+    ): FieldInterface
+    {
+        return Field::create($name, 'expression')
+            ->setOption('expression', $expression)
+            ->setOption('needsContainer', $needsContainer)
+            ->setOption('htmlspecialchars', $htmlspecialchars)
+        ;
+    }
+}

src/Bundle/Resources/config/services/field_types.xml

@@ -22,6 +22,14 @@
         </service>
         <service id="sylius.grid_field.datetime" alias="Sylius\Component\Grid\FieldTypes\DatetimeFieldType" />
 
+        <service id="Sylius\Component\Grid\FieldTypes\ExpressionFieldType">
+            <argument type="service" id="sylius.grid.data_extractor" />
+            <argument type="service" id="sylius.expression_language" />
+            <argument type="service" id="service_container" />
+            <tag name="sylius.grid_field" type="expression" />
+        </service>
+        <service id="sylius.grid_field.expression" alias="Sylius\Component\Grid\FieldTypes\ExpressionFieldType" />
+
         <service id="Sylius\Component\Grid\FieldTypes\StringFieldType">
             <argument type="service" id="sylius.grid.data_extractor" />
             <tag name="sylius.grid_field" type="string" />

src/Component/FieldTypes/ExpressionFieldType.php

@@ -0,0 +1,64 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Component\Grid\FieldTypes;
+
+use Sylius\Bundle\ResourceBundle\ExpressionLanguage\ExpressionLanguage;
+use Sylius\Component\Grid\DataExtractor\DataExtractorInterface;
+use Sylius\Component\Grid\Definition\Field;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+final class ExpressionFieldType implements FieldTypeInterface
+{
+    public function __construct(
+        private DataExtractorInterface $dataExtractor,
+        private ExpressionLanguage $expressionLanguage,
+        private ContainerInterface $container,
+    )
+    {
+    }
+
+    public function render(Field $field, $data, array $options): string
+    {
+        $values = [
+            'value' => $this->dataExtractor->get($field, $data),
+        ];
+
+        if ($options['needsContainer'] === true) {
+            $values = array_merge($values, [
+                'container' => $this->container,
+            ]);
+        }
+
+        $value = (string) $this->expressionLanguage->evaluate($options['expression'], $values);
+
+        if ($options['htmlspecialchars']) {
+            $value = htmlspecialchars($value);
+        }
+
+        return $value;
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setRequired('expression');
+        $resolver->setAllowedTypes('expression', 'string');
+
+        $resolver->setDefault('needsContainer', false);
+        $resolver->setAllowedTypes('needsContainer', 'bool');
+
+        $resolver->setDefault('htmlspecialchars', true);
+        $resolver->setAllowedTypes('htmlspecialchars', 'bool');
+    }
+}

src/Component/spec/FieldTypes/ExpressionFieldTypeSpec.php

@@ -0,0 +1,65 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace spec\Sylius\Component\Grid\FieldTypes;
+
+use PhpSpec\ObjectBehavior;
+use Sylius\Bundle\ResourceBundle\ExpressionLanguage\ExpressionLanguage;
+use Sylius\Component\Grid\DataExtractor\DataExtractorInterface;
+use Sylius\Component\Grid\Definition\Field;
+use Sylius\Component\Grid\FieldTypes\FieldTypeInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+final class ExpressionFieldTypeSpec extends ObjectBehavior
+{
+    function let(
+        DataExtractorInterface $dataExtractor,
+        ContainerInterface $container,
+    ): void
+    {
+        $this->beConstructedWith(
+            $dataExtractor,
+            new ExpressionLanguage(),
+            $container,
+        );
+    }
+
+    function it_is_a_grid_field_type(): void
+    {
+        $this->shouldImplement(FieldTypeInterface::class);
+    }
+
+    function it_uses_data_extractor_to_obtain_data_and_evaluates_it_with_htmlspecialchars(
+        DataExtractorInterface $dataExtractor,
+        Field $field,
+    ): void {
+        $dataExtractor->get($field, ['foo' => 5])->willReturn(5);
+
+        $this->render($field, ['foo' => 5], [
+            'expression' => '"<strong>" ~ value * 100 ~ "$</strong>"',
+            'htmlspecialchars' => true,
+        ])->shouldReturn('&lt;strong&gt;500$&lt;/strong&gt;');
+    }
+
+    function it_uses_data_extractor_to_obtain_data_and_evaluates_it_without_htmlspecialchars(
+        DataExtractorInterface $dataExtractor,
+        Field $field,
+    ): void {
+        $dataExtractor->get($field, ['foo' => 5])->willReturn(5);
+
+        $this->render($field, ['foo' => 5], [
+            'expression' => '"<strong>" ~ value * 100 ~ "$</strong>"',
+            'htmlspecialchars' => false,
+        ])->shouldReturn('<strong>500$</strong>');
+    }
+}