[TASK] Add RemoveUseCacheHashFromTypolink fractor

Author: andreaswolf

packages/typo3-fractor/composer.json

@@ -17,6 +17,7 @@
         "a9f/fractor-doc-generator": "^0.2",
         "a9f/fractor-extension-installer": "^0.2",
         "a9f/fractor-fluid": "^0.2",
+        "a9f/fractor-typoscript": "^0.2",
         "a9f/fractor-xml": "^0.2",
         "a9f/fractor-yaml": "^0.2"
     },

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

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use a9f\Typo3Fractor\TYPO3v10\Fluid\RemoveNoCacheHashAndUseCacheHashAttributeFractor;
+use a9f\Typo3Fractor\TYPO3v10\TypoScript\RemoveUseCacheHashFromTypolink;
 use a9f\Typo3Fractor\TYPO3v10\Yaml\EmailFinisherFractor;
 use a9f\Typo3Fractor\TYPO3v10\Yaml\TranslationFileFractor;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
@@ -16,4 +17,5 @@
     $services->set(EmailFinisherFractor::class);
     $services->set(TranslationFileFractor::class);
     $services->set(RemoveNoCacheHashAndUseCacheHashAttributeFractor::class);
+    $services->set(RemoveUseCacheHashFromTypolink::class);
 };

packages/typo3-fractor/rules-tests/TYPO3v10/TypoScript/RemoveUseCacheHashFromTypolink/Fixtures/fixture.typoscript

@@ -0,0 +1,23 @@
+page = PAGE
+page.10 = TEXT
+page.10.value = Link to page 23
+page.10.typolink {
+    parameter = 23
+    useCacheHash = 1
+}
+
+page.20 = TEXT
+page.20.value = Link to page 42
+page.20.typolink.parameter = 42
+page.20.typolink.useCacheHash = 1
+-----
+page = PAGE
+page.10 = TEXT
+page.10.value = Link to page 23
+page.10.typolink {
+    parameter = 23
+}
+
+page.20 = TEXT
+page.20.value = Link to page 42
+page.20.typolink.parameter = 42

packages/typo3-fractor/rules-tests/TYPO3v10/TypoScript/RemoveUseCacheHashFromTypolink/RemoveUseCacheHashFromTypolinkTest.php

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

packages/typo3-fractor/rules-tests/TYPO3v10/TypoScript/RemoveUseCacheHashFromTypolink/config/fractor.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use a9f\Fractor\Configuration\FractorConfiguration;
+use a9f\Typo3Fractor\TYPO3v10\TypoScript\RemoveUseCacheHashFromTypolink;
+
+return FractorConfiguration::configure()
+    ->withRules([RemoveUseCacheHashFromTypolink::class]);

packages/typo3-fractor/rules/TYPO3v10/TypoScript/RemoveUseCacheHashFromTypolink.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Typo3Fractor\TYPO3v10\TypoScript;
+
+use a9f\FractorTypoScript\AbstractTypoScriptFractor;
+use a9f\FractorTypoScript\TypoScriptStatementsIterator;
+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/10.0/Deprecation-88406-SetCacheHashnoCacheHashOptionsInViewHelpersAndUriBuilder.html
+ */
+final class RemoveUseCacheHashFromTypolink extends AbstractTypoScriptFractor
+{
+    public function refactor(Statement $statement): null|Statement|int
+    {
+        if (! $statement instanceof Assignment) {
+            return $statement;
+        }
+
+        // for some weird reason, "foo.bar.baz = 1" leads to "relativeName" being "foo.bar.baz"
+        if (! str_ends_with($statement->object->absoluteName, '.typolink.useCacheHash')) {
+            return $statement;
+        }
+
+        $this->hasChanged = true;
+        return TypoScriptStatementsIterator::REMOVE_NODE;
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Remove useCacheHash TypoScript setting', [new CodeSample(
+            <<<'CODE_SAMPLE'
+typolink {
+    parameter = 3
+    useCacheHash = 1
+}
+CODE_SAMPLE
+            ,
+            <<<'CODE_SAMPLE'
+typolink {
+    parameter = 3
+}
+CODE_SAMPLE
+        )]);
+    }
+}