TASK: Add Icons.php rector

config/register-icon-to-icons-file/register-icon-to-icons-file.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use Ssch\TYPO3Rector\Rector\v11\v5\RegisterIconToIconFileRector;
+use Ssch\TYPO3Rector\Rector\v11\v5\RegisterIconToIconFileRector\AddIconsToReturnRector;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $containerConfigurator->import(__DIR__ . '/../config.php');
+
+    $services = $containerConfigurator->services();
+    $services->set(AddIconsToReturnRector::class);
+    $services->set(RegisterIconToIconFileRector::class);
+};

src/Rector/v11/v5/RegisterIconToIconFileRector.php

@@ -0,0 +1,186 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ssch\TYPO3Rector\Rector\v11\v5;
+
+use Nette\Utils\Strings;
+use PhpParser\Node;
+use PhpParser\Node\Stmt;
+use PhpParser\Node\Stmt\Return_;
+use PhpParser\NodeTraverser;
+use PhpParser\NodeVisitor\NameResolver;
+use PHPStan\Type\ObjectType;
+use Rector\Core\PhpParser\Parser\SimplePhpParser;
+use Rector\Core\Rector\AbstractRector;
+use Rector\FileSystemRector\ValueObject\AddedFileWithContent;
+use Ssch\TYPO3Rector\Helper\FilesFinder;
+use Ssch\TYPO3Rector\Rector\v11\v5\RegisterIconToIconFileRector\AddIconsToReturnRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+/**
+ * @changelog https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/Icon/Index.html
+ * @see \Ssch\TYPO3Rector\Tests\Rector\v11\v5\RegisterIconToIconFileRector\RegisterIconToIconFileRectorTest
+ */
+final class RegisterIconToIconFileRector extends AbstractRector
+{
+    /**
+     * @var string
+     */
+    private const REMOVE_EMPTY_LINES = '/^[ \t]*[\r\n]+/m';
+
+    public function __construct(
+        private FilesFinder $filesFinder,
+        private AddIconsToReturnRector $addIconsToReturnRector,
+        private SimplePhpParser $simplePhpParser
+    ) {
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Node\Expr\MethodCall::class];
+    }
+
+    /**
+     * @param Node\Expr\MethodCall $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->nodeTypeResolver->isMethodStaticCallOrClassMethodObjectType(
+            $node,
+            new ObjectType('TYPO3\CMS\Core\Imaging\IconRegistry')
+        )) {
+            return null;
+        }
+
+        if (! $this->nodeNameResolver->isName($node->name, 'registerIcon')) {
+            return null;
+        }
+
+        $currentSmartFileInfo = $this->file->getSmartFileInfo();
+
+        $extEmConfFileInfo = $this->filesFinder->findExtEmConfRelativeFromGivenFileInfo($currentSmartFileInfo);
+
+        if (! $extEmConfFileInfo instanceof SmartFileInfo) {
+            return null;
+        }
+
+        $extensionDirectory = dirname($extEmConfFileInfo->getRealPath());
+
+        $iconsFilePath = sprintf('%s/Configuration/Icons.php', $extensionDirectory);
+
+        $identifier = $this->valueResolver->getValue($node->args[0]->value);
+
+        if (! is_string($identifier)) {
+            return null;
+        }
+
+        $options = $this->valueResolver->getValue($node->args[2]->value);
+
+        $iconConfiguration = [
+            'provider' => $node->args[1]->value,
+        ];
+
+        if (is_array($options)) {
+            $iconConfiguration = array_merge($iconConfiguration, $options);
+        }
+
+        $this->addNewIconToIconsFile($iconsFilePath, $identifier, $iconConfiguration);
+
+        $this->removeNode($node);
+
+        return null;
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Generate or add registerIcon calls to Icons.php file', [new CodeSample(
+            <<<'CODE_SAMPLE'
+
+use TYPO3\CMS\Core\Imaging\IconProvider\BitmapIconProvider;
+use TYPO3\CMS\Core\Imaging\IconRegistry;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+$iconRegistry = GeneralUtility::makeInstance(IconRegistry::class);
+$iconRegistry->registerIcon(
+    'mybitmapicon',
+    BitmapIconProvider::class,
+    [
+        'source' => 'EXT:my_extension/Resources/Public/Icons/mybitmap.png',
+    ]
+);
+CODE_SAMPLE
+            ,
+            <<<'CODE_SAMPLE'
+use TYPO3\CMS\Core\Imaging\IconProvider\BitmapIconProvider;
+use TYPO3\CMS\Core\Imaging\IconRegistry;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+$iconRegistry = GeneralUtility::makeInstance(IconRegistry::class);
+
+// Add Icons.php file
+CODE_SAMPLE
+        )]);
+    }
+
+    /**
+     * @param Stmt[] $stmts
+     */
+    private function decorateNamesToFullyQualified(array $stmts): void
+    {
+        // decorate nodes with names first
+        $nameResolverNodeTraverser = new NodeTraverser();
+        $nameResolverNodeTraverser->addVisitor(new NameResolver());
+        $nameResolverNodeTraverser->traverse($stmts);
+    }
+
+    /**
+     * @param array<string, mixed> $iconConfiguration
+     */
+    private function addNewIconToIconsFile(
+        string $iconsFilePath,
+        string $iconIdentifier,
+        array $iconConfiguration
+    ): void {
+        $addedFilesWithContent = $this->removedAndAddedFilesCollector->getAddedFilesWithContent();
+
+        $existingIcons = null;
+        foreach ($addedFilesWithContent as $addedFileWithContent) {
+            if ($addedFileWithContent->getFilePath() === $iconsFilePath) {
+                $existingIcons = $addedFileWithContent->getFileContent();
+            }
+        }
+
+        if (is_string($existingIcons)) {
+            $nodes = $this->simplePhpParser->parseString($existingIcons);
+        } else {
+            $nodes = [new Return_($this->nodeFactory->createArray([]))];
+        }
+
+        $this->decorateNamesToFullyQualified($nodes);
+
+        $nodeTraverser = new NodeTraverser();
+        $this->addIconsToReturnRector->configure([
+            AddIconsToReturnRector::ICON_IDENTIFIER => $iconIdentifier,
+            AddIconsToReturnRector::ICON_CONFIGURATION => $iconConfiguration,
+        ]);
+        $nodeTraverser->addVisitor($this->addIconsToReturnRector);
+        $nodes = $nodeTraverser->traverse($nodes);
+
+        $changedIconsContent = $this->betterStandardPrinter->prettyPrintFile($nodes);
+
+        $changedIconsContent = Strings::replace($changedIconsContent, self::REMOVE_EMPTY_LINES);
+
+        $this->removedAndAddedFilesCollector->addAddedFile(
+            new AddedFileWithContent($iconsFilePath, $changedIconsContent)
+        );
+    }
+}

