From d6c7120808de9925bb797bb2a666be5bc38e1cd7 Mon Sep 17 00:00:00 2001
From: Sebastian Schreiber <me@schreibersebastian.de>
Date: Wed, 14 Jun 2023 15:29:30 +0200
Subject: [PATCH] TASK: Add rule RemoveTableLocalPropertyRector

Resolves: #3414
---
 config/v12/tca-120.php                        |   1 +
 .../v0/tca/RemoveTableLocalPropertyRector.php |  86 +++++++++++++
 .../Fixture/fixture.php.inc                   | 120 ++++++++++++++++++
 .../RemoveTableLocalPropertyRectorTest.php    |  32 +++++
 .../config/configured_rule.php                |  11 ++
 5 files changed, 250 insertions(+)
 create mode 100644 src/Rector/v12/v0/tca/RemoveTableLocalPropertyRector.php
 create mode 100644 tests/Rector/v12/v0/tca/RemoveTableLocalPropertyRector/Fixture/fixture.php.inc
 create mode 100644 tests/Rector/v12/v0/tca/RemoveTableLocalPropertyRector/RemoveTableLocalPropertyRectorTest.php
 create mode 100644 tests/Rector/v12/v0/tca/RemoveTableLocalPropertyRector/config/configured_rule.php

diff --git a/config/v12/tca-120.php b/config/v12/tca-120.php
index 5da470826..af59e68b2 100644
--- a/config/v12/tca-120.php
+++ b/config/v12/tca-120.php
@@ -18,4 +18,5 @@
     $rectorConfig->rule(MigrateRequiredFlagRector::class);
     $rectorConfig->rule(RemoveTCAInterfaceAlwaysDescriptionRector::class);
     $rectorConfig->rule(RemoveCruserIdRector::class);
+    $rectorConfig->rule(\Ssch\TYPO3Rector\Rector\v12\v0\tca\RemoveTableLocalPropertyRector::class);
 };
