Add --rules-summary option to display applied rules summary with count (#7874)

Author: carlos-granados

e2e/rules-summary-option/.gitignore

@@ -0,0 +1 @@
+/vendor

e2e/rules-summary-option/cli-options.txt

@@ -0,0 +1 @@
+--rules-summary

e2e/rules-summary-option/composer.json

@@ -0,0 +1,7 @@
+{
+    "require": {
+        "php": "^8.1"
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}

e2e/rules-summary-option/expected-output.diff

@@ -0,0 +1,68 @@
+3 files with changes
+====================
+
+1) src/AlwaysTrue.php:4
+
+    ---------- begin diff ----------
+@@ @@
+ {
+     public function run()
+     {
+-        if (1 === 1) {
+-        }
+-
+-        if (2 === 2) {
+-        }
+-
+         return 'no';
+     }
+ }
+    ----------- end diff -----------
+
+Applied rules:
+ * RemoveAlwaysTrueIfConditionRector
+
+
+2) src/AnotherAlwaysTrue.php:4
+
+    ---------- begin diff ----------
+@@ @@
+ {
+     public function run()
+     {
+-        if (3 === 3) {
+-        }
+-
+         return 'yes';
+     }
+ }
+    ----------- end diff -----------
+
+Applied rules:
+ * RemoveAlwaysTrueIfConditionRector
+
+
+3) src/DeadConstructor.php:2
+
+    ---------- begin diff ----------
+@@ @@
+
+ final class DeadConstructor
+ {
+-    public function __construct()
+-    {
+-    }
+ }
+    ----------- end diff -----------
+
+Applied rules:
+ * RemoveEmptyClassMethodRector
+
+
+Rules Summary
+-------------
+
+ * RemoveAlwaysTrueIfConditionRector would have been applied 2 times
+ * RemoveEmptyClassMethodRector would have been applied 1 time
+
+ [OK] 3 files would have been changed (dry-run) by Rector

e2e/rules-summary-option/rector.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\ClassMethod\RemoveEmptyClassMethodRector;
+use Rector\DeadCode\Rector\If_\RemoveAlwaysTrueIfConditionRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/src',
+    ]);
+
+    $rectorConfig->rule(RemoveEmptyClassMethodRector::class);
+    $rectorConfig->rule(RemoveAlwaysTrueIfConditionRector::class);
+};

e2e/rules-summary-option/src/AlwaysTrue.php

@@ -0,0 +1,15 @@
+<?php
+
+final class AlwaysTrue
+{
+    public function run()
+    {
+        if (1 === 1) {
+        }
+
+        if (2 === 2) {
+        }
+
+        return 'no';
+    }
+}

e2e/rules-summary-option/src/AnotherAlwaysTrue.php

@@ -0,0 +1,12 @@
+<?php
+
+final class AnotherAlwaysTrue
+{
+    public function run()
+    {
+        if (3 === 3) {
+        }
+
+        return 'yes';
+    }
+}

e2e/rules-summary-option/src/DeadConstructor.php

@@ -0,0 +1,8 @@
+<?php
+
+final class DeadConstructor
+{
+    public function __construct()
+    {
+    }
+}

src/ChangesReporting/Output/ConsoleOutputFormatter.php

@@ -46,6 +46,10 @@ public function report(ProcessResult $processResult, Configuration $configuratio
             $this->symfonyStyle->newLine();
         }
 
+        if ($configuration->shouldShowRulesSummary()) {
+            $this->reportRulesSummary($processResult, $configuration);
+        }
+
         $message = $this->createSuccessMessage($processResult, $configuration);
         $this->symfonyStyle->success($message);
     }
@@ -131,6 +135,31 @@ private function reportErrors(array $errors, bool $absoluteFilePath): void
         }
     }
 
+    private function reportRulesSummary(ProcessResult $processResult, Configuration $configuration): void
+    {
+        $ruleApplicationCounts = $processResult->getRuleApplicationCounts();
+        if ($ruleApplicationCounts === []) {
+            return;
+        }
+
+        $verb = $configuration->isDryRun() ? 'would have been applied' : 'was applied';
+
+        $this->symfonyStyle->section('Rules Summary');
+
+        foreach ($ruleApplicationCounts as $ruleClass => $count) {
+            $ruleShortClass = (string) Strings::after($ruleClass, '\\', -1);
+            $this->symfonyStyle->writeln(sprintf(
+                ' * <info>%s</info> %s <comment>%d</comment> time%s',
+                $ruleShortClass,
+                $verb,
+                $count,
+                $count > 1 ? 's' : ''
+            ));
+        }
+
+        $this->symfonyStyle->newLine();
+    }
+
     private function normalizePathsToRelativeWithLine(string $errorMessage): string
     {
         $regex = '#' . preg_quote(getcwd(), '#') . '/#';

src/Configuration/ConfigurationFactory.php

@@ -87,6 +87,8 @@ public function createFromInput(InputInterface $input): Configuration
 
         $levelOverflows = SimpleParameterProvider::provideArrayParameter(Option::LEVEL_OVERFLOWS);
 
+        $showRulesSummary = (bool) $input->getOption(Option::RULES_SUMMARY);
+
         return new Configuration(
             $isDryRun,
             $showProgressBar,
@@ -104,6 +106,7 @@ public function createFromInput(InputInterface $input): Configuration
             $onlyRule,
             $onlySuffix,
             $levelOverflows,
+            $showRulesSummary,
         );
     }