try entropy (#33)

Author: TomasVotruba

.github/workflows/bare_run.yaml

@@ -20,4 +20,4 @@ jobs:
                     php-version: ${{ matrix.php }}
                     coverage: none
 
-            -   run: composer require rector/jack --dev --ansi
+            -   run: composer require rector/jack --dev

.github/workflows/code_analysis.yaml

@@ -30,22 +30,26 @@ jobs:
 
                     -
                         name: 'Jack: Outdated Breakpoint'
-                        run: ./bin/jack breakpoint --ansi --limit 3
+                        run: ./bin/jack breakpoint --limit 3
+
+                    -
+                        name: "Commented Code"
+                        run: vendor/bin/swiss-knife check-commented-code src tests --ansi
 
                     -
                         name: 'Jack: Open Versions'
-                        run: ./bin/jack open-versions --dry-run --ansi
+                        run: ./bin/jack open-versions --dry-run
 
                     -
                         name: 'Tests'
                         run: vendor/bin/phpunit
 
                     -
                         name: 'Check Active Classes'
-                        run: vendor/bin/class-leak check bin src tests --ansi
+                        run: vendor/bin/class-leak check bin src tests --ansi --skip-type="\Entropy\Console\Contract\CommandInterface"
 
                     -
-                        name: 'Unusued check'
+                        name: 'Composer Dependency Analyser'
                         run: vendor/bin/composer-dependency-analyser
 
         name: ${{ matrix.actions.name }}
@@ -56,7 +60,7 @@ jobs:
             # see https://github.com/shivammathur/setup-php
             -   uses: shivammathur/setup-php@v2
                 with:
-                    php-version: 8.2
+                    php-version: 8.3
                     coverage: none
 
             # composer install cache - https://github.com/ramsey/composer-install

.github/workflows/downgraded_release.yaml

@@ -19,7 +19,7 @@ jobs:
             -
                 uses: "shivammathur/setup-php@v2"
                 with:
-                    php-version: 8.2
+                    php-version: 8.3
                     coverage: none
 
             # invoke patches

bin/jack.php

@@ -2,9 +2,7 @@
 
 declare(strict_types=1);
 
-use Symfony\Component\Console\Application;
-use Symfony\Component\Console\Input\ArgvInput;
-use Symfony\Component\Console\Output\ConsoleOutput;
+use Entropy\Console\ConsoleApplication;
 use Rector\Jack\DependencyInjection\ContainerFactory;
 
 $scoperAutoloadFilepath = __DIR__ . '/../vendor/scoper-autoload.php';
@@ -32,7 +30,7 @@
 $containerFactory = new ContainerFactory();
 $container = $containerFactory->create();
 
-$application = $container->make(Application::class);
+$consoleApplication = $container->make(ConsoleApplication::class);
 
-$exitCode = $application->run(new ArgvInput(), new ConsoleOutput());
+$exitCode = $consoleApplication->run($argv);
 exit($exitCode);

composer.json

@@ -6,25 +6,23 @@
         "bin/jack"
     ],
     "require": {
-        "php": ">=8.2",
+        "php": ">=8.3",
         "composer/semver": "^3.4",
-        "illuminate/container": "^12.37",
-        "nette/utils": "^4.0",
-        "symfony/console": "^6.4",
-        "symfony/finder": "^7.3",
-        "symfony/process": "^7.3",
-        "webmozart/assert": "^1.12"
+        "entropy/entropy": "dev-main",
+        "nette/utils": "^4.1",
+        "symfony/process": "^7.4",
+        "webmozart/assert": "^2.0"
     },
     "require-dev": {
+        "phpecs/phpecs": "^2.2",
         "phpstan/extension-installer": "^1.4",
         "phpstan/phpstan": "^2.1",
-        "phpunit/phpunit": "^11.5|^12.0",
+        "phpunit/phpunit": "^12.5",
         "rector/rector": "^2.2",
+        "rector/swiss-knife": "^2.3",
         "shipmonk/composer-dependency-analyser": "^1.8",
-        "phpecs/phpecs": "^2.2",
         "symplify/phpstan-extensions": "^12.0",
-        "symplify/vendor-patches": "^11.5",
-        "tomasvotruba/class-leak": "^2.0",
+        "tomasvotruba/class-leak": "^2.1",
         "tracy/tracy": "^2.11"
     },
     "autoload": {
@@ -41,7 +39,6 @@
         "sort-packages": true,
         "platform-check": false,
         "allow-plugins": {
-            "cweagans/composer-patches": true,
             "phpstan/extension-installer": true
         }
     },

