From 3d1b678fc6f47b6b8288a12c008da62003812208 Mon Sep 17 00:00:00 2001
From: Simon Schaufelberger <simonschaufi@users.noreply.github.com>
Date: Thu, 4 Jan 2024 22:59:56 +0100
Subject: [PATCH] [FEATURE] Add MigrateRequiredFlagFlexFormRector

Resolves: #3363
---
 config/v12/flexform-120.php                   |   2 +
 .../MigrateRequiredFlagFlexFormRector.php     | 135 ++++++++++++++++++
 .../v12/v0/tca/MigrateRequiredFlagRector.php  |   1 +
 .../Fixture/fixture.xml.inc                   |  70 +++++++++
 .../MigrateRequiredFlagFlexFormRectorTest.php |  32 +++++
 .../config/configured_rule.php                |  11 ++
 6 files changed, 251 insertions(+)
 create mode 100644 src/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector.php
 create mode 100644 tests/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector/Fixture/fixture.xml.inc
 create mode 100644 tests/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector/MigrateRequiredFlagFlexFormRectorTest.php
 create mode 100644 tests/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector/config/configured_rule.php

diff --git a/config/v12/flexform-120.php b/config/v12/flexform-120.php
index 77517fd50..70fc4a268 100644
--- a/config/v12/flexform-120.php
+++ b/config/v12/flexform-120.php
@@ -9,6 +9,7 @@
 use Ssch\TYPO3Rector\Rector\v12\v0\flexform\MigrateNullFlagFlexFormRector;
 use Ssch\TYPO3Rector\Rector\v12\v0\flexform\MigratePasswordAndSaltedPasswordToPasswordTypeFlexFormRector;
 use Ssch\TYPO3Rector\Rector\v12\v0\flexform\MigrateRenderTypeColorpickerToTypeColorFlexFormRector;
+use Ssch\TYPO3Rector\Rector\v12\v0\flexform\MigrateRequiredFlagFlexFormRector;
 use Ssch\TYPO3Rector\Rector\v12\v0\flexform\RemoveElementTceFormsRector;
 
 return static function (RectorConfig $rectorConfig): void {
@@ -19,5 +20,6 @@
     $rectorConfig->rule(MigrateNullFlagFlexFormRector::class);
     $rectorConfig->rule(MigratePasswordAndSaltedPasswordToPasswordTypeFlexFormRector::class);
     $rectorConfig->rule(MigrateRenderTypeColorpickerToTypeColorFlexFormRector::class);
+    $rectorConfig->rule(MigrateRequiredFlagFlexFormRector::class);
     $rectorConfig->rule(RemoveElementTceFormsRector::class);
 };