diff --git a/src/Rector/v12/v0/tca/RemoveTableLocalPropertyRector.php b/src/Rector/v12/v0/tca/RemoveTableLocalPropertyRector.php
new file mode 100644
index 000000000..6545f85f1
--- /dev/null
+++ b/src/Rector/v12/v0/tca/RemoveTableLocalPropertyRector.php
@@ -0,0 +1,86 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ssch\TYPO3Rector\Rector\v12\v0\tca;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\Array_;
+use PhpParser\Node\Expr\ArrayItem;
+use Rector\Core\Rector\AbstractRector;
+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/Breaking-98479-RemovedFileReferenceRelatedFunctionality.html
+ * @see \Ssch\TYPO3Rector\Tests\Rector\v12\v0\tca\RemoveTableLocalPropertyRector\RemoveTableLocalPropertyRectorTest
+ */
+final class RemoveTableLocalPropertyRector extends AbstractRector
+{
+    public function getNodeTypes(): array
+    {
+        return [Expr\ArrayItem::class];
+    }
+
+    /**
+     * @param ArrayItem $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (null === $node->key) {
+            return null;
+        }
+
+        if (! $this->valueResolver->isValue($node->key, 'foreign_match_fields')) {
+            return null;
+        }
+
+        if (! $node->value instanceof Array_) {
+            return null;
+        }
+
+        foreach ($node->value->items as $item) {
+            if (null === $item) {
+                continue;
+            }
+
+            if (null === $item->key) {
+                continue;
+            }
+
+            if ($this->valueResolver->isValue($item->key, 'table_local')) {
+                $this->removeNode($item);
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Remove TCA property table_local in foreign_match_fields', [new CodeSample(
+            <<<'CODE_SAMPLE'
+'foreign_match_fields' => [
+    'fieldname' => 'media',
+    'tablenames' => 'tx_site_domain_model_mediacollection',
+    'table_local' => 'sys_file',
+],
+'maxitems' => 1,
+'minitems' => 1,
+CODE_SAMPLE
+            ,
+            <<<'CODE_SAMPLE'
+'foreign_match_fields' => [
+    'fieldname' => 'media',
+    'tablenames' => 'tx_site_domain_model_mediacollection',
+],
+'maxitems' => 1,
+'minitems' => 1,
+CODE_SAMPLE
+        )]);
+    }
+}
diff --git a/tests/Rector/v12/v0/tca/RemoveTableLocalPropertyRector/Fixture/fixture.php.inc b/tests/Rector/v12/v0/tca/RemoveTableLocalPropertyRector/Fixture/fixture.php.inc
new file mode 100644
index 000000000..73bb433da
--- /dev/null
+++ b/tests/Rector/v12/v0/tca/RemoveTableLocalPropertyRector/Fixture/fixture.php.inc
@@ -0,0 +1,120 @@
+<?php
+
+namespace Ssch\TYPO3Rector\Tests\Rector\v12\v0\tca\RemoveTableLocalPropertyRector\Fixture;
+
+use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
+
+return [
+    'ctrl' => [],
+    'columns' => [
+        'images' => [
+            'exclude' => 1,
+            'label' => 'Bilder',
+            'config' => ExtensionManagementUtility::getFileFieldTCAConfig(
+                'images',
+                [
+                    'appearance' => [
+                        'createNewRelationLinkTitle' => 'LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:images.addFileReference',
+                        'showPossibleLocalizationRecords' => true,
+                        'showRemovedLocalizationRecords' => true,
+                        'showAllLocalizationLink' => true,
+                        'showSynchronizationLink' => true,
+                    ],
+                    'foreign_match_fields' => [
+                        'fieldname' => 'images',
+                        'tablenames' => 'tx_aknwevents_domain_model_event',
+                        'table_local' => 'sys_file',
+                    ],
+                    'minitems' => 0,
+                    'maxitems' => 999,
+                ],
+                $GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext']
+            ),
+        ],
+        'images2' => [
+            'exclude' => 1,
+            'label' => 'Bilder',
+            'config' => ExtensionManagementUtility::getFileFieldTCAConfig(
+                'images',
+                [
+                    'appearance' => [
+                        'createNewRelationLinkTitle' => 'LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:images.addFileReference',
+                        'showPossibleLocalizationRecords' => true,
+                        'showRemovedLocalizationRecords' => true,
+                        'showAllLocalizationLink' => true,
+                        'showSynchronizationLink' => true,
+                    ],
+                    'foreign_match_fields' => [
+                        'fieldname' => 'images',
+                        'tablenames' => 'tx_aknwevents_domain_model_event',
+                    ],
+                    'minitems' => 0,
+                    'maxitems' => 999,
+                ],
+                $GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext']
+            ),
+        ],
+    ],
+];
+
+?>
+-----
+<?php
+
+namespace Ssch\TYPO3Rector\Tests\Rector\v12\v0\tca\RemoveTableLocalPropertyRector\Fixture;
+
+use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
+
+return [
+    'ctrl' => [],
+    'columns' => [
+        'images' => [
+            'exclude' => 1,
+            'label' => 'Bilder',
+            'config' => ExtensionManagementUtility::getFileFieldTCAConfig(
+                'images',
+                [
+                    'appearance' => [
+                        'createNewRelationLinkTitle' => 'LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:images.addFileReference',
+                        'showPossibleLocalizationRecords' => true,
+                        'showRemovedLocalizationRecords' => true,
+                        'showAllLocalizationLink' => true,
+                        'showSynchronizationLink' => true,
+                    ],
+                    'foreign_match_fields' => [
+                        'fieldname' => 'images',
+                        'tablenames' => 'tx_aknwevents_domain_model_event',
+                    ],
+                    'minitems' => 0,
+                    'maxitems' => 999,
+                ],
+                $GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext']
+            ),
+        ],
+        'images2' => [
+            'exclude' => 1,
+            'label' => 'Bilder',
+            'config' => ExtensionManagementUtility::getFileFieldTCAConfig(
+                'images',
+                [
+                    'appearance' => [
+                        'createNewRelationLinkTitle' => 'LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:images.addFileReference',
+                        'showPossibleLocalizationRecords' => true,
+                        'showRemovedLocalizationRecords' => true,
+                        'showAllLocalizationLink' => true,
+                        'showSynchronizationLink' => true,
+                    ],
+                    'foreign_match_fields' => [
+                        'fieldname' => 'images',
+                        'tablenames' => 'tx_aknwevents_domain_model_event',
+                    ],
+                    'minitems' => 0,
+                    'maxitems' => 999,
+                ],
+                $GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext']
+            ),
+        ],
+    ],
+];
+
+?>
diff --git a/tests/Rector/v12/v0/tca/RemoveTableLocalPropertyRector/RemoveTableLocalPropertyRectorTest.php b/tests/Rector/v12/v0/tca/RemoveTableLocalPropertyRector/RemoveTableLocalPropertyRectorTest.php
new file mode 100644
index 000000000..016fe2597
--- /dev/null
+++ b/tests/Rector/v12/v0/tca/RemoveTableLocalPropertyRector/RemoveTableLocalPropertyRectorTest.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ssch\TYPO3Rector\Tests\Rector\v12\v0\tca\RemoveTableLocalPropertyRector;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class RemoveTableLocalPropertyRectorTest 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');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}
diff --git a/tests/Rector/v12/v0/tca/RemoveTableLocalPropertyRector/config/configured_rule.php b/tests/Rector/v12/v0/tca/RemoveTableLocalPropertyRector/config/configured_rule.php
new file mode 100644
index 000000000..ea7770fbf
--- /dev/null
+++ b/tests/Rector/v12/v0/tca/RemoveTableLocalPropertyRector/config/configured_rule.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Ssch\TYPO3Rector\Rector\v12\v0\tca\RemoveTableLocalPropertyRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->import(__DIR__ . '/../../../../../../../config/config_test.php');
+    $rectorConfig->rule(RemoveTableLocalPropertyRector::class);
+};