From daad3c73d84a4a734f0e3277e0c2862e402b10a2 Mon Sep 17 00:00:00 2001
From: Simon Schaufelberger <simonschaufi@users.noreply.github.com>
Date: Tue, 10 Oct 2023 21:39:54 +0200
Subject: [PATCH] [TASK] Add MigrateItemsIndexedKeysToAssociativeRector

This Rector Rule is sponsored by UDG Rhein-Main GmbH! Thank you!

Resolves: #3399
---
 config/v12/flexform-123.php                   |  10 +
 ...IndexedArrayKeysForFlexFormItemsRector.php | 202 ++++++++++++++++++
 .../Fixture/fixture.xml.inc                   |  67 ++++++
 .../Fixture/fixture_check.xml.inc             |  57 +++++
 .../Fixture/fixture_radio.xml.inc             |  73 +++++++
 .../Fixture/fixture_with_all_keys.xml.inc     |  79 +++++++
 ...xedArrayKeysForFlexFormItemsRectorTest.php |  32 +++
 .../config/configured_rule.php                |  11 +
 8 files changed, 531 insertions(+)
 create mode 100644 config/v12/flexform-123.php
 create mode 100644 src/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector.php
 create mode 100644 tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture.xml.inc
 create mode 100644 tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture_check.xml.inc
 create mode 100644 tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture_radio.xml.inc
 create mode 100644 tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture_with_all_keys.xml.inc
 create mode 100644 tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/MigrateItemsToIndexedArrayKeysForFlexFormItemsRectorTest.php
 create mode 100644 tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/config/configured_rule.php