rector.php

@@ -17,5 +17,6 @@
         instanceOf: true,
         naming: true
     )
+    ->withSkip([\Rector\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector::class])
     ->withImportNames(removeUnusedImports: true)
     ->withSkip(['*/scoper.php', '*/Source/*', '*/Fixture/*']);

src/Command/BreakPointCommand.php

@@ -4,72 +4,47 @@
 
 namespace Rector\Jack\Command;
 
+use Entropy\Console\Contract\CommandInterface;
+use Entropy\Console\Enum\ExitCode;
+use Entropy\Console\Output\OutputPrinter;
 use Nette\Utils\Json;
 use Rector\Jack\Composer\ComposerOutdatedResponseProvider;
 use Rector\Jack\Enum\ComposerKey;
 use Rector\Jack\OutdatedComposerFactory;
-use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Input\InputOption;
-use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Console\Style\SymfonyStyle;
 
-final class BreakPointCommand extends Command
+final readonly class BreakPointCommand implements CommandInterface
 {
     public function __construct(
-        private readonly OutdatedComposerFactory $outdatedComposerFactory,
-        private readonly ComposerOutdatedResponseProvider $composerOutdatedResponseProvider
+        private OutdatedComposerFactory $outdatedComposerFactory,
+        private ComposerOutdatedResponseProvider $composerOutdatedResponseProvider,
+        private OutputPrinter $outputPrinter,
     ) {
-        parent::__construct();
     }
 
-    protected function configure(): void
+    /**
+     * @param bool $dev Focus on dev packages only
+     * @param int $limit Maximum number of outdated major version packages
+     * @param string[] $ignore Ignore packages by name, e.g. "symfony/" or "symfony/console"
+     */
+    public function run(bool $dev = false, int $limit = 5, array $ignore = []): int
     {
-        $this->setName('breakpoint');
-
-        $this->setDescription('Let your CI tell you, if there is too many major-version outdated packages');
-        $this->addOption('dev', null, InputOption::VALUE_NONE, 'Focus on dev packages only');
-
-        $this->addOption(
-            'limit',
-            null,
-            InputOption::VALUE_REQUIRED,
-            'Maximum number of outdated major version packages',
-            5
-        );
-
-        $this->addOption(
-            'ignore',
-            null,
-            InputOption::VALUE_IS_ARRAY | InputOption::VALUE_OPTIONAL,
-            'Ignore packages by name, e.g. "symfony/" or "symfony/console"',
-        );
-    }
-
-    protected function execute(InputInterface $input, OutputInterface $output): int
-    {
-        $symfonyStyle = new SymfonyStyle($input, $output);
-
-        $maxOutdatePackages = (int) $input->getOption('limit');
-        $onlyDev = (bool) $input->getOption('dev');
-
-        $symfonyStyle->writeln('<fg=green>Analyzing "composer.json" for major outdated packages</>');
+        $this->outputPrinter->green('Analyzing "composer.json" for major outdated packages');
 
         $responseJsonContents = $this->composerOutdatedResponseProvider->provide();
 
         $responseJson = Json::decode($responseJsonContents, true);
         if (! isset($responseJson[ComposerKey::INSTALLED_KEY])) {
-            $symfonyStyle->success('All packages are up to date');
+            $this->outputPrinter->green('All packages are up to date');
 
-            return self::SUCCESS;
+            return ExitCode::SUCCESS;
         }
 
         $composerJsonFilePath = getcwd() . '/composer.json';
         $outdatedComposer = $this->outdatedComposerFactory->createOutdatedComposer(
             array_filter(
                 $responseJson[ComposerKey::INSTALLED_KEY],
-                static function (array $package) use ($input): bool {
-                    foreach ($input->getOption('ignore') as $ignoredPackage) {
+                static function (array $package) use ($ignore): bool {
+                    foreach ($ignore as $ignoredPackage) {
                         if (str_contains((string) $package['name'], $ignoredPackage)) {
                             return false;
                         }
@@ -82,70 +57,81 @@ static function (array $package) use ($input): bool {
         );
 
         if ($outdatedComposer->count() === 0) {
-            $symfonyStyle->success('All packages are up to date');
-            return self::SUCCESS;
+            $this->outputPrinter->greenBackground('All packages are up to date');
+            return ExitCode::SUCCESS;
         }
 
-        $symfonyStyle->title(
+        $this->outputPrinter->yellow(
             sprintf(
                 'Found %d outdated package%s',
-                $outdatedComposer->count($onlyDev),
-                $outdatedComposer->count($onlyDev) > 1 ? 's' : ''
+                $outdatedComposer->count($dev),
+                $outdatedComposer->count($dev) > 1 ? 's' : ''
             )
         );
+        $this->outputPrinter->newline();
 
-        foreach ($outdatedComposer->getPackages($onlyDev) as $outdatedPackage) {
-            $symfonyStyle->writeln(
+        foreach ($outdatedComposer->getPackages($dev) as $outdatedPackage) {
+            $this->outputPrinter->writeln(
                 sprintf('The "<fg=green>%s</>" package is outdated', $outdatedPackage->getName())
             );
 
             if ($outdatedPackage->getCurrentVersionAge()) {
-                $symfonyStyle->writeln(sprintf(
+                $this->outputPrinter->writeln(sprintf(
                     ' * Your version %s is <fg=%s>%s</>',
                     $outdatedPackage->getCurrentVersion(),
                     $outdatedPackage->isVeryOld() ? 'red' : 'yellow',
                     $outdatedPackage->getCurrentVersionAge(),
                 ));
             } else {
                 // composer 2.7- compatible
-                $symfonyStyle->writeln(sprintf(' * Your version is %s', $outdatedPackage->getCurrentVersion()));
+                $this->outputPrinter->writeln(sprintf(' * Your version is %s', $outdatedPackage->getCurrentVersion()));
             }
 
-            $symfonyStyle->writeln(sprintf(' * Bump to %s', $outdatedPackage->getLatestVersion()));
-            $symfonyStyle->newLine();
+            $this->outputPrinter->writeln(sprintf(' * Bump to %s', $outdatedPackage->getLatestVersion()));
+            $this->outputPrinter->newLine();
         }
 
-        $symfonyStyle->newLine();
-        if ($outdatedComposer->count() >= $maxOutdatePackages) {
+        $this->outputPrinter->newLine();
+        if ($outdatedComposer->count() >= $limit) {
             // to much → fail
-            $symfonyStyle->error(sprintf(
+            $this->outputPrinter->redBackground(sprintf(
                 'There %s %d outdated package%s. Update couple of them to get under %d limit',
                 $outdatedComposer->count() > 1 ? 'are' : 'is',
                 $outdatedComposer->count(),
                 $outdatedComposer->count() > 1 ? 's' : '',
-                $maxOutdatePackages
+                $limit
             ));
 
-            return self::FAILURE;
+            return ExitCode::ERROR;
         }
 
-        if ($outdatedComposer->count() > max(1, $maxOutdatePackages - 5)) {
+        if ($outdatedComposer->count() > max(1, $limit - 5)) {
             // to much → fail
-            $symfonyStyle->warning(sprintf(
+            $this->outputPrinter->orangeBackground(sprintf(
                 'There are %d outdated packages. Soon, the count will go over %d limit and this job will fail.%sUpgrade in time',
                 $outdatedComposer->count(),
-                $maxOutdatePackages,
+                $limit,
                 PHP_EOL
             ));
 
-            return self::SUCCESS;
+            return ExitCode::SUCCESS;
         }
 
         // to many → fail
-        $symfonyStyle->success(
-            sprintf('Still far away from limit %d. Good job keeping your project up to date!', $maxOutdatePackages)
+        $this->outputPrinter->greenBackground(
+            sprintf('Still far away from limit %d. Good job keeping your project up to date!', $limit)
         );
 
-        return self::SUCCESS;
+        return ExitCode::SUCCESS;
+    }
+
+    public function getName(): string
+    {
+        return 'breakpoint';
+    }
+
+    public function getDescription(): string
+    {
+        return 'Let your CI tell you, if there are too many major-version outdated packages';
     }
 }