[FEATURE] Add MigrateLegacyFormTemplatesFractor (#373)

Resolves: sabbelasichon/typo3-rector#4586

Author: simonschaufi

packages/typo3-fractor/config/typo3-14.php

@@ -12,6 +12,7 @@
 use a9f\Typo3Fractor\TYPO3v14\TypoScript\RemoveFrontendAssetConcatenationAndCompressionFractor;
 use a9f\Typo3Fractor\TYPO3v14\TypoScript\RemoveModWebLayoutDefLangBindingFractor;
 use a9f\Typo3Fractor\TYPO3v14\TypoScript\RemoveUserTSConfigAuthBeRedirectToURLFractor;
+use a9f\Typo3Fractor\TYPO3v14\Yaml\MigrateLegacyFormTemplatesFractor;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 
 return static function (ContainerConfigurator $containerConfigurator): void {
@@ -30,4 +31,5 @@
     $services->set(RemoveExternalOptionFromTypoScriptFractor::class);
     $services->set(RemoveUserTSConfigAuthBeRedirectToURLFractor::class);
     $services->set(RemoveDuplicateDoktypeRestrictionConfigurationFractor::class);
+    $services->set(MigrateLegacyFormTemplatesFractor::class);
 };

packages/typo3-fractor/docs/typo3-fractor-rules.md

@@ -1,4 +1,4 @@
-# 40 Rules Overview
+# 41 Rules Overview
 
 ## AbstractMessageGetSeverityFluidFractor
 
@@ -249,6 +249,35 @@ Migrates indexed item array keys to associative for type select, radio and check
 
 <br>
 
+## MigrateLegacyFormTemplatesFractor
+
+Migrate legacy form templates
+
+- class: [`a9f\Typo3Fractor\TYPO3v14\Yaml\MigrateLegacyFormTemplatesFractor`](../rules/TYPO3v14/Yaml/MigrateLegacyFormTemplatesFractor.php)
+
+```diff
+ prototypes:
+   standard:
+     formElementsDefinition:
+       Text:
+-        variants:
+-          -
+-            identifier: template-variant
+-            condition: 'getRootFormProperty("renderingOptions.templateVariant") == "version2"'
+-            properties:
+-              containerClassAttribute: 'form-element form-element-text mb-3'
+-              elementClassAttribute: form-control
+-              elementErrorClassAttribute: ~
+-              labelClassAttribute: form-label
++        properties:
++          containerClassAttribute: 'form-element form-element-text mb-3'
++          elementClassAttribute: form-control
++          elementErrorClassAttribute: ~
++          labelClassAttribute: form-label
+```
+
+<br>
+
 ## MigrateNullFlagFlexFormFractor
 
 Migrate null flag

packages/typo3-fractor/rules-tests/TYPO3v14/Yaml/MigrateLegacyFormTemplatesFractor/Fixtures/fixture.yaml.fixture

@@ -0,0 +1,23 @@
+prototypes:
+  standard:
+    formElementsDefinition:
+      Text:
+        variants:
+          -
+            identifier: template-variant
+            condition: 'getRootFormProperty("renderingOptions.templateVariant") == "version2"'
+            properties:
+              containerClassAttribute: 'form-element form-element-text mb-3'
+              elementClassAttribute: form-control
+              elementErrorClassAttribute: ~
+              labelClassAttribute: form-label
+-----
+prototypes:
+  standard:
+    formElementsDefinition:
+      Text:
+        properties:
+          containerClassAttribute: 'form-element form-element-text mb-3'
+          elementClassAttribute: form-control
+          elementErrorClassAttribute: null
+          labelClassAttribute: form-label

packages/typo3-fractor/rules-tests/TYPO3v14/Yaml/MigrateLegacyFormTemplatesFractor/MigrateLegacyFormTemplatesFractorTest.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Typo3Fractor\Tests\TYPO3v14\Yaml\MigrateLegacyFormTemplatesFractor;
+
+use a9f\Fractor\Testing\PHPUnit\AbstractFractorTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+
+final class MigrateLegacyFormTemplatesFractorTest extends AbstractFractorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): \Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixtures', '*.yaml.fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/fractor.php';
+    }
+}

