refactor callback into callable

Author: Florian-Merle

docs/field_types.md

@@ -320,13 +320,13 @@ $field->setOptions([
 ]);
 ```
 
-Callback
+Callable
 --------
 
-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.
+The Callable 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 callable, which allows you to transform the 'data' variable on the fly.
 
-When defining callbacks in YAML, only string representations of callables are supported.
+When defining callables 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.
 
@@ -342,14 +342,14 @@ sylius_grid:
         app_user:
             fields:
                 id:
-                    type: callback
+                    type: callable
                     options:
-                        callback: "callback:App\\Helper\\GridHelper::addHashPrefix"
+                        callable: "callable:App\\Helper\\GridHelper::addHashPrefix"
                     label: app.ui.id
                 name:
-                    type: callback
+                    type: callable
                     options:
-                        callback: "callback:strtoupper"
+                        callable: "callable:strtoupper"
                     label: app.ui.name
 ```
 
@@ -361,24 +361,24 @@ sylius_grid:
 <?php
 // config/packages/sylius_grid.php
 
-use Sylius\Bundle\GridBundle\Builder\Field\CallbackField;
+use Sylius\Bundle\GridBundle\Builder\Field\CallableField;
 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(
-            CallbackField::create('id', 'App\\Helper\\GridHelper::addHashPrefix')
+            CallableField::create('id', 'App\\Helper\\GridHelper::addHashPrefix')
                 ->setLabel('app.ui.id')
         )
         // or
         ->addField(
-            CallbackField::create('id', ['App\\Helper\\GridHelper', 'addHashPrefix'])
+            CallableField::create('id', ['App\\Helper\\GridHelper', 'addHashPrefix'])
                 ->setLabel('app.ui.id')
         )
 
         ->addField(
-            CallbackField::create('name', 'strtoupper')
+            CallableField::create('name', 'strtoupper')
                 ->setLabel('app.ui.name')
         )
     )
@@ -396,7 +396,7 @@ declare(strict_types=1);
 namespace App\Grid;
 
 use App\Entity\User;
-use Sylius\Bundle\GridBundle\Builder\Field\CallbackField;
+use Sylius\Bundle\GridBundle\Builder\Field\CallableField;
 use Sylius\Bundle\GridBundle\Builder\GridBuilderInterface;
 use Sylius\Bundle\GridBundle\Grid\AbstractGrid;
 use Sylius\Bundle\GridBundle\Grid\ResourceAwareGridInterface;
@@ -412,15 +412,15 @@ final class UserGrid extends AbstractGrid implements ResourceAwareGridInterface
     {
         $gridBuilder
             ->addField(
-                CallbackField::create('id', GridHelper::addHashPrefix(...))
+                CallableField::create('id', GridHelper::addHashPrefix(...))
                     ->setLabel('app.ui.id')
             )
             ->addField(
-                CallbackField::create('name', 'strtoupper')
+                CallableField::create('name', 'strtoupper')
                     ->setLabel('app.ui.name')
             )
             ->addField(
-                CallbackField::create('roles' fn (array $roles): string => implode(', ', $roles))
+                CallableField::create('roles' fn (array $roles): string => implode(', ', $roles))
                     ->setLabel('app.ui.roles')
             )
         ;

…c/Bundle/Builder/Field/CallbackField.php …c/Bundle/Builder/Field/CallableField.phpsrc/Bundle/Builder/Field/CallbackField.php renamed to src/Bundle/Builder/Field/CallableField.php src/Bundle/Builder/Field/CallbackField.php renamed to src/Bundle/Builder/Field/CallableField.php

@@ -13,12 +13,12 @@
 
 namespace Sylius\Bundle\GridBundle\Builder\Field;
 
-final class CallbackField
+final class CallableField
 {
-    public static function create(string $name, callable $callback, bool $htmlspecialchars = true): FieldInterface
+    public static function create(string $name, callable $callable, bool $htmlspecialchars = true): FieldInterface
     {
-        return Field::create($name, 'callback')
-            ->setOption('callback', $callback)
+        return Field::create($name, 'callable')
+            ->setOption('callable', $callable)
             ->setOption('htmlspecialchars', $htmlspecialchars)
         ;
     }

src/Bundle/Parser/OptionsParser.php

@@ -45,19 +45,19 @@ private function parseOption($parameter)
             return $parameter;
         }
 
-        if (0 === strpos($parameter, 'callback:')) {
-            return $this->parseOptionCallback(substr($parameter, 9));
+        if (0 === strpos($parameter, 'callable:')) {
+            return $this->parseOptionCallable(substr($parameter, 9));
         }
 
         return $parameter;
     }
 
-    private function parseOptionCallback(string $callback): \Closure
+    private function parseOptionCallable(string $callable): \Closure
     {
-        if (!is_callable($callback)) {
-            throw new \RuntimeException(\sprintf('%s is not a callable.', $callback));
+        if (!is_callable($callable)) {
+            throw new \RuntimeException(\sprintf('%s is not a callable.', $callable));
         }
 
-        return $callback(...);
+        return $callable(...);
     }
 }

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

@@ -15,11 +15,11 @@
     <services>
         <defaults public="true" />
 
-        <service id="sylius.grid_field.callback" class="Sylius\Component\Grid\FieldTypes\CallbackFieldType">
+        <service id="sylius.grid_field.callable" class="Sylius\Component\Grid\FieldTypes\CallableFieldType">
             <argument type="service" id="sylius.grid.data_extractor" />
-            <tag name="sylius.grid_field" type="callback" />
+            <tag name="sylius.grid_field" type="callable" />
         </service>
-        <service id="Sylius\Component\Grid\FieldTypes\CallbackFieldType" alias="sylius.grid_field.callback" />
+        <service id="Sylius\Component\Grid\FieldTypes\CallableFieldType" alias="sylius.grid_field.callable" />
 
         <service id="sylius.grid_field.datetime" class="Sylius\Component\Grid\FieldTypes\DatetimeFieldType">
             <argument type="service" id="sylius.grid.data_extractor" />

src/Bundle/spec/Parser/OptionsParserSpec.php

@@ -23,18 +23,18 @@ function it_is_an_options_parser(): void
         $this->shouldImplement(OptionsParserInterface::class);
     }
 
