Improve how locale filter type migrates data from old format (#438)

* Improve how locale filter type migrates data from old format

* Improve how locale filter type migrates data from old format

Author: javihgil

src/Form/Admin/LocaleFilterType.php

@@ -40,28 +40,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
         $availableLocales = $options['available_locales'];
 
         $builder->addEventListener(FormEvents::PRE_SET_DATA, function (PreSetDataEvent $event) use ($availableLocales) {
-            $data = $event->getData();
-
-            $initialValue = array_combine($availableLocales, array_fill(0, count($availableLocales), true));
-
-            if (null === $data) {
-                $data = $initialValue;
-            }
-
-            foreach ($data as $key => $value) {
-                if (is_int($key) && is_string($value)) {
-                    unset($data[$key]);
-                    $data[$value] = true;
-                }
-            }
-
-            foreach ($availableLocales as $locale) {
-                if (!array_key_exists($locale, $data)) {
-                    $data[$locale] = true;
-                }
-            }
-
-            $event->setData($data);
+            self::onPreSetData($event, $availableLocales);
         });
 
         $builder->addModelTransformer(new CallbackTransformer(function ($data) {
@@ -88,4 +67,33 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             return $data;
         }));
     }
+
+    public static function onPreSetData(PreSetDataEvent $event, array $availableLocales): void
+    {
+        $data = $event->getData();
+
+        $initialValue = array_combine($availableLocales, array_fill(0, count($availableLocales), true));
+
+        if (null === $data) {
+            $data = $initialValue;
+        }
+
+        // migrate legacy format to new one
+        $isLegacy = 0 === sizeof($data);
+        foreach ($data as $key => $value) {
+            if (is_int($key) && is_string($value)) {
+                unset($data[$key]);
+                $data[$value] = true;
+                $isLegacy = true;
+            }
+        }
+
+        foreach ($availableLocales as $locale) {
+            if (!array_key_exists($locale, $data)) {
+                $data[$locale] = !$isLegacy;
+            }
+        }
+
+        $event->setData($data);
+    }
 }

tests/Unit/Form/Admin/LocaleFilterTypeTest.php

@@ -0,0 +1,97 @@
+<?php
+
+namespace Softspring\CmsBundle\Test\Unit\Form\Admin;
+
+use PHPUnit\Framework\TestCase;
+use Softspring\CmsBundle\Form\Admin\LocaleFilterType;
+use Symfony\Component\Form\Event\PreSetDataEvent;
+
+class LocaleFilterTypeTest extends TestCase
+{
+    /**
+     * @dataProvider migratingFormatProvider
+     */
+    public function testMigratingFormat(string $description, array $provided, array $expected, array $available_locales): void
+    {
+        $form = $this->createMock('Symfony\Component\Form\FormInterface');
+        $event = new PreSetDataEvent($form, $provided);
+
+        LocaleFilterType::onPreSetData($event, $available_locales);
+
+        $this->assertEquals($expected, $event->getData(), $description);
+    }
+
+    public static function migratingFormatProvider(): array
+    {
+        return [
+            [
+                'legacy format empty',
+                [],
+                [
+                    'en' => false,
+                    'fr' => false,
+                    'de' => false
+                ],
+                ['en', 'fr', 'de']
+            ],
+            [
+                'legacy format some selected',
+                [ 0 => 'en', 1 => 'fr' ],
+                [
+                    'en' => true,
+                    'fr' => true,
+                    'de' => false
+                ],
+                ['en', 'fr', 'de']
+            ],
+            [
+                'legacy format all selected',
+                [ 0 => 'en',  1 => 'de', 2 => 'fr'],
+                [
+                    'en' => true,
+                    'fr' => true,
+                    'de' => true
+                ],
+                ['en', 'fr', 'de']
+            ],
+            [
+                'new format some with values, so others are new locales',
+                ['de' => false],
+                [
+                    'en' => true,
+                    'fr' => true,
+                    'de' => false
+                ],
+                ['en', 'fr', 'de']
+            ],
+            [
+                'new format all with values',
+                [
+                    'en' => true,
+                    'fr' => false,
+                    'de' => true
+                ],
+                [
+                    'en' => true,
+                    'fr' => false,
+                    'de' => true
+                ],
+                ['en', 'fr', 'de']
+            ],
+            [
+                'new format all with values',
+                [
+                    'en' => false,
+                    'fr' => false,
+                    'de' => false
+                ],
+                [
+                    'en' => false,
+                    'fr' => false,
+                    'de' => false
+                ],
+                ['en', 'fr', 'de']
+            ],
+        ];
+    }
+}