Allow passing translatable to "separator" option in CollectionColumnType #207

Author: Kreyu

docs/src/reference/types/column/collection.md

@@ -48,7 +48,7 @@ $builder
 
 ### `separator`
 
-- **type**: `null` or `string`
+- **type**: `null`, `string` or `Symfony\Component\Translation\TranslatableInterface`
 - **default**: `', '`
 
 Sets the value displayed between every item in the collection.

src/Column/Type/CollectionColumnType.php

@@ -9,6 +9,8 @@
 use Kreyu\Bundle\DataTableBundle\Column\ColumnInterface;
 use Kreyu\Bundle\DataTableBundle\Column\ColumnValueView;
 use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\Contracts\Translation\TranslatableInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 /**
  * Represents a column with value displayed as a list.
@@ -17,6 +19,11 @@
  */
 final class CollectionColumnType extends AbstractColumnType
 {
+    public function __construct(
+        private ?TranslatorInterface $translator = null,
+    ) {
+    }
+
     public function buildColumn(ColumnBuilderInterface $builder, array $options): void
     {
         $builder->setAttribute('prototype_factory', $builder->getColumnFactory());
@@ -27,6 +34,7 @@ public function buildValueView(ColumnValueView $view, ColumnInterface $column, a
         $view->vars = array_replace($view->vars, [
             'separator' => $options['separator'],
             'separator_html' => $options['separator_html'],
+            'separator_translatable' => $options['separator'] instanceof TranslatableInterface,
             'children' => $this->createChildrenColumnValueViews($view, $column, $options),
         ]);
     }
@@ -44,7 +52,19 @@ public function buildExportValueView(ColumnValueView $view, ColumnInterface $col
             'separator_html' => $options['separator_html'],
         ];
 
-        $view->value = $view->vars['value'] = implode($options['export']['separator'], array_map(
+        $separator = $options['export']['separator'] ?? '';
+
+        if ($this->translator && $separator instanceof TranslatableInterface) {
+            $locale = null;
+
+            if (method_exists(TranslatableInterface::class, 'getLocale')) {
+                $locale = $this->translator->getLocale();
+            }
+
+            $separator = $separator->trans($this->translator, $locale);
+        }
+
+        $view->value = $view->vars['value'] = implode($separator, array_map(
             static fn (ColumnValueView $view) => $view->vars['value'],
             $this->createChildrenColumnValueViews($view, $column, $options['export']),
         ));
@@ -70,7 +90,7 @@ public function configureOptions(OptionsResolver $resolver): void
         $resolver->define('separator')
             ->default(', ')
             ->info('Separator to render between each item in the collection.')
-            ->allowedTypes('null', 'string')
+            ->allowedTypes('null', 'string', TranslatableInterface::class)
         ;
 
         /* @see https://data-table-bundle.swroblewski.pl/reference/types/column/collection#separator-html */

src/Resources/config/columns.php

@@ -82,6 +82,7 @@
 
     $services
         ->set('kreyu_data_table.column.type.collection', CollectionColumnType::class)
+        ->args([service('translator')->nullOnInvalid()])
         ->tag('kreyu_data_table.column.type')
     ;
 

src/Resources/views/themes/base.html.twig

@@ -556,7 +556,19 @@
 {% block column_collection_value -%}
     {% for child in children -%}
         {{- data_table_column_value(child) -}}
-        <span>{{ not loop.last ? (separator_html ? separator|raw : separator) }}</span>
+        <span>
+            {%- if not loop.last -%}
+                {%- if separator_translatable -%}
+                    {%- set separator = separator|trans -%}
+                {%- endif -%}
+
+                {%- if separator_html -%}
+                    {%- set separator = separator|raw -%}
+                {%- endif -%}
+
+                {{ separator }}
+            {%- endif -%}
+        </span>
     {%- endfor %}
 {%- endblock %}
 

tests/Unit/Column/Type/CollectionColumnTypeTest.php

@@ -17,12 +17,17 @@
 use Kreyu\Bundle\DataTableBundle\Tests\Fixtures\Enum\TranslatableEnum;
 use Kreyu\Bundle\DataTableBundle\Tests\Fixtures\Enum\UnitEnum;
 use PHPUnit\Framework\Attributes\DataProvider;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+use function Symfony\Component\Translation\t;
 
 class CollectionColumnTypeTest extends ColumnTypeTestCase
 {
+    private ?TranslatorInterface $translator = null;
+
     protected function getTestedColumnType(): ColumnTypeInterface
     {
-        return new CollectionColumnType();
+        return new CollectionColumnType($this->translator);
     }
 
     protected function getAdditionalColumnTypes(): array
@@ -41,22 +46,67 @@ public function testPassingSeparatorOptionAsString(): void
     {
         $column = $this->createColumn([
             'separator' => '|',
+            'export' => true,
         ]);
 
         $valueView = $this->createColumnValueView($column);
 
         $this->assertEquals('|', $valueView->vars['separator']);
+
+        $rowData = new class {
+            public array $collection = [1, 2, 3];
+        };
+
+        $exportValueView = $this->createExportColumnValueView($column, rowData: $rowData);
+
+        $this->assertEquals('1|2|3', $exportValueView->vars['value']);
+    }
+
+    public function testPassingSeparatorOptionAsTranslatable(): void
+    {
+        $this->translator = $this->createMock(TranslatorInterface::class);
+        $this->translator->expects($this->once())
+            ->method('trans')
+            ->with('separator', [], 'data-table')
+            ->willReturn('translated');
+
+        $column = $this->createColumn([
+            'separator' => $separator = t('separator', domain: 'data-table'),
+            'export' => true,
+        ]);
+
+        $valueView = $this->createColumnValueView($column);
+
+        $this->assertEquals($separator, $valueView->vars['separator']);
+        $this->assertTrue($valueView->vars['separator_translatable']);
+
+        $rowData = new class {
+            public array $collection = [1, 2, 3];
+        };
+
+        $exportValueView = $this->createExportColumnValueView($column, rowData: $rowData);
+
+        $this->assertEquals('1translated2translated3', $exportValueView->vars['value']);
     }
 
     public function testPassingSeparatorOptionAsNull(): void
     {
         $column = $this->createColumn([
             'separator' => null,
+            'export' => true,
         ]);
 
         $valueView = $this->createColumnValueView($column);
 
         $this->assertNull($valueView->vars['separator']);
+
+        $rowData = new class {
+            public array $collection = [1, 2, 3];
+        };
+
+        $exportValueView = $this->createExportColumnValueView($column, rowData: $rowData);
+
+        $this->assertEquals('123', $exportValueView->vars['value']);
     }
 
     public function testDefaultSeparatorHtmlOption(): void