-    function it_parses_options_with_callback(): void
+    function it_parses_options_with_callable(): void
     {
         $this
             ->parseOptions([
-                'type' => 'callback',
+                'type' => 'callable',
                 'option' => [
-                    'callback' => 'callback:App\\Helper\\GridHelper::addHashPrefix',
+                    'callable' => 'callable:App\\Helper\\GridHelper::addHashPrefix',
                 ],
                 'label' => 'app.ui.id',
             ])
             ->shouldBeAValidConfig([
-                'type' => 'callback',
+                'type' => 'callable',
                 'option' => [],
                 'label' => 'app.ui.id',
             ])
@@ -49,19 +49,19 @@ public function getMatchers(): array
                     return false;
                 }
 
-                return is_callable($subject['option']['callback'] ?? null);
+                return is_callable($subject['option']['callable'] ?? null);
             },
         ];
     }
 
-    function it_fails_while_parsing_options_with_invalid_callback(): void
+    function it_fails_while_parsing_options_with_invalid_callable(): void
     {
         $this
             ->shouldThrow(\RuntimeException::class)
             ->during('parseOptions', [[
-                'type' => 'callback',
+                'type' => 'callable',
                 'option' => [
-                    'callback' => 'callback:foobar',
+                    'callable' => 'callable:foobar',
                 ],
                 'label' => 'app.ui.id',
             ]])

…mponent/FieldTypes/CallbackFieldType.php …mponent/FieldTypes/CallableFieldType.phpsrc/Component/FieldTypes/CallbackFieldType.php renamed to src/Component/FieldTypes/CallableFieldType.php src/Component/FieldTypes/CallbackFieldType.php renamed to src/Component/FieldTypes/CallableFieldType.php

@@ -17,7 +17,7 @@
 use Sylius\Component\Grid\Definition\Field;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
-final class CallbackFieldType implements FieldTypeInterface
+final class CallableFieldType implements FieldTypeInterface
 {
     public function __construct(private DataExtractorInterface $dataExtractor)
     {
@@ -26,7 +26,7 @@ public function __construct(private DataExtractorInterface $dataExtractor)
     public function render(Field $field, $data, array $options): string
     {
         $value = $this->dataExtractor->get($field, $data);
-        $value = (string) call_user_func($options['callback'], $value);
+        $value = (string) call_user_func($options['callable'], $value);
 
         if ($options['htmlspecialchars']) {
             $value = htmlspecialchars($value);
@@ -37,8 +37,8 @@ public function render(Field $field, $data, array $options): string
 
     public function configureOptions(OptionsResolver $resolver): void
     {
-        $resolver->setRequired('callback');
-        $resolver->setAllowedTypes('callback', 'callable');
+        $resolver->setRequired('callable');
+        $resolver->setAllowedTypes('callable', 'callable');
 
         $resolver->setDefault('htmlspecialchars', true);
         $resolver->setAllowedTypes('htmlspecialchars', 'bool');

…pec/FieldTypes/CallbackFieldTypeSpec.php …pec/FieldTypes/CallableFieldTypeSpec.phpsrc/Component/spec/FieldTypes/CallbackFieldTypeSpec.php renamed to src/Component/spec/FieldTypes/CallableFieldTypeSpec.php src/Component/spec/FieldTypes/CallbackFieldTypeSpec.php renamed to src/Component/spec/FieldTypes/CallableFieldTypeSpec.php

@@ -18,7 +18,7 @@
 use Sylius\Component\Grid\Definition\Field;
 use Sylius\Component\Grid\FieldTypes\FieldTypeInterface;
 
-final class CallbackFieldTypeSpec extends ObjectBehavior
+final class CallableFieldTypeSpec extends ObjectBehavior
 {
     function let(DataExtractorInterface $dataExtractor): void
     {
@@ -30,50 +30,50 @@ function it_is_a_grid_field_type(): void
         $this->shouldImplement(FieldTypeInterface::class);
     }
 
-    function it_uses_data_extractor_to_obtain_data_and_passes_it_to_a_callback_with_htmlspecialchars(
+    function it_uses_data_extractor_to_obtain_data_and_passes_it_to_a_callable_with_htmlspecialchars(
         DataExtractorInterface $dataExtractor,
         Field $field,
     ): void {
         $dataExtractor->get($field, ['foo' => 'bar'])->willReturn('bar');
 
         $this->render($field, ['foo' => 'bar'], [
-            'callback' => fn (string $value): string => "<strong>$value</strong>",
+            'callable' => fn (string $value): string => "<strong>$value</strong>",
             'htmlspecialchars' => true,
         ])->shouldReturn('&lt;strong&gt;bar&lt;/strong&gt;');
     }
 
-    function it_uses_data_extractor_to_obtain_data_and_passes_it_to_a_callback_without_htmlspecialchars(
+    function it_uses_data_extractor_to_obtain_data_and_passes_it_to_a_callable_without_htmlspecialchars(
         DataExtractorInterface $dataExtractor,
         Field $field,
     ): void {
         $dataExtractor->get($field, ['foo' => 'bar'])->willReturn('bar');
 
         $this->render($field, ['foo' => 'bar'], [
-            'callback' => fn (string $value): string => "<strong>$value</strong>",
+            'callable' => fn (string $value): string => "<strong>$value</strong>",
             'htmlspecialchars' => false,
         ])->shouldReturn('<strong>bar</strong>');
     }
 
-    function it_uses_data_extractor_to_obtain_data_and_passes_it_to_a_function_callback(
+    function it_uses_data_extractor_to_obtain_data_and_passes_it_to_a_function_callable(
         DataExtractorInterface $dataExtractor,
         Field $field,
     ): void {
         $dataExtractor->get($field, ['foo' => 'bar'])->willReturn('bar');
 
         $this->render($field, ['foo' => 'bar'], [
-            'callback' => 'strtoupper',
+            'callable' => 'strtoupper',
             'htmlspecialchars' => true,
         ])->shouldReturn('BAR');
     }
 
-    function it_uses_data_extractor_to_obtain_data_and_passes_it_to_a_static_callback(
+    function it_uses_data_extractor_to_obtain_data_and_passes_it_to_a_static_callable(
         DataExtractorInterface $dataExtractor,
         Field $field,
     ): void {
         $dataExtractor->get($field, ['foo' => 'bar'])->willReturn('BAR');
 
         $this->render($field, ['foo' => 'bar'], [
-            'callback' => [self::class, 'callable'],
+            'callable' => [self::class, 'callable'],
             'htmlspecialchars' => true,
         ])->shouldReturn('bar');
     }

tests/Application/config/sylius/grids.yaml

@@ -33,9 +33,9 @@ sylius_grid:
                 title: asc
             fields:
                 title:
-                    type: callback
+                    type: callable
                     options:
-                        callback: "callback:strtoupper"
+                        callable: "callable:strtoupper"
                     label: Title
                     sortable: ~
                 author:
@@ -62,9 +62,9 @@ sylius_grid:
                 name: asc
             fields:
                 id:
-                    type: callback
+                    type: callable
                     options:
-                        callback: "callback:App\\Helper\\GridHelper::addHashPrefix"
+                        callable: "callable:App\\Helper\\GridHelper::addHashPrefix"
                     label: ID
                     sortable: ~
                 name:

tests/Application/config/sylius/grids/author.php

@@ -11,7 +11,7 @@
 
 declare(strict_types=1);
 
-use Sylius\Bundle\GridBundle\Builder\Field\CallbackField;
+use Sylius\Bundle\GridBundle\Builder\Field\CallableField;
 use Sylius\Bundle\GridBundle\Builder\Field\StringField;
 use Sylius\Bundle\GridBundle\Builder\Filter\StringFilter;
 use Sylius\Bundle\GridBundle\Builder\GridBuilder;
@@ -23,7 +23,7 @@
             ->addFilter(StringFilter::create('name'))
             ->orderBy('name', 'asc')
             ->addField(
-                CallbackField::create('id', ['App\\Helper\\GridHelper', 'addHashPrefix'])
+                CallableField::create('id', ['App\\Helper\\GridHelper', 'addHashPrefix'])
                     ->setSortable(true),
             )
             ->addField(

tests/Application/config/sylius/grids/book.php

@@ -14,7 +14,7 @@
 use App\Entity\Author;
 use App\Entity\Book;
 use App\Grid\Builder\NationalityFilter;
-use Sylius\Bundle\GridBundle\Builder\Field\CallbackField;
+use Sylius\Bundle\GridBundle\Builder\Field\CallableField;
 use Sylius\Bundle\GridBundle\Builder\Field\StringField;
 use Sylius\Bundle\GridBundle\Builder\Filter\EntityFilter;
 use Sylius\Bundle\GridBundle\Builder\Filter\SelectFilter;
@@ -49,7 +49,7 @@
         )
         ->orderBy('title', 'asc')
         ->addField(
-            CallbackField::create('title', 'strtoupper')
+            CallableField::create('title', 'strtoupper')
                 ->setLabel('Title')
                 ->setSortable(true),
         )