make callback field compatible with yaml config

Author: Florian-Merle

docs/field_types.md

@@ -326,8 +326,34 @@ Callback
 The Callback column aims to offer almost as much flexibility as the Twig column, but without requiring the creation of a template.
 You simply need to specify a callback, which allows you to transform the 'data' variable on the fly.
 
-By default it uses the name of the field, but you can specify the path
-alternatively. For example:
+When defining callbacks in YAML, only string representations of callables are supported.
+When configuring grids using PHP (as opposed to service grid configuration), both string and array callables are supported. However, closures cannot be used due to restrictions in Symfony's configuration (values of type "Closure" are not permitted in service configuration files).
+By contrast, when configuring grids with service definitions, you can use both callables and closures.
+
+Here are some examples of what you can do:
+
+<details open><summary>Yaml</summary>
+
+```yaml
+# config/packages/sylius_grid.yaml
+
+sylius_grid:
+    grids:
+        app_user:
+            fields:
+                id:
+                    type: callback
+                    options:
+                        callback: "callback:App\\Helper\\GridHelper::addHashPrefix"
+                    label: app.ui.id
+                name:
+                    type: callback
+                    options:
+                        callback: "callback:strtoupper"
+                    label: app.ui.name
+```
+
+</details>
 
 <details open><summary>PHP</summary>
 
@@ -342,14 +368,18 @@ use Sylius\Bundle\GridBundle\Config\GridConfig;
 return static function (GridConfig $grid): void {
     $grid->addGrid(GridBuilder::create('app_user', '%app.model.user.class%')
         ->addField(
-            CallbackField::create('roles' fn (array $roles): string => implode(', ', $roles))
-                ->setLabel('app.ui.roles') // # each filed type can have a label, we suggest using translation keys instead of messages
-                ->setPath('roles')
+            CallbackField::create('id', 'App\\Helper\\GridHelper::addHashPrefix')
+                ->setLabel('app.ui.id')
         )
+        // or
         ->addField(
-            CallbackField::create('status' fn (array $status): string => "<strong>$status</strong>", false) // the third argument allows to disable htmlspecialchars if set to false
-                ->setLabel('app.ui.status') // # each filed type can have a label, we suggest using translation keys instead of messages
-                ->setPath('status')
+            CallbackField::create('id', ['App\\Helper\\GridHelper', 'addHashPrefix'])
+                ->setLabel('app.ui.id')
+        )
+
+        ->addField(
+            CallbackField::create('name', 'strtoupper')
+                ->setLabel('app.ui.name')
         )
     )
 };
@@ -382,14 +412,16 @@ final class UserGrid extends AbstractGrid implements ResourceAwareGridInterface
     {
         $gridBuilder
             ->addField(
-                CallbackField::create('roles' fn (array $roles): string => implode(', ', $roles))
-                    ->setLabel('app.ui.roles') // # each filed type can have a label, we suggest using translation keys instead of messages
-                    ->setPath('roles')
+                CallbackField::create('id', GridHelper::addHashPrefix(...))
+                    ->setLabel('app.ui.id')
             )
             ->addField(
-                CallbackField::create('status' fn (array $status): string => "<strong>$status</strong>", false) // the third argument allows to disable htmlspecialchars if set to false
-                    ->setLabel('app.ui.status') // # each filed type can have a label, we suggest using translation keys instead of messages
-                    ->setPath('status')
+                CallbackField::create('name', 'strtoupper')
+                    ->setLabel('app.ui.name')
+            )
+            ->addField(
+                CallbackField::create('roles' fn (array $roles): string => implode(', ', $roles))
+                    ->setLabel('app.ui.roles')
             )
         ;
     }
