From 98cbf02f277cccfb9dccac3af38ecd29d6939b57 Mon Sep 17 00:00:00 2001
From: Simon Schaufelberger <simonschaufi@users.noreply.github.com>
Date: Sat, 15 Jun 2024 20:37:09 +0300
Subject: [PATCH] [FEATURE] Add MigrateRequiredFlagFlexFormFractor

---
 packages/typo3-fractor/config/typo3-12.php    |   2 +
 .../Fixtures/Fixture.xml                      |  74 +++++++++++
 ...MigrateRequiredFlagFlexFormFractorTest.php |  27 ++++
 .../config/fractor.php                        |  15 +++
 .../MigrateRequiredFlagFlexFormFractor.php    | 122 ++++++++++++++++++
 5 files changed, 240 insertions(+)
 create mode 100644 packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor/Fixtures/Fixture.xml
 create mode 100644 packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor/MigrateRequiredFlagFlexFormFractorTest.php
 create mode 100644 packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor/config/fractor.php
 create mode 100644 packages/typo3-fractor/rules/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor.php

diff --git a/packages/typo3-fractor/config/typo3-12.php b/packages/typo3-fractor/config/typo3-12.php
index 193b4c4d..a40151f0 100644
--- a/packages/typo3-fractor/config/typo3-12.php
+++ b/packages/typo3-fractor/config/typo3-12.php
@@ -8,6 +8,7 @@
 use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigrateNullFlagFlexFormFractor;
 use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigratePasswordAndSaltedPasswordToPasswordTypeFlexFormFractor;
 use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigrateRenderTypeColorpickerToTypeColorFlexFormFractor;
+use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigrateRequiredFlagFlexFormFractor;
 use a9f\Typo3Fractor\TYPO3v12\Fluid\AbstractMessageGetSeverityFluidRector;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 
@@ -24,4 +25,5 @@
     $services->set(MigrateNullFlagFlexFormFractor::class);
     $services->set(MigratePasswordAndSaltedPasswordToPasswordTypeFlexFormFractor::class);
     $services->set(MigrateRenderTypeColorpickerToTypeColorFlexFormFractor::class);
+    $services->set(MigrateRequiredFlagFlexFormFractor::class);
 };
diff --git a/packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor/Fixtures/Fixture.xml b/packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor/Fixtures/Fixture.xml
new file mode 100644
index 00000000..65450914
--- /dev/null
+++ b/packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor/Fixtures/Fixture.xml
@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>
+-----
+<?xml version="1.0" encoding="UTF-8"?>
+<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/packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor/MigrateRequiredFlagFlexFormFractorTest.php b/packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor/MigrateRequiredFlagFlexFormFractorTest.php
new file mode 100644
index 00000000..c64dfe12
--- /dev/null
+++ b/packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor/MigrateRequiredFlagFlexFormFractorTest.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Typo3Fractor\Tests\TYPO3v12\FlexForm\MigrateRequiredFlagFlexFormFractor;
+
+use a9f\Fractor\Testing\PHPUnit\AbstractFractorTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+
+final class MigrateRequiredFlagFlexFormFractorTest extends AbstractFractorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): \Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixtures', '*.xml');
+    }
+
+    public function provideConfigFilePath(): ?string
+    {
+        return __DIR__ . '/config/fractor.php';
+    }
+}
diff --git a/packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor/config/fractor.php b/packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor/config/fractor.php
new file mode 100644
index 00000000..2e8d397d
--- /dev/null
+++ b/packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor/config/fractor.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use a9f\Fractor\Configuration\FractorConfiguration;
+use a9f\Fractor\ValueObject\Indent;
+use a9f\FractorXml\Configuration\XmlProcessorOption;
+use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigrateRequiredFlagFlexFormFractor;
+
+return FractorConfiguration::configure()
+    ->withOptions([
+        XmlProcessorOption::INDENT_CHARACTER => Indent::STYLE_TAB,
+        XmlProcessorOption::INDENT_SIZE => 1,
+    ])
+    ->withRules([MigrateRequiredFlagFlexFormFractor::class]);
diff --git a/packages/typo3-fractor/rules/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor.php b/packages/typo3-fractor/rules/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor.php
new file mode 100644
index 00000000..a8e296d3
--- /dev/null
+++ b/packages/typo3-fractor/rules/TYPO3v12/FlexForm/MigrateRequiredFlagFlexFormFractor.php
@@ -0,0 +1,122 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Typo3Fractor\TYPO3v12\FlexForm;
+
+use a9f\Fractor\Application\ValueObject\File;
+use a9f\Fractor\Helper\ArrayUtility;
+use a9f\Fractor\Helper\StringUtility;
+use a9f\Typo3Fractor\AbstractFlexformFractor;
+use a9f\Typo3Fractor\Helper\FlexFormHelperTrait;
+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 \a9f\Typo3Fractor\Tests\TYPO3v12\FlexForm\MigrateRequiredFlagFlexFormFractor\MigrateRequiredFlagFlexFormFractorTest
+ */
+final class MigrateRequiredFlagFlexFormFractor extends AbstractFlexformFractor
+{
+    use FlexFormHelperTrait;
+
+    private \DOMDocument $domDocument;
+
+    public function canHandle(\DOMNode $node): bool
+    {
+        return parent::canHandle($node) && $node->nodeName === 'config';
+    }
+
+    public function beforeTraversal(File $file, \DOMDocument $rootNode): void
+    {
+        $this->file = $file;
+        $this->domDocument = $rootNode;
+    }
+
+    public function refactor(\DOMNode $node): \DOMNode|int|null
+    {
+        if (! $node instanceof \DOMElement) {
+            return null;
+        }
+
+        if (! $this->hasKey($node, 'eval')) {
+            return null;
+        }
+
+        $evalDomElement = $this->extractDomElementByKey($node, 'eval');
+        if (! $evalDomElement instanceof \DOMElement) {
+            return null;
+        }
+
+        $evalListValue = $evalDomElement->nodeValue;
+        if (! is_string($evalListValue)) {
+            return null;
+        }
+
+        if (! StringUtility::inList($evalListValue, 'required')) {
+            return null;
+        }
+
+        $evalList = ArrayUtility::trimExplode(',', $evalListValue, true);
+
+        // Remove "required" from $evalList
+        $evalList = array_filter($evalList, static fn (string $eval): bool => $eval !== 'required');
+
+        if ($evalList !== []) {
+            // Write back filtered 'eval'
+            $evalDomElement->nodeValue = '';
+            $evalDomElement->appendChild($this->domDocument->createTextNode(implode(',', $evalList)));
+        } elseif ($evalDomElement->parentNode instanceof \DOMElement) {
+            // 'eval' is empty, remove whole configuration
+            $evalDomElement->parentNode->removeChild($evalDomElement);
+        }
+
+        $requiredDomElement = $this->extractDomElementByKey($node, 'required');
+        if (! $requiredDomElement instanceof \DOMElement) {
+            $node->appendChild($this->domDocument->createElement('required', '1'));
+        }
+
+        return $node;
+    }
+
+    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
+        )]);
+    }
+}