packages/typo3-fractor/rules-tests/TYPO3v14/Yaml/MigrateLegacyFormTemplatesFractor/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\TYPO3v14\Yaml\MigrateLegacyFormTemplatesFractor;
+
+return FractorConfiguration::configure()
+    ->withOptions([
+        XmlProcessorOption::INDENT_CHARACTER => Indent::STYLE_TAB,
+        XmlProcessorOption::INDENT_SIZE => 1,
+    ])
+    ->withRules([MigrateLegacyFormTemplatesFractor::class]);

packages/typo3-fractor/rules/TYPO3v14/Yaml/MigrateLegacyFormTemplatesFractor.php

@@ -0,0 +1,105 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Typo3Fractor\TYPO3v14\Yaml;
+
+use a9f\FractorYaml\Contract\YamlFractorRule;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @changelog https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/14.0/Breaking-106596-RemoveLegacyFormTemplates.html
+ * @see \a9f\Typo3Fractor\Tests\TYPO3v14\Yaml\MigrateLegacyFormTemplatesFractor\MigrateLegacyFormTemplatesFractorTest
+ */
+final class MigrateLegacyFormTemplatesFractor implements YamlFractorRule
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Migrate legacy form templates', [new CodeSample(
+            <<<'CODE_SAMPLE'
+prototypes:
+  standard:
+    formElementsDefinition:
+      Text:
+        variants:
+          -
+            identifier: template-variant
+            condition: 'getRootFormProperty("renderingOptions.templateVariant") == "version2"'
+            properties:
+              containerClassAttribute: 'form-element form-element-text mb-3'
+              elementClassAttribute: form-control
+              elementErrorClassAttribute: ~
+              labelClassAttribute: form-label
+CODE_SAMPLE
+            ,
+            <<<'CODE_SAMPLE'
+prototypes:
+  standard:
+    formElementsDefinition:
+      Text:
+        properties:
+          containerClassAttribute: 'form-element form-element-text mb-3'
+          elementClassAttribute: form-control
+          elementErrorClassAttribute: ~
+          labelClassAttribute: form-label
+CODE_SAMPLE
+        )]);
+    }
+
+    public function refactor(array $yaml): array
+    {
+        return $this->traverse($yaml);
+    }
+
+    /**
+     * @param mixed[] $yaml
+     * @return mixed[]
+     */
+    private function traverse(array $yaml): array
+    {
+        foreach ($yaml as $key => $value) {
+            if (is_array($value)) {
+                $yaml[$key] = $this->traverse($value);
+            }
+        }
+
+        if (isset($yaml['variants']) && is_array($yaml['variants'])) {
+            $properties = $yaml['properties'] ?? [];
+            $remainingVariants = [];
+            $hasChanges = false;
+
+            foreach ($yaml['variants'] as $variant) {
+                // Check if the variant condition matches the deprecated one
+                if (isset($variant['condition']) && $this->isVersion2Condition($variant['condition'])) {
+                    if (isset($variant['properties']) && is_array($variant['properties'])) {
+                        // Merge properties: variant properties overwrite existing ones
+                        $properties = array_replace_recursive($properties, $variant['properties']);
+                    }
+                    $hasChanges = true;
+                } else {
+                    $remainingVariants[] = $variant;
+                }
+            }
+
+            if ($hasChanges) {
+                $yaml['properties'] = $properties;
+
+                if ($remainingVariants === []) {
+                    unset($yaml['variants']);
+                } else {
+                    $yaml['variants'] = $remainingVariants;
+                }
+            }
+        }
+
+        return $yaml;
+    }
+
+    private function isVersion2Condition(string $condition): bool
+    {
+        // Normalize quotes and whitespace for comparison
+        $normalized = str_replace(["'", ' '], ['"', ''], $condition);
+        return $normalized === 'getRootFormProperty("renderingOptions.templateVariant")=="version2"';
+    }
+}