ISSUE-218: Implemented BooleanToYesNoSubscriber

Author: raymondschouten

README.md

@@ -24,6 +24,7 @@ Learn more about it in its [documentation](https://github.com/darkwebdesign/symf
 
 ### Event Subscribers
 
+* BooleanToYesNoSubscriber, rewrites boolean values to "yes" or "no", to be used with the `BooleanType`.
 * JsonSchemaSubscriber, rewrites the JSON Schema `$schema` keyword property.
 
 ## Installing via Composer

src/BooleanToYesNoSubscriber.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * Copyright (c) 2021 DarkWeb Design
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+declare(strict_types=1);
+
+namespace DarkWebDesign\SymfonyAddonFormTypes;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormEvents;
+
+/**
+ * Boolean to "yes" or "no" form event subscriber.
+ *
+ * @author Raymond Schouten
+ *
+ * @since 5.2.1
+ */
+class BooleanToYesNoSubscriber implements EventSubscriberInterface
+{
+    /** @var string[] */
+    private $fieldNames;
+
+    public function __construct(array $fieldNames)
+    {
+        $this->fieldNames = $fieldNames;
+    }
+
+    /**
+     * Rewrites the pure boolean values to "yes" or "no".
+     */
+    public function onPreSubmit(FormEvent $event): void
+    {
+        $data = $event->getData();
+
+        if (!is_array($data)) {
+            return;
+        }
+
+        foreach ($this->fieldNames as $fieldName) {
+            if (!array_key_exists($fieldName, $data)) {
+                continue;
+            }
+
+            $data[$fieldName] = true === $data[$fieldName] ? 'yes' : (false === $data[$fieldName] ? 'no' : null);
+        }
+
+        $event->setData($data);
+    }
+
+    /**
+     * Returns an array of event names this subscriber wants to listen to.
+     */
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            FormEvents::PRE_SUBMIT => 'onPreSubmit',
+        ];
+    }
+}

tests/BooleanToYesNoSubscriberTest.php

@@ -0,0 +1,89 @@
+<?php
+/**
+ * Copyright (c) 2021 DarkWeb Design
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+declare(strict_types=1);
+
+namespace DarkWebDesign\SymfonyAddonFormTypes\Tests;
+
+use DarkWebDesign\SymfonyAddonFormTypes\BooleanToYesNoSubscriber;
+use DarkWebDesign\SymfonyAddonFormTypes\BooleanType;
+use Symfony\Component\Form\Test\TypeTestCase;
+
+/**
+ * @covers \DarkWebDesign\SymfonyAddonFormTypes\BooleanToYesNoSubscriber
+ *
+ * @uses \DarkWebDesign\SymfonyAddonFormTypes\BooleanType
+ * @uses \DarkWebDesign\SymfonyAddonTransformers\BooleanToValueTransformer
+ */
+class BooleanToYesNoSubscriberTest extends TypeTestCase
+{
+    /**
+     * @dataProvider provider
+     */
+    public function test(?bool $value): void
+    {
+        $form = $this->factory->createBuilder()
+            ->add('isActive', BooleanType::class)
+            ->addEventSubscriber(new BooleanToYesNoSubscriber(['isActive']))
+            ->getForm();
+
+        $form->submit([
+            'isActive' => $value,
+        ]);
+
+        $this->assertTrue($form->isSynchronized());
+        $this->assertSame($value, $form->get('isActive')->getData());
+    }
+
+    public function testDataNoField(): void
+    {
+        $form = $this->factory->createBuilder()
+            ->add('isActive', BooleanType::class)
+            ->addEventSubscriber(new BooleanToYesNoSubscriber(['isActive']))
+            ->getForm();
+
+        $form->submit([]);
+
+        $this->assertTrue($form->isSynchronized());
+        $this->assertNull($form->get('isActive')->getData());
+    }
+
+    public function testDataNotArray(): void
+    {
+        $form = $this->factory->createBuilder()
+            ->add('isActive', BooleanType::class)
+            ->addEventSubscriber(new BooleanToYesNoSubscriber(['isActive']))
+            ->getForm();
+
+        $form->submit('not-array');
+
+        $this->assertFalse($form->isSynchronized());
+        $this->assertNull($form->get('isActive')->getData());
+    }
+
+    public function provider(): array
+    {
+        return [
+            'true' => [true],
+            'false' => [false],
+            'null' => [null],
+        ];
+    }
+}