diff --git a/src/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector.php b/src/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector.php
new file mode 100644
index 000000000..c276119d1
--- /dev/null
+++ b/src/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector.php
@@ -0,0 +1,135 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ssch\TYPO3Rector\Rector\v12\v0\flexform;
+
+use DOMDocument;
+use DOMElement;
+use DOMNodeList;
+use DOMXPath;
+use Ssch\TYPO3Rector\Contract\FileProcessor\FlexForms\Rector\FlexFormRectorInterface;
+use Ssch\TYPO3Rector\Helper\ArrayUtility;
+use Ssch\TYPO3Rector\Helper\FlexFormHelperTrait;
+use Ssch\TYPO3Rector\Helper\StringUtility;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @changelog https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.0/Deprecation-97035-RequiredOptionInEvalKeyword.html
+ * @changelog https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.0/Feature-97035-UtilizeRequiredDirectlyInTCAFieldConfiguration.html
+ * @see \Ssch\TYPO3Rector\Tests\Rector\v12\v0\flexform\MigrateRequiredFlagFlexFormRector\MigrateRequiredFlagFlexFormRectorTest
+ */
+final class MigrateRequiredFlagFlexFormRector implements FlexFormRectorInterface
+{
+    use FlexFormHelperTrait;
+
+    private bool $domDocumentHasBeenChanged = false;
+
+    public function transform(DOMDocument $domDocument): bool
+    {
+        $xpath = new DOMXPath($domDocument);
+
+        /** @var DOMNodeList<DOMElement> $elements */
+        $elements = $xpath->query('//config');
+
+        if ($elements->count() === 0) {
+            return false;
+        }
+
+        foreach ($elements as $element) {
+            $this->refactorColumn($domDocument, $element);
+        }
+
+        return $this->domDocumentHasBeenChanged;
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Migrate required flag', [new CodeSample(
+            <<<'CODE_SAMPLE'
+<T3DataStructure>
+    <ROOT>
+        <sheetTitle>aTitle</sheetTitle>
+        <type>array</type>
+        <el>
+            <some_column>
+                <title>foo</title>
+                <config>
+                    <eval>trim,required</eval>
+                </config>
+            </some_column>
+        </el>
+    </ROOT>
+</T3DataStructure>
+CODE_SAMPLE
+            ,
+            <<<'CODE_SAMPLE'
+<T3DataStructure>
+    <ROOT>
+        <sheetTitle>aTitle</sheetTitle>
+        <type>array</type>
+        <el>
+            <some_column>
+                <title>foo</title>
+                <config>
+                    <eval>trim</eval>
+                    <required>1</required>
+                </config>
+            </some_column>
+        </el>
+    </ROOT>
+</T3DataStructure>
+CODE_SAMPLE
+        )]);
+    }
+
+    private function refactorColumn(DOMDocument $domDocument, ?DOMElement $configElement): void
+    {
+        if (! $configElement instanceof DOMElement) {
+            return;
+        }
+
+        if (! $this->hasKey($configElement, 'eval')) {
+            return;
+        }
+
+        $evalDomElement = $this->extractDomElementByKey($configElement, 'eval');
+        if (! $evalDomElement instanceof DOMElement) {
+            return;
+        }
+
+        $evalListValue = $evalDomElement->nodeValue;
+        if (! is_string($evalListValue)) {
+            return;
+        }
+
+        if (! StringUtility::inList($evalListValue, 'required')) {
+            return;
+        }
+
+        $evalList = ArrayUtility::trimExplode(',', $evalListValue, true);
+
+        // Remove "required" from $evalList
+        $evalList = array_filter($evalList, static fn (string $eval) => $eval !== 'required');
+
+        if ($evalList !== []) {
+            // Write back filtered 'eval'
+            $evalDomElement->nodeValue = '';
+            $evalDomElement->appendChild($domDocument->createTextNode(implode(',', $evalList)));
+        } elseif ($evalDomElement->parentNode instanceof DOMElement) {
+            // 'eval' is empty, remove whole configuration
+            $evalDomElement->parentNode->removeChild($evalDomElement);
+        }
+
+        $requiredDomElement = $this->extractDomElementByKey($configElement, 'required');
+        if (! $requiredDomElement instanceof DOMElement) {
+            $configElement->appendChild($domDocument->createElement('required', '1'));
+        }
+
+        $this->domDocumentHasBeenChanged = true;
+    }
+}
diff --git a/src/Rector/v12/v0/tca/MigrateRequiredFlagRector.php b/src/Rector/v12/v0/tca/MigrateRequiredFlagRector.php
index b15bab577..70867abff 100644
--- a/src/Rector/v12/v0/tca/MigrateRequiredFlagRector.php
+++ b/src/Rector/v12/v0/tca/MigrateRequiredFlagRector.php
@@ -19,6 +19,7 @@
 
 /**
  * @changelog https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.0/Deprecation-97035-RequiredOptionInEvalKeyword.html
+ * @changelog https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.0/Feature-97035-UtilizeRequiredDirectlyInTCAFieldConfiguration.html
  * @see \Ssch\TYPO3Rector\Tests\Rector\v12\v0\tca\MigrateRequiredFlagRector\MigrateRequiredFlagRectorTest
  */
 final class MigrateRequiredFlagRector extends AbstractTcaRector
