[TASK] Add MigrateTypoScriptConditionGetTSFEFractor (#360)

Resolves: sabbelasichon/typo3-rector#4653

Author: simonschaufi

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

@@ -4,6 +4,7 @@
 
 use a9f\Typo3Fractor\TYPO3v14\Fluid\ChangeLogoutHandlingInFeLoginFractor;
 use a9f\Typo3Fractor\TYPO3v14\Htaccess\RemoveUploadsFromDefaultHtaccessFractor;
+use a9f\Typo3Fractor\TYPO3v14\TypoScript\MigrateTypoScriptConditionGetTSFEFractor;
 use a9f\Typo3Fractor\TYPO3v14\TypoScript\RemoveExposeNonexistentUserInForgotPasswordDialogSettingInFeLoginFractor;
 use a9f\Typo3Fractor\TYPO3v14\TypoScript\RemoveModWebLayoutDefLangBindingFractor;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
@@ -18,4 +19,5 @@
     $services->set(RemoveModWebLayoutDefLangBindingFractor::class);
     $services->set(ChangeLogoutHandlingInFeLoginFractor::class);
     $services->set(RemoveUploadsFromDefaultHtaccessFractor::class);
+    $services->set(MigrateTypoScriptConditionGetTSFEFractor::class);
 };

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

@@ -1,4 +1,4 @@
-# 34 Rules Overview
+# 35 Rules Overview
 
 ## AbstractMessageGetSeverityFluidFractor
 
@@ -418,6 +418,21 @@ Migrates option cols to size for TCA type none
 
 <br>
 
+## MigrateTypoScriptConditionGetTSFEFractor
+
+Migrate TypoScript condition function `getTSFE()`
+
+- class: [`a9f\Typo3Fractor\TYPO3v14\TypoScript\MigrateTypoScriptConditionGetTSFEFractor`](../rules/TYPO3v14/TypoScript/MigrateTypoScriptConditionGetTSFEFractor.php)
+
+```diff
+-[getTSFE() && getTSFE().id == 42]
++[request?.getPageArguments()?.getPageId() == 42]
+     temp.foo = 42
+ [end]
+```
+
+<br>
+
 ## RemoveConfigDisablePageExternalUrlFractor
 
 Remove config.disablePageExternalUrl

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

@@ -0,0 +1,23 @@
+[getTSFE() && getTSFE().id == 42]
+    temp.foo = 42
+[end]
+
+[getTSFE().id == 43]
+    temp.foo = 43
+[end]
+
+[getTSFE()?.id == 44]
+    temp.foo = 44
+[end]
+-----
+[request?.getPageArguments()?.getPageId() == 42]
+    temp.foo = 42
+[end]
+
+[request?.getPageArguments()?.getPageId() == 43]
+    temp.foo = 43
+[end]
+
+[request?.getPageArguments()?.getPageId() == 44]
+    temp.foo = 44
+[end]

packages/typo3-fractor/rules-tests/TYPO3v14/TypoScript/MigrateTypoScriptConditionGetTSFEFractor/MigrateTypoScriptConditionGetTSFEFractorTest.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Typo3Fractor\Tests\TYPO3v14\TypoScript\MigrateTypoScriptConditionGetTSFEFractor;
+
+use a9f\Fractor\Testing\PHPUnit\AbstractFractorTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+
+final class MigrateTypoScriptConditionGetTSFEFractorTest 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/MigrateTypoScriptConditionGetTSFEFractor/config/fractor.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+use a9f\Fractor\Configuration\FractorConfiguration;
+use a9f\FractorTypoScript\Configuration\TypoScriptProcessorOption;
+use a9f\Typo3Fractor\TYPO3v14\TypoScript\MigrateTypoScriptConditionGetTSFEFractor;
+use Helmich\TypoScriptParser\Parser\Printer\PrettyPrinterConditionTermination;
+use Helmich\TypoScriptParser\Parser\Printer\PrettyPrinterConfiguration;
+
+return FractorConfiguration::configure()
+    ->withRules([MigrateTypoScriptConditionGetTSFEFractor::class])
+    ->withOptions([
+        TypoScriptProcessorOption::INDENT_SIZE => 4,
+        TypoScriptProcessorOption::INDENT_CHARACTER => PrettyPrinterConfiguration::INDENTATION_STYLE_SPACES,
+        TypoScriptProcessorOption::ADD_CLOSING_GLOBAL => false,
+        TypoScriptProcessorOption::INCLUDE_EMPTY_LINE_BREAKS => true,
+        TypoScriptProcessorOption::INDENT_CONDITIONS => true,
+        TypoScriptProcessorOption::CONDITION_TERMINATION => PrettyPrinterConditionTermination::Keep,
+    ]);

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

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Typo3Fractor\TYPO3v14\TypoScript;
+
+use a9f\FractorTypoScript\AbstractTypoScriptFractor;
+use Helmich\TypoScriptParser\Parser\AST\ConditionalStatement;
+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/Breaking-107473-TypoScriptConditionFunctionGetTSFERemoved.html
+ * @see \a9f\Typo3Fractor\Tests\TYPO3v14\TypoScript\MigrateTypoScriptConditionGetTSFEFractor\MigrateTypoScriptConditionGetTSFEFractorTest
+ */
+final class MigrateTypoScriptConditionGetTSFEFractor extends AbstractTypoScriptFractor
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Migrate TypoScript condition function getTSFE()', [new CodeSample(
+            <<<'CODE_SAMPLE'
+[getTSFE() && getTSFE().id == 42]
+    temp.foo = 42
+[end]
+CODE_SAMPLE
+            ,
+            <<<'CODE_SAMPLE'
+[request?.getPageArguments()?.getPageId() == 42]
+    temp.foo = 42
+[end]
+CODE_SAMPLE
+        )]);
+    }
+
+    public function refactor(Statement $statement): ?Statement
+    {
+        if ($this->shouldSkip($statement)) {
+            return null;
+        }
+
+        /** @var ConditionalStatement $statement */
+        $condition = str_replace('getTSFE() && ', '', $statement->condition);
+
+        $statement->condition = str_replace(
+            ['getTSFE().id', 'getTSFE()?.id'],
+            'request?.getPageArguments()?.getPageId()',
+            $condition
+        );
+
+        return $statement;
+    }
+
+    private function shouldSkip(Statement $statement): bool
+    {
+        if (! $statement instanceof ConditionalStatement) {
+            return true;
+        }
+
+        if (! str_contains($statement->condition, 'getTSFE')) {
+            return true;
+        }
+
+        return false;
+    }
+}