SavinMikhail\CommentsDensity\ComposerPlugin\CommentsDensityPlugin

Complexity

Total Complexity

8

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	2	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	deactivate()	0	2	1
A	getSubscribedEvents()	0	5	1
A	uninstall()	0	2	1
A	activate()	0	2	1
A	promptForConfigFile()	0	19	3
A	promptForSetup()	0	5	1

<?php

declare(strict_types=1);

namespace SavinMikhail\CommentsDensity\ComposerPlugin;

use Composer\Composer;
use Composer\EventDispatcher\EventSubscriberInterface;
use Composer\IO\IOInterface;
use Composer\Plugin\PluginInterface;
use Composer\Script\Event;
use Composer\Script\ScriptEvents;

use function file_put_contents;

final class CommentsDensityPlugin implements PluginInterface, EventSubscriberInterface
{
    private const CONFIG = <<<'PHP'
        <?php
        
        declare(strict_types=1);
        
        use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\FixMeComment;
        use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\RegularComment;
        use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\TodoComment;
        use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\Config;
        
        return new Config(
            directories: [
                'src',
            ],
            thresholds: [
                RegularComment::NAME => 0,
                TodoComment::NAME => 0,
                FixMeComment::NAME => 0,
            ],
        );

        PHP;

    public static function getSubscribedEvents(): array
    {
        return [
            ScriptEvents::POST_INSTALL_CMD => 'promptForSetup',
            ScriptEvents::POST_UPDATE_CMD => 'promptForSetup',
        ];
    }

    public static function promptForSetup(Event $event): void
    {
        $interface = $event->getIO();

        self::promptForConfigFile($interface);
    }

    private static function promptForConfigFile(IOInterface $interface): void
    {
        $interface->write('Run configuration file setup');
        $shouldCreateConfig = $interface
            ->askConfirmation('Do you want to create a default configuration file? [y/n]');

        if (!$shouldCreateConfig) {
            $interface->write('Configuration file setup skipped.');

            return;
        }

        $res = file_put_contents('../../comments_density.php', self::CONFIG);

        if ($res === false) {
            $interface->error('Configuration file setup failed.');
        }

        $interface->write('Default configuration file created.');
    }

    /**
     * @SuppressWarnings(PHPMD.ShortVariable)
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function activate(Composer $composer, IOInterface $io): void
    {
        // No activation logic needed
    }

    /**
     * @SuppressWarnings(PHPMD.ShortVariable)
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function deactivate(Composer $composer, IOInterface $io): void
    {
        // No deactivation logic needed
    }

    /**
     * @SuppressWarnings(PHPMD.ShortVariable)
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function uninstall(Composer $composer, IOInterface $io): void
    {
        // No uninstallation logic needed
    }
}