diff --git a/tests/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector/Fixture/fixture.xml.inc b/tests/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector/Fixture/fixture.xml.inc
new file mode 100644
index 000000000..60fbc3cdf
--- /dev/null
+++ b/tests/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector/Fixture/fixture.xml.inc
@@ -0,0 +1,70 @@
+<T3DataStructure>
+    <sheets>
+        <sDEF>
+            <ROOT>
+                <sheetTitle>sheetTitle</sheetTitle>
+                <type>array</type>
+                <el>
+                    <settings.fieldContainsEvalRequired>
+                        <config>
+                            <type>input</type>
+                            <eval>required</eval>
+                        </config>
+                    </settings.fieldContainsEvalRequired>
+                    <settings.fieldContainsEvalTrimRequired>
+                        <config>
+                            <type>input</type>
+                            <eval>trim,required</eval>
+                        </config>
+                    </settings.fieldContainsEvalTrimRequired>
+                    <settings.fieldDoesNotContainEvalWithRequire>
+                        <config>
+                            <type>input</type>
+                            <eval>trim</eval>
+                        </config>
+                    </settings.fieldDoesNotContainEvalWithRequire>
+                    <settings.fieldDoesNotContainEval>
+                        <config>
+                            <type>input</type>
+                        </config>
+                    </settings.fieldDoesNotContainEval>
+                </el>
+            </ROOT>
+        </sDEF>
+    </sheets>
+</T3DataStructure>
+-----
+<T3DataStructure>
+    <sheets>
+        <sDEF>
+            <ROOT>
+                <sheetTitle>sheetTitle</sheetTitle>
+                <type>array</type>
+                <el>
+                    <settings.fieldContainsEvalRequired>
+                        <config>
+                            <type>input</type>
+                        <required>1</required></config>
+                    </settings.fieldContainsEvalRequired>
+                    <settings.fieldContainsEvalTrimRequired>
+                        <config>
+                            <type>input</type>
+                            <eval>trim</eval>
+                        <required>1</required></config>
+                    </settings.fieldContainsEvalTrimRequired>
+                    <settings.fieldDoesNotContainEvalWithRequire>
+                        <config>
+                            <type>input</type>
+                            <eval>trim</eval>
+                        </config>
+                    </settings.fieldDoesNotContainEvalWithRequire>
+                    <settings.fieldDoesNotContainEval>
+                        <config>
+                            <type>input</type>
+                        </config>
+                    </settings.fieldDoesNotContainEval>
+                </el>
+            </ROOT>
+        </sDEF>
+    </sheets>
+</T3DataStructure>
diff --git a/tests/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector/MigrateRequiredFlagFlexFormRectorTest.php b/tests/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector/MigrateRequiredFlagFlexFormRectorTest.php
new file mode 100644
index 000000000..de6d305e5
--- /dev/null
+++ b/tests/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector/MigrateRequiredFlagFlexFormRectorTest.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ssch\TYPO3Rector\Tests\Rector\v12\v0\flexform\MigrateRequiredFlagFlexFormRector;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class MigrateRequiredFlagFlexFormRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    /**
+     * @return Iterator<array<string>>
+     */
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture', '*.xml.inc');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}
diff --git a/tests/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector/config/configured_rule.php b/tests/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector/config/configured_rule.php
new file mode 100644
index 000000000..cba20b548
--- /dev/null
+++ b/tests/Rector/v12/v0/flexform/MigrateRequiredFlagFlexFormRector/config/configured_rule.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Ssch\TYPO3Rector\Rector\v12\v0\flexform\MigrateRequiredFlagFlexFormRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->import(__DIR__ . '/../../../../../../../config/config_test.php');
+    $rectorConfig->rule(MigrateRequiredFlagFlexFormRector::class);
+};