TASK: Add SiteLanguageAwareInterface

config/v12/typo3-120.php

@@ -160,4 +160,5 @@
     );
     $rectorConfig->rule(\Ssch\TYPO3Rector\Rector\v12\v0\typo3\UseConfigArrayForTSFEPropertiesRector::class);
     $rectorConfig->rule(\Ssch\TYPO3Rector\Rector\v12\v0\typo3\ReplacePageRepoOverlayFunctionRector::class);
+    $rectorConfig->rule(\Ssch\TYPO3Rector\Rector\v12\v0\typo3\ImplementSiteLanguageAwareInterfaceRector::class);
 };

src/Rector/v12/v0/typo3/ImplementSiteLanguageAwareInterfaceRector.php

@@ -0,0 +1,170 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ssch\TYPO3Rector\Rector\v12\v0\typo3;
+
+use PhpParser\Builder\Property;
+use PhpParser\Node;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Return_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ClassReflection;
+use Rector\Core\Rector\AbstractScopeAwareRector;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @changelog https://docs.typo3.org/c/typo3/cms-core/master/en-us/Changelog/12.0/Deprecation-97435-UsageOfSiteLanguageAwareTraitToDenoteSiteLanguageAwareness.html
+ * @see \Ssch\TYPO3Rector\Tests\Rector\v12\v0\typo3\ImplementSiteLanguageAwareInterfaceRector\ImplementSiteLanguageAwareInterfaceRectorTest
+ */
+final class ImplementSiteLanguageAwareInterfaceRector extends AbstractScopeAwareRector
+{
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    /**
+     * @param Class_ $node
+     */
+    public function refactorWithScope(Node $node, Scope $scope): ?Node
+    {
+        $classHasChanged = false;
+
+        $classReflection = $scope->getClassReflection();
+        if (! $classReflection instanceof ClassReflection) {
+            return null;
+        }
+
+        foreach ($node->getTraitUses() as $traitUse) {
+            foreach ($traitUse->traits as $trait) {
+                if (! $this->isName($trait, 'TYPO3\CMS\Core\Site\SiteLanguageAwareTrait')) {
+                    continue;
+                }
+
+                $this->removeNode($traitUse);
+                $classHasChanged = true;
+            }
+        }
+
+        // It was not working with the ClassReflection
+        $implementInterface = true;
+        foreach ($node->implements as $implement) {
+            if ($this->isName($implement, 'TYPO3\\CMS\\Core\\Site\\SiteLanguageAwareInterface')) {
+                $implementInterface = false;
+            }
+        }
+
+        if ($implementInterface) {
+            $node->implements[] = new FullyQualified('TYPO3\CMS\Core\Site\SiteLanguageAwareInterface');
+            $classHasChanged = true;
+        }
+
+        $siteLanguageName = new FullyQualified('TYPO3\CMS\Core\Site\Entity\SiteLanguage');
+
+        $hasSiteLanguageProperty = false;
+        $properties = $node->getProperties();
+        foreach ($properties as $property) {
+            if ($this->isName($property, 'siteLanguage')) {
+                $hasSiteLanguageProperty = true;
+            }
+        }
+
+        if (! $hasSiteLanguageProperty) {
+            $node->stmts[] = (new Property('siteLanguage'))
+                ->makeProtected()
+                ->setType($siteLanguageName)
+                ->getNode();
+            $classHasChanged = true;
+        }
+
+        if (! $classReflection->hasMethod('setSiteLanguage')) {
+            $setterOfSiteLanguage = new ClassMethod(
+                'setSiteLanguage',
+                [
+                    'flags' => Class_::MODIFIER_PUBLIC,
+                    'stmts' => [
+                        new Node\Stmt\Expression(
+                            $this->nodeFactory->createPropertyAssignmentWithExpr(
+                                'siteLanguage',
+                                new Node\Expr\Variable('siteLanguage')
+                            )
+                        ),
+                    ],
+                    'params' => [new Node\Param(new Node\Expr\Variable('siteLanguage'), null, $siteLanguageName)],
+                ]
+            );
+            $node->stmts[] = $setterOfSiteLanguage;
+            $classHasChanged = true;
+        }
+
+        if (! $classReflection->hasMethod('getSiteLanguage')) {
+            $getterOfSiteLanguage = new ClassMethod(
+                'getSiteLanguage',
+                [
+                    'flags' => Class_::MODIFIER_PUBLIC,
+                    'stmts' => [new Return_($this->nodeFactory->createPropertyFetch('this', 'siteLanguage'))],
+                    'returnType' => $siteLanguageName,
+                ]
+            );
+            $node->stmts[] = $getterOfSiteLanguage;
+            $classHasChanged = true;
+        }
+
+        if ($classHasChanged) {
+            // invoke re-print
+            $node->setAttribute(AttributeKey::ORIGINAL_NODE, null);
+
+            return $node;
+        }
+
+        return null;
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Implement SiteLanguageAwareInterface instead of using SiteLanguageAwareTrait', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+use TYPO3\CMS\Core\Site\SiteLanguageAwareTrait;
+
+class MyClass
+{
+    use SiteLanguageAwareTrait;
+}
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+use TYPO3\CMS\Core\Site\SiteLanguageAwareInterface;
+use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
+
+class MyClass implements SiteLanguageAwareInterface
+{
+
+    protected SiteLanguage $siteLanguage;
+
+    public function setSiteLanguage(SiteLanguage $siteLanguage)
+    {
+        $this->siteLanguage = $siteLanguage;
+    }
+
+    public function getSiteLanguage(): SiteLanguage
+    {
+        return $this->siteLanguage;
+    }
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+}

stubs/TYPO3/CMS/Core/Site/SiteLanguageAwareInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace TYPO3\CMS\Core\Site;
+
+use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
+
+if (interface_exists('TYPO3\CMS\Core\Site\SiteLanguageAwareInterface')) {
+    return;
+}
+
+interface SiteLanguageAwareInterface
+{
+    public function setSiteLanguage(SiteLanguage $siteLanguage);
+
+    public function getSiteLanguage(): SiteLanguage;
+}

stubs/TYPO3/CMS/Core/Site/SiteLanguageAwareTrait.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace TYPO3\CMS\Core\Site;
+
+if (trait_exists('TYPO3\CMS\Core\Site\SiteLanguageAwareTrait')) {
+    return;
+}
+
+trait SiteLanguageAwareTrait
+{
+
+}

tests/Rector/v12/v0/typo3/ImplementSiteLanguageAwareInterfaceRector/Fixture/add_interface_only.php.inc

@@ -0,0 +1,44 @@
+<?php
+
+namespace Ssch\TYPO3Rector\Tests\Rector\v12\v0\typo3\ImplementSiteLanguageAwareInterfaceRector\Fixture;
+
+use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
+use TYPO3\CMS\Core\Site\SiteLanguageAwareInterface;
+use TYPO3\CMS\Core\Site\SiteLanguageAwareTrait;
+
+class MyClassWithoutInterfaceButOtherMethods
+{
+    public function setSiteLanguage(SiteLanguage $siteLanguage)
+    {
+        $this->siteLanguage = $siteLanguage;
+    }
+    public function getSiteLanguage(): SiteLanguage
+    {
+        return $this->siteLanguage;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Ssch\TYPO3Rector\Tests\Rector\v12\v0\typo3\ImplementSiteLanguageAwareInterfaceRector\Fixture;
+
+use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
+use TYPO3\CMS\Core\Site\SiteLanguageAwareInterface;
+use TYPO3\CMS\Core\Site\SiteLanguageAwareTrait;
+
+class MyClassWithoutInterfaceButOtherMethods implements SiteLanguageAwareInterface
+{
+    public function setSiteLanguage(SiteLanguage $siteLanguage)
+    {
+        $this->siteLanguage = $siteLanguage;
+    }
+    public function getSiteLanguage(): SiteLanguage
+    {
+        return $this->siteLanguage;
+    }
+    protected SiteLanguage $siteLanguage;
+}
+
+?>

tests/Rector/v12/v0/typo3/ImplementSiteLanguageAwareInterfaceRector/Fixture/everything_ok.php.inc

@@ -0,0 +1,24 @@
+<?php
+
+namespace Ssch\TYPO3Rector\Tests\Rector\v12\v0\typo3\ImplementSiteLanguageAwareInterfaceRector\Fixture;
+
+use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
+use TYPO3\CMS\Core\Site\SiteLanguageAwareInterface;
+
+class MyClassWithoutInterfaceButOtherMethods implements SiteLanguageAwareInterface
+{
+    protected SiteLanguage $siteLanguage;
+
+    public function setSiteLanguage(SiteLanguage $siteLanguage)
+    {
+        $this->siteLanguage = $siteLanguage;
+    }
+    public function getSiteLanguage(): SiteLanguage
+    {
+        return $this->siteLanguage;
+    }
+    protected SiteLanguage $siteLanguage;
+}
+
+?>
+

tests/Rector/v12/v0/typo3/ImplementSiteLanguageAwareInterfaceRector/Fixture/remove_trait_and_add_interface.php.inc

@@ -0,0 +1,35 @@
+<?php
+
+namespace Ssch\TYPO3Rector\Tests\Rector\v12\v0\typo3\ImplementSiteLanguageAwareInterfaceRector\Fixture;
+
+use TYPO3\CMS\Core\Site\SiteLanguageAwareTrait;
+
+class MyClassWithoutInterface
+{
+    use SiteLanguageAwareTrait;
+}
+
+?>
+-----
+<?php
+
+namespace Ssch\TYPO3Rector\Tests\Rector\v12\v0\typo3\ImplementSiteLanguageAwareInterfaceRector\Fixture;
+
+use TYPO3\CMS\Core\Site\SiteLanguageAwareInterface;
+use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
+use TYPO3\CMS\Core\Site\SiteLanguageAwareTrait;
+
+class MyClassWithoutInterface implements SiteLanguageAwareInterface
+{
+    protected SiteLanguage $siteLanguage;
+    public function setSiteLanguage(SiteLanguage $siteLanguage)
+    {
+        $this->siteLanguage = $siteLanguage;
+    }
+    public function getSiteLanguage(): SiteLanguage
+    {
+        return $this->siteLanguage;
+    }
+}
+
+?>

tests/Rector/v12/v0/typo3/ImplementSiteLanguageAwareInterfaceRector/Fixture/remove_trait_only.php.inc

@@ -0,0 +1,48 @@
+<?php
+
+namespace Ssch\TYPO3Rector\Tests\Rector\v12\v0\typo3\ImplementSiteLanguageAwareInterfaceRector\Fixture;
+
+use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
+use TYPO3\CMS\Core\Site\SiteLanguageAwareInterface;
+use TYPO3\CMS\Core\Site\SiteLanguageAwareTrait;
+
+class MyClass implements SiteLanguageAwareInterface
+{
+    use SiteLanguageAwareTrait;
+
+    protected SiteLanguage $siteLanguage;
+
+    public function setSiteLanguage(SiteLanguage $siteLanguage)
+    {
+        $this->siteLanguage = $siteLanguage;
+    }
+    public function getSiteLanguage(): SiteLanguage
+    {
+        return $this->siteLanguage;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Ssch\TYPO3Rector\Tests\Rector\v12\v0\typo3\ImplementSiteLanguageAwareInterfaceRector\Fixture;
+
+use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
+use TYPO3\CMS\Core\Site\SiteLanguageAwareInterface;
+use TYPO3\CMS\Core\Site\SiteLanguageAwareTrait;
+
+class MyClass implements SiteLanguageAwareInterface
+{
+    protected SiteLanguage $siteLanguage;
+    public function setSiteLanguage(SiteLanguage $siteLanguage)
+    {
+        $this->siteLanguage = $siteLanguage;
+    }
+    public function getSiteLanguage(): SiteLanguage
+    {
+        return $this->siteLanguage;
+    }
+}
+
+?>

tests/Rector/v12/v0/typo3/ImplementSiteLanguageAwareInterfaceRector/ImplementSiteLanguageAwareInterfaceRectorTest.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ssch\TYPO3Rector\Tests\Rector\v12\v0\typo3\ImplementSiteLanguageAwareInterfaceRector;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ImplementSiteLanguageAwareInterfaceRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    /**
+     * @return Iterator<array<string>>
+     */
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}