src/Rector/v11/v5/RegisterIconToIconFileRector/AddIconsToReturnRector.php

@@ -0,0 +1,117 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ssch\TYPO3Rector\Rector\v11\v5\RegisterIconToIconFileRector;
+
+use PhpParser\Comment;
+use PhpParser\Node;
+use PhpParser\Node\Expr\Array_;
+use PhpParser\Node\Expr\ArrayItem;
+use PhpParser\Node\Scalar\String_;
+use PhpParser\Node\Stmt\Return_;
+use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
+use Rector\Core\Rector\AbstractRector;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Webmozart\Assert\Assert;
+
+/**
+ * @changelog https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/Icon/Index.html
+ * @see \Ssch\TYPO3Rector\Tests\Rector\v11\v5\RegisterIconToIconFileRector\RegisterIconToIconFileRectorTest
+ */
+final class AddIconsToReturnRector extends AbstractRector implements ConfigurableRectorInterface
+{
+    /**
+     * @var string
+     */
+    public const ICON_IDENTIFIER = 'icon-identifier';
+
+    /**
+     * @var string
+     */
+    public const ICON_CONFIGURATION = 'icon-configuration';
+
+    private string $iconIdentifier;
+
+    /**
+     * @var array<string, mixed>
+     */
+    private array $iconConfiguration;
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Add arguments to configure method in Symfony Command', [
+            new ConfiguredCodeSample(
+                <<<'CODE_SAMPLE'
+return [];
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+return [
+    'my-icon' => [
+        'provider' => stdClass::class,
+        'source' => 'mysvg.svg'
+    ]
+];
+CODE_SAMPLE
+,
+                [
+                    self::ICON_IDENTIFIER => 'my-icon',
+                    self::ICON_CONFIGURATION => [
+                        'provider' => \stdClass::class,
+                        'source' => 'mysvg.svg',
+                    ],
+                ]
+            ),
+        ]);
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [Return_::class];
+    }
+
+    /**
+     * @param Return_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $node->expr instanceof Array_) {
+            return null;
+        }
+
+        $iconArrayItem = new ArrayItem(
+            $this->nodeFactory->createArray($this->iconConfiguration),
+            new String_($this->iconIdentifier),
+            false,
+            [
+                AttributeKey::COMMENTS => [new Comment(PHP_EOL)],
+            ]
+        );
+        $node->expr->items[] = $iconArrayItem;
+
+        return $node;
+    }
+
+    /**
+     * @param array<string, mixed> $configuration
+     */
+    public function configure(array $configuration): void
+    {
+        $iconIdentifier = $configuration[self::ICON_IDENTIFIER] ?? '';
+        $iconConfiguration = $configuration[self::ICON_CONFIGURATION] ?? [];
+
+        Assert::stringNotEmpty($iconIdentifier);
+
+        Assert::isArray($iconConfiguration);
+        Assert::keyExists($iconConfiguration, 'provider');
+
+        $this->iconConfiguration = $iconConfiguration;
+        $this->iconIdentifier = $iconIdentifier;
+    }
+}

