[FEATURE] Add MigrateTypoScriptGetDataPathFractor (#369)

Resolves: sabbelasichon/typo3-rector#327

Author: simonschaufi

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

@@ -5,6 +5,7 @@
 use a9f\Typo3Fractor\TYPO3v14\Fluid\ChangeLogoutHandlingInFeLoginFractor;
 use a9f\Typo3Fractor\TYPO3v14\Htaccess\RemoveUploadsFromDefaultHtaccessFractor;
 use a9f\Typo3Fractor\TYPO3v14\TypoScript\MigrateTypoScriptConditionGetTSFEFractor;
+use a9f\Typo3Fractor\TYPO3v14\TypoScript\MigrateTypoScriptGetDataPathFractor;
 use a9f\Typo3Fractor\TYPO3v14\TypoScript\RemoveExposeNonexistentUserInForgotPasswordDialogSettingInFeLoginFractor;
 use a9f\Typo3Fractor\TYPO3v14\TypoScript\RemoveFrontendAssetConcatenationAndCompressionFractor;
 use a9f\Typo3Fractor\TYPO3v14\TypoScript\RemoveModWebLayoutDefLangBindingFractor;
@@ -22,4 +23,5 @@
     $services->set(RemoveUploadsFromDefaultHtaccessFractor::class);
     $services->set(MigrateTypoScriptConditionGetTSFEFractor::class);
     $services->set(RemoveFrontendAssetConcatenationAndCompressionFractor::class);
+    $services->set(MigrateTypoScriptGetDataPathFractor::class);
 };

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

@@ -1,4 +1,4 @@
-# 36 Rules Overview
+# 37 Rules Overview
 
 ## AbstractMessageGetSeverityFluidFractor
 
@@ -433,6 +433,22 @@ Migrate TypoScript condition function `getTSFE()`
 
 <br>
 
+## MigrateTypoScriptGetDataPathFractor
+
+Migrate TypoScript getData \"path\"
+
+- class: [`a9f\Typo3Fractor\TYPO3v14\TypoScript\MigrateTypoScriptGetDataPathFractor`](../rules/TYPO3v14/TypoScript/MigrateTypoScriptGetDataPathFractor.php)
+
+```diff
+ page.20 = TEXT
+ page.20 {
+-    data = path : EXT:core/Resources/Public/Icons/Extension.svg
++    data = asset : EXT:core/Resources/Public/Icons/Extension.svg
+ }
+```
+
+<br>
+
 ## RemoveConfigDisablePageExternalUrlFractor
 
 Remove config.disablePageExternalUrl

packages/typo3-fractor/rules-tests/TYPO3v14/TypoScript/MigrateTypoScriptGetDataPathFractor/Fixtures/fixture.typoscript.fixture

@@ -0,0 +1,9 @@
+page.20 = TEXT
+page.20 {
+    data = path : EXT:core/Resources/Public/Icons/Extension.svg
+}
+-----
+page.20 = TEXT
+page.20 {
+    data = asset : EXT:core/Resources/Public/Icons/Extension.svg
+}

packages/typo3-fractor/rules-tests/TYPO3v14/TypoScript/MigrateTypoScriptGetDataPathFractor/Fixtures/fixture2.typoscript.fixture

@@ -0,0 +1,5 @@
+page.20 = TEXT
+page.20.data = path:EXT:core/Resources/Public/Icons/Extension.svg
+-----
+page.20 = TEXT
+page.20.data = asset:EXT:core/Resources/Public/Icons/Extension.svg

packages/typo3-fractor/rules-tests/TYPO3v14/TypoScript/MigrateTypoScriptGetDataPathFractor/MigrateTypoScriptGetDataPathFractorTest.php

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

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

packages/typo3-fractor/rules/TYPO3v14/TypoScript/MigrateTypoScriptGetDataPathFractor.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Typo3Fractor\TYPO3v14\TypoScript;
+
+use a9f\FractorTypoScript\AbstractTypoScriptFractor;
+use Helmich\TypoScriptParser\Parser\AST\Operator\Assignment;
+use Helmich\TypoScriptParser\Parser\AST\Statement;
+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/Deprecation-107537-GetDataPath.html
+ * @see \a9f\Typo3Fractor\Tests\TYPO3v14\TypoScript\MigrateTypoScriptGetDataPathFractor\MigrateTypoScriptGetDataPathFractorTest
+ */
+final class MigrateTypoScriptGetDataPathFractor extends AbstractTypoScriptFractor
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Migrate TypoScript getData \"path\"', [new CodeSample(
+            <<<'CODE_SAMPLE'
+page.20 = TEXT
+page.20 {
+    data = path : EXT:core/Resources/Public/Icons/Extension.svg
+}
+CODE_SAMPLE
+            ,
+            <<<'CODE_SAMPLE'
+page.20 = TEXT
+page.20 {
+    data = asset : EXT:core/Resources/Public/Icons/Extension.svg
+}
+CODE_SAMPLE
+        )]);
+    }
+
+    public function refactor(Statement $statement): ?Statement
+    {
+        if (! $statement instanceof Assignment) {
+            return null;
+        }
+
+        if (! str_ends_with($statement->object->relativeName, 'data')) {
+            return null;
+        }
+
+        $scalar = $statement->value;
+
+        if (preg_match('/^\s*path\s*:/i', $scalar->value)) {
+            $scalar->value = (string) preg_replace('/^(\s*)path(\s*:)/i', '$1asset$2', $scalar->value);
+            return $statement;
+        }
+
+        return null;
+    }
+}