[FEATURE] Add RemoveExternalOptionFromTypoScriptFractor (#370)

Resolves: sabbelasichon/typo3-rector#4743

Author: simonschaufi

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

@@ -7,6 +7,7 @@
 use a9f\Typo3Fractor\TYPO3v14\TypoScript\MigrateTypoScriptConditionGetTSFEFractor;
 use a9f\Typo3Fractor\TYPO3v14\TypoScript\MigrateTypoScriptGetDataPathFractor;
 use a9f\Typo3Fractor\TYPO3v14\TypoScript\RemoveExposeNonexistentUserInForgotPasswordDialogSettingInFeLoginFractor;
+use a9f\Typo3Fractor\TYPO3v14\TypoScript\RemoveExternalOptionFromTypoScriptFractor;
 use a9f\Typo3Fractor\TYPO3v14\TypoScript\RemoveFrontendAssetConcatenationAndCompressionFractor;
 use a9f\Typo3Fractor\TYPO3v14\TypoScript\RemoveModWebLayoutDefLangBindingFractor;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
@@ -24,4 +25,5 @@
     $services->set(MigrateTypoScriptConditionGetTSFEFractor::class);
     $services->set(RemoveFrontendAssetConcatenationAndCompressionFractor::class);
     $services->set(MigrateTypoScriptGetDataPathFractor::class);
+    $services->set(RemoveExternalOptionFromTypoScriptFractor::class);
 };

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

@@ -1,4 +1,4 @@
-# 37 Rules Overview
+# 38 Rules Overview
 
 ## AbstractMessageGetSeverityFluidFractor
 
@@ -527,6 +527,25 @@ Remove plugin.tx_felogin_login.settings.exposeNonexistentUserInForgotPasswordDia
 
 <br>
 
+## RemoveExternalOptionFromTypoScriptFractor
+
+Remove "external" option from TypoScript
+
+- class: [`a9f\Typo3Fractor\TYPO3v14\TypoScript\RemoveExternalOptionFromTypoScriptFractor`](../rules/TYPO3v14/TypoScript/RemoveExternalOptionFromTypoScriptFractor.php)
+
+```diff
+ page = PAGE
+ page.includeCSS {
+     main = https://example.com/styles/main.css
+-    main.external = 1
+-    other = /styles/main.css
+-    other.external = 1
++    other = URI:/styles/main.css
+ }
+```
+
+<br>
+
 ## RemoveFrontendAssetConcatenationAndCompressionFractor
 
 Remove Frontend Asset Concatenation and Compression

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

@@ -0,0 +1,63 @@
+page = PAGE
+page.includeCSS {
+    main = https://example.com/styles/main.css
+    main.external = 1
+    other = /styles/main.css
+    other.external = 1
+}
+page.includeCSSLibs {
+    main = https://example.com/styles/main.css
+    main.external = 1
+    other = /styles/main.css
+    other.external = 1
+}
+page.includeJS {
+    main = https://example.com/styles/main.css
+    main.external = 1
+    other = /styles/main.css
+    other.external = 1
+}
+page.includeJSFooter {
+    main = https://example.com/styles/main.css
+    main.external = 1
+    other = /styles/main.css
+    other.external = 1
+}
+page.includeJSFooterlibs {
+    main = https://example.com/styles/main.css
+    main.external = 1
+    other = /styles/main.css
+    other.external = 1
+}
+page.includeJSLibs {
+    main = https://example.com/styles/main.css
+    main.external = 1
+    other = /styles/main.css
+    other.external = 1
+}
+-----
+page = PAGE
+page.includeCSS {
+    main = https://example.com/styles/main.css
+    other = URI:/styles/main.css
+}
+page.includeCSSLibs {
+    main = https://example.com/styles/main.css
+    other = URI:/styles/main.css
+}
+page.includeJS {
+    main = https://example.com/styles/main.css
+    other = URI:/styles/main.css
+}
+page.includeJSFooter {
+    main = https://example.com/styles/main.css
+    other = URI:/styles/main.css
+}
+page.includeJSFooterlibs {
+    main = https://example.com/styles/main.css
+    other = URI:/styles/main.css
+}
+page.includeJSLibs {
+    main = https://example.com/styles/main.css
+    other = URI:/styles/main.css
+}

packages/typo3-fractor/rules-tests/TYPO3v14/TypoScript/RemoveExternalOptionFromTypoScriptFractor/RemoveExternalOptionFromTypoScriptFractorTest.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Typo3Fractor\Tests\TYPO3v14\TypoScript\RemoveExternalOptionFromTypoScriptFractor;
+
+use a9f\Fractor\Testing\PHPUnit\AbstractFractorTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+
+final class RemoveExternalOptionFromTypoScriptFractorTest 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/RemoveExternalOptionFromTypoScriptFractor/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\RemoveExternalOptionFromTypoScriptFractor;
+
+return FractorConfiguration::configure()
+    ->withOptions([
+        XmlProcessorOption::INDENT_CHARACTER => Indent::STYLE_TAB,
+        XmlProcessorOption::INDENT_SIZE => 1,
+    ])
+    ->withRules([RemoveExternalOptionFromTypoScriptFractor::class]);

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

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Typo3Fractor\TYPO3v14\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/14.0/Breaking-107927-ExternalAttributesRemoved.html
+ * @see \a9f\Typo3Fractor\Tests\TYPO3v14\TypoScript\RemoveExternalOptionFromTypoScriptFractor\RemoveExternalOptionFromTypoScriptFractorTest
+ */
+final class RemoveExternalOptionFromTypoScriptFractor extends AbstractTypoScriptFractor
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Remove "external" option from TypoScript', [new CodeSample(
+            <<<'CODE_SAMPLE'
+page = PAGE
+page.includeCSS {
+    main = https://example.com/styles/main.css
+    main.external = 1
+    other = /styles/main.css
+    other.external = 1
+}
+CODE_SAMPLE
+            ,
+            <<<'CODE_SAMPLE'
+page = PAGE
+page.includeCSS {
+    main = https://example.com/styles/main.css
+    other = URI:/styles/main.css
+}
+CODE_SAMPLE
+        )]);
+    }
+
+    public function refactor(Statement $statement): null|Statement|int
+    {
+        if (! $statement instanceof Assignment) {
+            return null;
+        }
+
+        if (! str_contains($statement->object->absoluteName, 'includeCSS')
+            && ! str_contains($statement->object->absoluteName, 'includeCSSLibs')
+            && ! str_contains($statement->object->absoluteName, 'includeJS')
+            && ! str_contains($statement->object->absoluteName, 'includeJSFooter')
+            && ! str_contains($statement->object->absoluteName, 'includeJSFooterlibs')
+            && ! str_contains($statement->object->absoluteName, 'includeJSLibs')
+        ) {
+            return null;
+        }
+
+        if (str_ends_with($statement->object->relativeName, 'external')) {
+            return TypoScriptStatementsIterator::REMOVE_NODE;
+        }
+
+        if (str_starts_with($statement->value->value, '/')) {
+            $statement->value->value = 'URI:' . $statement->value->value;
+            return $statement;
+        }
+
+        return null;
+    }
+}