src/Set/Typo3SetList.php

@@ -130,4 +130,9 @@ final class Typo3SetList
      * @var string
      */
     public const EXTBASE_COMMAND_CONTROLLERS_TO_SYMFONY_COMMANDS = __DIR__ . '/../../config/extbase-command-controllers-to-symfony-commands/extbase_command_controllers_to_symfony_commands.php';
+
+    /**
+     * @var string
+     */
+    public const REGISTER_ICONS_TO_ICON = __DIR__ . '/../../config/register-icon-to-icons-file/register-icon-to-icons-file.php';
 }

tests/Rector/v11/v5/RegisterIconToIconFileRector/Fixture/Expected/Configuration/Icons.php.inc

@@ -0,0 +1,6 @@
+<?php
+return [
+    'mybitmapicon' => ['provider' => \TYPO3\CMS\Core\Imaging\IconProvider\BitmapIconProvider::class, 'source' => 'EXT:my_extension/Resources/Public/Icons/mybitmap.png'],
+    'mysvgicon' => ['provider' => \TYPO3\CMS\Core\Imaging\IconProvider\SvgIconProvider::class, 'source' => 'EXT:my_extension/Resources/Public/Icons/mysvg.svg'],
+    'proof-of-concept' => ['provider' => \TYPO3\CMS\Core\Imaging\IconProvider\FontawesomeIconProvider::class, 'name' => 'spinner', 'spinning' => true],
+];

tests/Rector/v11/v5/RegisterIconToIconFileRector/Fixture/my_extension/ext_localconf.php.inc

@@ -0,0 +1,41 @@
+<?php
+
+use TYPO3\CMS\Core\Imaging\IconProvider\BitmapIconProvider;
+use TYPO3\CMS\Core\Imaging\IconProvider\SvgIconProvider;
+use TYPO3\CMS\Core\Imaging\IconRegistry;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+$iconRegistry = GeneralUtility::makeInstance(IconRegistry::class);
+$iconRegistry->registerIcon(
+    'mybitmapicon',
+    BitmapIconProvider::class,
+    [
+        'source' => 'EXT:my_extension/Resources/Public/Icons/mybitmap.png',
+    ]
+);
+$iconRegistry->registerIcon(
+    'mysvgicon',
+    SvgIconProvider::class,
+    [
+        'source' => 'EXT:my_extension/Resources/Public/Icons/mysvg.svg',
+    ]
+);
+$iconRegistry->registerIcon(
+    'proof-of-concept',
+    \TYPO3\CMS\Core\Imaging\IconProvider\FontawesomeIconProvider::class,
+    [
+        'name'     => 'spinner',
+        'spinning' => true
+    ]
+);
+?>
+-----
+<?php
+
+use TYPO3\CMS\Core\Imaging\IconProvider\BitmapIconProvider;
+use TYPO3\CMS\Core\Imaging\IconProvider\SvgIconProvider;
+use TYPO3\CMS\Core\Imaging\IconRegistry;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+$iconRegistry = GeneralUtility::makeInstance(IconRegistry::class);
+?>