diff --git a/config/v12/flexform-123.php b/config/v12/flexform-123.php
new file mode 100644
index 000000000..6a8e6f802
--- /dev/null
+++ b/config/v12/flexform-123.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Ssch\TYPO3Rector\Rector\v12\v3\flexform\MigrateItemsToIndexedArrayKeysForFlexFormItemsRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(MigrateItemsToIndexedArrayKeysForFlexFormItemsRector::class);
+};
diff --git a/src/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector.php b/src/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector.php
new file mode 100644
index 000000000..4fc220eb3
--- /dev/null
+++ b/src/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector.php
@@ -0,0 +1,202 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ssch\TYPO3Rector\Rector\v12\v3\flexform;
+
+use DOMDocument;
+use DOMElement;
+use DOMNode;
+use DOMNodeList;
+use DOMXPath;
+use Ssch\TYPO3Rector\Contract\FileProcessor\FlexForms\Rector\FlexFormRectorInterface;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * This Rector Rule is sponsored by UDG Rhein-Main GmbH
+ *
+ * @changelog https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.3/Deprecation-99739-IndexedArrayKeysForTCAItems.html
+ * @see \Ssch\TYPO3Rector\Tests\Rector\v12\v3\flexform\MigrateItemsToIndexedArrayKeysForFlexFormItemsRector\MigrateItemsToIndexedArrayKeysForFlexFormItemsRectorTest
+ */
+final class MigrateItemsToIndexedArrayKeysForFlexFormItemsRector implements FlexFormRectorInterface
+{
+    public function transform(DOMDocument $domDocument): bool
+    {
+        $hasChanged = false;
+
+        $xpath = new DOMXPath($domDocument);
+
+        /** @var DOMNodeList<DOMElement> $elements */
+        $elements = $xpath->query('//config');
+
+        if ($elements->count() === 0) {
+            return false;
+        }
+
+        foreach ($elements as $element) {
+            /** @var DOMElement $element */
+            $type = $element->getElementsByTagName('type')
+                ->item(0);
+
+            if (! $type instanceof DOMElement) {
+                continue;
+            }
+
+            if ($type->textContent !== 'select' && $type->textContent !== 'radio' && $type->textContent !== 'check') {
+                continue;
+            }
+
+            $items = $element->getElementsByTagName('items')
+                ->item(0);
+
+            if (! $items instanceof DOMElement) {
+                continue;
+            }
+
+            $array_filter = [];
+            foreach ($items->childNodes as $item) {
+                if ($item instanceof DOMElement && $item->nodeName === 'numIndex') {
+                    $array_filter[] = $item;
+                }
+            }
+
+            // These are the main numIndex items
+            $numIndexes = $array_filter;
+
+            if ($numIndexes === []) {
+                continue;
+            }
+
+            foreach ($numIndexes as $item) {
+                /** @var DOMElement $item */
+
+                $numIndexes = $item->getElementsByTagName('numIndex');
+                $label = $numIndexes->item(0);
+                $value = $numIndexes->item(1);
+                $icon = $numIndexes->item(2);
+                $group = $numIndexes->item(3);
+                $description = $numIndexes->item(4);
+                if (! $label instanceof DOMElement) {
+                    continue;
+                }
+
+                $hasChanged = true;
+                $this->changeTagName($label, 'label');
+
+                if ($type->textContent !== 'check') {
+                    if (! $value instanceof DOMElement) {
+                        continue;
+                    }
+
+                    $hasChanged = true;
+                    $this->changeTagName($value, 'value');
+                }
+
+                if ($type->textContent === 'select') {
+                    if (! $icon instanceof DOMElement) {
+                        continue;
+                    }
+
+                    $hasChanged = true;
+                    $this->changeTagName($icon, 'icon');
+
+                    if (! $group instanceof DOMElement) {
+                        continue;
+                    }
+
+                    $hasChanged = true;
+                    $this->changeTagName($group, 'group');
+
+                    if (! $description instanceof DOMElement) {
+                        continue;
+                    }
+
+                    $hasChanged = true;
+                    $this->changeTagName($description, 'description');
+                }
+            }
+        }
+
+        return $hasChanged;
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Migrates indexed item array keys to associative for type select, radio and check in FlexForms. This Rector Rule is sponsored by UDG Rhein-Main GmbH',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+<select_single_1>
+    <label>select_single_1 description</label>
+    <description>field description</description>
+    <config>
+        <type>select</type>
+        <renderType>selectSingle</renderType>
+        <items>
+            <numIndex index="0">
+                <numIndex index="0">Label 1</numIndex>
+                <numIndex index="1">value1</numIndex>
+            </numIndex>
+            <numIndex index="1">
+                <numIndex index="0">Label 2</numIndex>
+                <numIndex index="1">value2</numIndex>
+            </numIndex>
+        </items>
+    </config>
+</select_single_1>
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+<select_single_1>
+    <label>select_single_1 description</label>
+    <description>field description</description>
+    <config>
+        <type>select</type>
+        <renderType>selectSingle</renderType>
+        <items>
+            <numIndex index="0">
+                <label>Label 1</label>
+                <value>value1</value>
+            </numIndex>
+            <numIndex index="1">
+                <label>Label 2</label>
+                <value>value2</value>
+            </numIndex>
+        </items>
+    </config>
+</select_single_1>
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    private function changeTagName(DOMElement $node, string $name): void
+    {
+        $childNodes = [];
+        foreach ($node->childNodes as $child) {
+            $childNodes[] = $child;
+        }
+
+        if (! $node->ownerDocument instanceof DOMDocument) {
+            return;
+        }
+
+        $newNode = $node->ownerDocument->createElement($name);
+        foreach ($childNodes as $child) {
+            $child2 = $node->ownerDocument->importNode($child, false);
+            $newNode->appendChild($child2);
+        }
+
+        if (! $node->parentNode instanceof DOMNode) {
+            return;
+        }
+
+        $node->parentNode->replaceChild($newNode, $node);
+    }
+}
diff --git a/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture.xml.inc b/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture.xml.inc
new file mode 100644
index 000000000..bd0b95199
--- /dev/null
+++ b/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture.xml.inc
@@ -0,0 +1,67 @@
+<T3DataStructure>
+    <sheets>
+        <sDEF>
+            <ROOT>
+                <sheetTitle>
+                    LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_tab.settings
+                </sheetTitle>
+                <type>array</type>
+                <el>
+                    <settings.topNewsRestriction>
+                        <label>
+                            LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_general.topNewsRestriction
+                        </label>
+                        <config>
+                            <type>select</type>
+                            <renderType>selectSingle</renderType>
+                            <items>
+                                <numIndex index="0">
+                                    <numIndex index="0">My label</numIndex>
+                                    <numIndex index="1">0</numIndex>
+                                </numIndex>
+                                <numIndex index="1">
+                                    <numIndex index="0">My label 1</numIndex>
+                                    <numIndex index="1">1</numIndex>
+                                </numIndex>
+                            </items>
+                        </config>
+                    </settings.topNewsRestriction>
+                </el>
+            </ROOT>
+        </sDEF>
+    </sheets>
+</T3DataStructure>
+-----
+<T3DataStructure>
+    <sheets>
+        <sDEF>
+            <ROOT>
+                <sheetTitle>
+                    LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_tab.settings
+                </sheetTitle>
+                <type>array</type>
+                <el>
+                    <settings.topNewsRestriction>
+                        <label>
+                            LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_general.topNewsRestriction
+                        </label>
+                        <config>
+                            <type>select</type>
+                            <renderType>selectSingle</renderType>
+                            <items>
+                                <numIndex index="0">
+                                    <label>My label</label>
+                                    <value>0</value>
+                                </numIndex>
+                                <numIndex index="1">
+                                    <label>My label 1</label>
+                                    <value>1</value>
+                                </numIndex>
+                            </items>
+                        </config>
+                    </settings.topNewsRestriction>
+                </el>
+            </ROOT>
+        </sDEF>
+    </sheets>
+</T3DataStructure>
diff --git a/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture_check.xml.inc b/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture_check.xml.inc
new file mode 100644
index 000000000..d5da39dab
--- /dev/null
+++ b/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture_check.xml.inc
@@ -0,0 +1,57 @@
+<T3DataStructure>
+    <sheets>
+        <sDEF>
+            <ROOT>
+                <sheetTitle>
+                    LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_tab.settings
+                </sheetTitle>
+                <type>array</type>
+                <el>
+                    <settings.topNewsRestriction>
+                        <label>
+                            LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_general.topNewsRestriction
+                        </label>
+                        <config>
+                            <type>check</type>
+                            <items>
+                                <numIndex index="0">
+                                    <numIndex index="0">My label</numIndex>
+                                    <invertStateDisplay>1</invertStateDisplay>
+                                </numIndex>
+                            </items>
+                        </config>
+                    </settings.topNewsRestriction>
+                </el>
+            </ROOT>
+        </sDEF>
+    </sheets>
+</T3DataStructure>
+-----
+<T3DataStructure>
+    <sheets>
+        <sDEF>
+            <ROOT>
+                <sheetTitle>
+                    LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_tab.settings
+                </sheetTitle>
+                <type>array</type>
+                <el>
+                    <settings.topNewsRestriction>
+                        <label>
+                            LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_general.topNewsRestriction
+                        </label>
+                        <config>
+                            <type>check</type>
+                            <items>
+                                <numIndex index="0">
+                                    <label>My label</label>
+                                    <invertStateDisplay>1</invertStateDisplay>
+                                </numIndex>
+                            </items>
+                        </config>
+                    </settings.topNewsRestriction>
+                </el>
+            </ROOT>
+        </sDEF>
+    </sheets>
+</T3DataStructure>
diff --git a/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture_radio.xml.inc b/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture_radio.xml.inc
new file mode 100644
index 000000000..b1ac070c7
--- /dev/null
+++ b/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture_radio.xml.inc
@@ -0,0 +1,73 @@
+<T3DataStructure>
+    <sheets>
+        <sDEF>
+            <ROOT>
+                <sheetTitle>
+                    LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_tab.settings
+                </sheetTitle>
+                <type>array</type>
+                <el>
+                    <settings.topNewsRestriction>
+                        <label>
+                            LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_general.topNewsRestriction
+                        </label>
+                        <config>
+                            <type>radio</type>
+                            <items>
+                                <numIndex index="0">
+                                    <numIndex index="0">My label</numIndex>
+                                    <numIndex index="1">0</numIndex>
+                                </numIndex>
+                                <numIndex index="1">
+                                    <numIndex index="0">My label 1</numIndex>
+                                    <numIndex index="1">1</numIndex>
+                                </numIndex>
+                                <numIndex index="2">
+                                    <numIndex index="0">My label 2</numIndex>
+                                    <numIndex index="1">2</numIndex>
+                                </numIndex>
+                            </items>
+                        </config>
+                    </settings.topNewsRestriction>
+                </el>
+            </ROOT>
+        </sDEF>
+    </sheets>
+</T3DataStructure>
+-----
+<T3DataStructure>
+    <sheets>
+        <sDEF>
+            <ROOT>
+                <sheetTitle>
+                    LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_tab.settings
+                </sheetTitle>
+                <type>array</type>
+                <el>
+                    <settings.topNewsRestriction>
+                        <label>
+                            LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_general.topNewsRestriction
+                        </label>
+                        <config>
+                            <type>radio</type>
+                            <items>
+                                <numIndex index="0">
+                                    <label>My label</label>
+                                    <value>0</value>
+                                </numIndex>
+                                <numIndex index="1">
+                                    <label>My label 1</label>
+                                    <value>1</value>
+                                </numIndex>
+                                <numIndex index="2">
+                                    <label>My label 2</label>
+                                    <value>2</value>
+                                </numIndex>
+                            </items>
+                        </config>
+                    </settings.topNewsRestriction>
+                </el>
+            </ROOT>
+        </sDEF>
+    </sheets>
+</T3DataStructure>
diff --git a/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture_with_all_keys.xml.inc b/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture_with_all_keys.xml.inc
new file mode 100644
index 000000000..81fd46be3
--- /dev/null
+++ b/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/Fixture/fixture_with_all_keys.xml.inc
@@ -0,0 +1,79 @@
+<T3DataStructure>
+    <sheets>
+        <sDEF>
+            <ROOT>
+                <sheetTitle>
+                    LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_tab.settings
+                </sheetTitle>
+                <type>array</type>
+                <el>
+                    <settings.topNewsRestriction>
+                        <label>
+                            LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_general.topNewsRestriction
+                        </label>
+                        <config>
+                            <type>select</type>
+                            <renderType>selectSingle</renderType>
+                            <items>
+                                <numIndex index="0">
+                                    <numIndex index="0">My label</numIndex>
+                                    <numIndex index="1">0</numIndex>
+                                    <numIndex index="2">my-icon</numIndex>
+                                    <numIndex index="3">group1</numIndex>
+                                    <numIndex index="4">My Description</numIndex>
+                                </numIndex>
+                                <numIndex index="1">
+                                    <numIndex index="0">My label 1</numIndex>
+                                    <numIndex index="1">1</numIndex>
+                                    <numIndex index="2">my-icon</numIndex>
+                                    <numIndex index="3">group1</numIndex>
+                                    <numIndex index="4">My Description</numIndex>
+                                </numIndex>
+                            </items>
+                        </config>
+                    </settings.topNewsRestriction>
+                </el>
+            </ROOT>
+        </sDEF>
+    </sheets>
+</T3DataStructure>
+-----
+<T3DataStructure>
+    <sheets>
+        <sDEF>
+            <ROOT>
+                <sheetTitle>
+                    LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_tab.settings
+                </sheetTitle>
+                <type>array</type>
+                <el>
+                    <settings.topNewsRestriction>
+                        <label>
+                            LLL:EXT:news/Resources/Private/Language/locallang_be.xlf:flexforms_general.topNewsRestriction
+                        </label>
+                        <config>
+                            <type>select</type>
+                            <renderType>selectSingle</renderType>
+                            <items>
+                                <numIndex index="0">
+                                    <label>My label</label>
+                                    <value>0</value>
+                                    <icon>my-icon</icon>
+                                    <group>group1</group>
+                                    <description>My Description</description>
+                                </numIndex>
+                                <numIndex index="1">
+                                    <label>My label 1</label>
+                                    <value>1</value>
+                                    <icon>my-icon</icon>
+                                    <group>group1</group>
+                                    <description>My Description</description>
+                                </numIndex>
+                            </items>
+                        </config>
+                    </settings.topNewsRestriction>
+                </el>
+            </ROOT>
+        </sDEF>
+    </sheets>
+</T3DataStructure>
diff --git a/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/MigrateItemsToIndexedArrayKeysForFlexFormItemsRectorTest.php b/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/MigrateItemsToIndexedArrayKeysForFlexFormItemsRectorTest.php
new file mode 100644
index 000000000..52aaf60ce
--- /dev/null
+++ b/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/MigrateItemsToIndexedArrayKeysForFlexFormItemsRectorTest.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ssch\TYPO3Rector\Tests\Rector\v12\v3\flexform\MigrateItemsToIndexedArrayKeysForFlexFormItemsRector;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class MigrateItemsToIndexedArrayKeysForFlexFormItemsRectorTest 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/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/config/configured_rule.php b/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/config/configured_rule.php
new file mode 100644
index 000000000..098a57be9
--- /dev/null
+++ b/tests/Rector/v12/v3/flexform/MigrateItemsToIndexedArrayKeysForFlexFormItemsRector/config/configured_rule.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Ssch\TYPO3Rector\Rector\v12\v3\flexform\MigrateItemsToIndexedArrayKeysForFlexFormItemsRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->import(__DIR__ . '/../../../../../../../config/config_test.php');
+    $rectorConfig->rule(MigrateItemsToIndexedArrayKeysForFlexFormItemsRector::class);
+};