@@ -402,6 +434,3 @@ final class UserGrid extends AbstractGrid implements ResourceAwareGridInterface
 ```
 
 </details>
-
-This configuration will display each role of a customer separated with a comma.
-

src/Bundle/Parser/OptionsParser.php

@@ -0,0 +1,63 @@
+<?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\Parser;
+
+final class OptionsParser implements OptionsParserInterface
+{
+    public function parseOptions(array $parameters): array
+    {
+        return array_map(
+            /**
+             * @param mixed $parameter
+             *
+             * @return mixed
+             */
+            function ($parameter) {
+                if (is_array($parameter)) {
+                    return $this->parseOptions($parameter);
+                }
+
+                return $this->parseOption($parameter);
+            },
+            $parameters,
+        );
+    }
+
+    /**
+     * @param mixed $parameter
+     *
+     * @return mixed
+     */
+    private function parseOption($parameter)
+    {
+        if (!is_string($parameter)) {
+            return $parameter;
+        }
+
+        if (0 === strpos($parameter, 'callback:')) {
+            return $this->parseOptionCallback(substr($parameter, 9));
+        }
+
+        return $parameter;
+    }
+
+    private function parseOptionCallback(string $callback): \Closure
+    {
+        if (!is_callable($callback)) {
+            throw new \RuntimeException(\sprintf('%s is not a callable.', $callback));
+        }
+
+        return $callback(...);
+    }
+}

src/Bundle/Parser/OptionsParserInterface.php

@@ -0,0 +1,19 @@
+<?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\Parser;
+
+interface OptionsParserInterface
+{
+    public function parseOptions(array $parameters): array;
+}

src/Bundle/Renderer/TwigGridRenderer.php

@@ -14,6 +14,7 @@
 namespace Sylius\Bundle\GridBundle\Renderer;
 
 use Sylius\Bundle\GridBundle\Form\Registry\FormTypeRegistryInterface;
+use Sylius\Bundle\GridBundle\Parser\OptionsParserInterface;
 use Sylius\Component\Grid\Definition\Action;
 use Sylius\Component\Grid\Definition\Field;
 use Sylius\Component\Grid\Definition\Filter;
@@ -36,6 +37,8 @@ final class TwigGridRenderer implements GridRendererInterface
 
     private FormTypeRegistryInterface $formTypeRegistry;
 
+    private OptionsParserInterface $optionsParser;
+
     private string $defaultTemplate;
 
     private array $actionTemplates;
@@ -47,6 +50,7 @@ public function __construct(
         ServiceRegistryInterface $fieldsRegistry,
         FormFactoryInterface $formFactory,
         FormTypeRegistryInterface $formTypeRegistry,
+        OptionsParserInterface $optionsParser,
         string $defaultTemplate,
         array $actionTemplates = [],
         array $filterTemplates = [],
@@ -55,6 +59,7 @@ public function __construct(
         $this->fieldsRegistry = $fieldsRegistry;
         $this->formFactory = $formFactory;
         $this->formTypeRegistry = $formTypeRegistry;
+        $this->optionsParser = $optionsParser;
         $this->defaultTemplate = $defaultTemplate;
         $this->actionTemplates = $actionTemplates;
         $this->filterTemplates = $filterTemplates;
@@ -71,7 +76,8 @@ public function renderField(GridViewInterface $gridView, Field $field, $data)
         $fieldType = $this->fieldsRegistry->get($field->getType());
         $resolver = new OptionsResolver();
         $fieldType->configureOptions($resolver);
-        $options = $resolver->resolve($field->getOptions());
+
+        $options = $resolver->resolve($this->optionsParser->parseOptions($field->getOptions()));
 
         return $fieldType->render($field, $data, $options);
     }

src/Bundle/Resources/config/services.xml

@@ -128,5 +128,8 @@
             <tag name="maker.command" />
         </service>
         <service id="Sylius\Bundle\GridBundle\Maker\MakeGrid" alias="sylius.grid.maker" />
+
+        <service id="sylius.grid.options_parser" class="Sylius\Bundle\GridBundle\Parser\OptionsParser" />
+        <service id="Sylius\Bundle\GridBundle\Parser\OptionsParserInterface" alias="sylius.grid.options_parser" />
     </services>
 </container>

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

@@ -20,6 +20,7 @@
             <argument type="service" id="sylius.registry.grid_field" />
             <argument type="service" id="form.factory" />
             <argument type="service" id="sylius.form_registry.grid_filter" />
+            <argument type="service" id="sylius.grid.options_parser" />
             <argument>@SyliusGrid/_grid.html.twig</argument>
             <argument>%sylius.grid.templates.action%</argument>
             <argument>%sylius.grid.templates.filter%</argument>

src/Bundle/Tests/Functional/GridUiTest.php

@@ -41,6 +41,20 @@ public function it_shows_authors_grid(): void
         $this->assertCount(10, $this->getAuthorNamesFromResponse());
     }
 
+    /** @test */
+    public function it_shows_authors_ids(): void
+    {
+        $this->client->request('GET', '/authors/?limit=100');
+
+        $ids = $this->getAuthorIdsFromResponse();
+
+        $this->assertNotEmpty($ids);
+        $this->assertSame(
+            array_filter($ids, fn (string $id) => str_starts_with($id, '#')),
+            $ids,
+        );
+    }
+
     /** @test */
     public function it_sorts_authors_by_name_ascending_by_default(): void
     {
@@ -98,7 +112,7 @@ public function it_filters_books_by_title(): void
         $titles = $this->getBookTitlesFromResponse();
 
         $this->assertCount(1, $titles);
-        $this->assertSame('Book 5', $titles[0]);
+        $this->assertSame('BOOK 5', $titles[0]);
     }
 
     /** @test */
@@ -112,7 +126,7 @@ public function it_filters_books_by_title_with_contains(): void
         $titles = $this->getBookTitlesFromResponse();
 
         $this->assertCount(1, $titles);
-        $this->assertSame('Jurassic Park', $titles[0]);
+        $this->assertSame('JURASSIC PARK', $titles[0]);
     }
 
     /** @test */
@@ -125,7 +139,7 @@ public function it_filters_books_by_author(): void
         $titles = $this->getBookTitlesFromResponse();
 
         $this->assertCount(2, $titles);
-        $this->assertSame('Jurassic Park', $titles[0]);
+        $this->assertSame('JURASSIC PARK', $titles[0]);
     }
 
     /** @test */
@@ -139,7 +153,7 @@ public function it_filters_books_by_authors(): void
         $titles = $this->getBookTitlesFromResponse();
 
         $this->assertCount(3, $titles);
-        $this->assertSame('A Study in Scarlet', $titles[0]);
+        $this->assertSame('A STUDY IN SCARLET', $titles[0]);
     }
 
     /** @test */
@@ -152,7 +166,7 @@ public function it_filters_books_by_authors_nationality(): void
         $titles = $this->getBookTitlesFromResponse();
 
         $this->assertCount(2, $titles);
-        $this->assertSame('Jurassic Park', $titles[0]);
+        $this->assertSame('JURASSIC PARK', $titles[0]);
     }
 
     /** @test */
@@ -165,7 +179,7 @@ public function it_filters_books_by_author_and_currency(): void
         $titles = $this->getBookTitlesFromResponse();
 
         $this->assertCount(1, $titles);
-        $this->assertSame('Jurassic Park', $titles[0]);
+        $this->assertSame('JURASSIC PARK', $titles[0]);
     }
 
     /** @test */
@@ -274,6 +288,16 @@ private function getBookAuthorNationalitiesFromResponse(): array
             );
     }
 
+    /** @return string[] */
+    private function getAuthorIdsFromResponse(): array
+    {
+        return $this->getCrawler()
+            ->filter('[data-test-id]')
+            ->each(
+                fn (Crawler $node): string => $node->text(),
+            );
+    }
+
     /** @return string[] */
     private function getAuthorNamesFromResponse(): array
     {

src/Bundle/spec/Parser/OptionsParserSpec.php

@@ -0,0 +1,70 @@
+<?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\Bundle\GridBundle\Parser;
+
+use PhpSpec\ObjectBehavior;
+use Sylius\Bundle\GridBundle\Parser\OptionsParserInterface;
+
+final class OptionsParserSpec extends ObjectBehavior
+{
+    function it_is_an_options_parser(): void
+    {
+        $this->shouldImplement(OptionsParserInterface::class);
+    }
+
+    function it_parses_options_with_callback(): void
+    {
+        $this
+            ->parseOptions([
+                'type' => 'callback',
+                'option' => [
+                    'callback' => 'callback:App\\Helper\\GridHelper::addHashPrefix',
+                ],
+                'label' => 'app.ui.id',
+            ])
+            ->shouldBeAValidConfig([
+                'type' => 'callback',
+                'option' => [],
+                'label' => 'app.ui.id',
+            ])
+        ;
+    }
+
+    public function getMatchers(): array
+    {
+        return [
+            'beAValidConfig' => function ($subject, $subset) {
+                if ([] !== array_diff($subject, $subset)) {
+                    return false;
+                }
+
+                return is_callable($subject['option']['callback'] ?? null);
+            },
+        ];
+    }
+
+    function it_fails_while_parsing_options_with_invalid_callback(): void
+    {
+        $this
+            ->shouldThrow(\RuntimeException::class)
+            ->during('parseOptions', [[
+                'type' => 'callback',
+                'option' => [
+                    'callback' => 'callback:foobar',
+                ],
+                'label' => 'app.ui.id',
+            ]])
+        ;
+    }
+}