Merge pull request #64 from magento-gl/AC-15344

AC-15344:: Add change level to breaking change table report in SVC

Author: sidolov

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "magento/magento-semver",
     "description": "Magento Semantic Version Checker",
-    "version": "13.0.0-beta8",
+    "version": "13.0.0-beta9",
     "license": [
         "OSL-3.0",
         "AFL-3.0"

composer.lock

@@ -259,7 +259,10 @@ protected function reportChanged($report, $contextBefore, $contextAfter, $method
                     $report->add($this->context, $data);
                     $signatureChanged = true;
                 } elseif ($signatureChanges['parameter_typing_changed']) {
-                    if ($signatureChanges['parameter_nullable_type_added']) {
+                    if (
+                        $signatureChanges['parameter_nullable_type_added']
+                        || $signatureChanges['parameter_nullable_type_removed']
+                    ) {
                         $data = new ClassMethodParameterTypingChangedNullable(
                             $this->context,
                             $this->fileAfter,

src/Analyzer/ClassMethodAnalyzer.php

@@ -10,6 +10,7 @@
 namespace Magento\SemanticVersionChecker\Comparator;
 
 use PHPSemVerChecker\Comparator\Node;
+use PhpParser\Node\NullableType;
 
 class Signature extends \PHPSemVerChecker\Comparator\Signature
 {
@@ -47,6 +48,7 @@ public static function isOptionalParams(array $params)
 
     /**
      * Checks type hinting to determine if each parameter is non-Scalar.
+     *
      * It assumes proper PHP code style is followed, meaning only non-Scalar parameters have type hinting.
      *
      * @param array $params Array of PhpParser\Node\Param objects
@@ -148,10 +150,15 @@ public static function analyze(array $parametersA, array $parametersB): array
                     $changes['parameter_typing_changed'] = true;
                     // Custom: detect nullable added
                     if (
-                        $typeBefore instanceof \PhpParser\Node\NullableType
-                        && !$typeAfter instanceof \PhpParser\Node\NullableType
+                        $typeBefore instanceof NullableType
+                        && !$typeAfter instanceof NullableType
                     ) {
                         $changes['parameter_nullable_type_added'] = true;
+                    } elseif (
+                        !$typeBefore instanceof NullableType
+                        && $typeAfter instanceof NullableType
+                    ) {
+                        $changes['parameter_nullable_type_removed'] = true;
                     }
                 } elseif ($parametersA[$i]->type !== null) {
                     $changes['parameter_typing_removed'] = true;

src/Comparator/Signature.php

@@ -10,12 +10,14 @@
 use PHPSemVerChecker\Report\Report;
 use PHPSemVerChecker\SemanticVersioning\Level;
 use Symfony\Component\Console\Output\OutputInterface;
+use PHPSemVerChecker\Operation\Operation;
 
 class BreakingChangeTableReporter extends TableReporter
 {
     private $breakChangeLevels = [
         Level::MAJOR,
         Level::MINOR,
+        Level::PATCH,
     ];
 
     /**
@@ -96,24 +98,71 @@ private function outputChangeReport(OutputInterface $output, Report $report, $co
     protected function outputTable(OutputInterface $output, Report $report, $context)
     {
         $table = new HtmlTableRenderer($output);
-        $table->setHeaders(['What changed', 'How it changed']);
+        $table->setHeaders(['<strong>Change Level</strong>', '<strong>What Changed</strong>', '<strong>How It Changed</strong>']);
         $rows = [];
         foreach (Level::asList('desc') as $level) {
             if (!in_array($level, $this->breakChangeLevels)) {
                 continue;
             }
             $reportForLevel = $report[$context][$level];
-            /** @var \PHPSemVerChecker\Operation\Operation $operation */
+            /** @var Operation $operation */
             foreach ($reportForLevel as $operation) {
+                // Skip private method/property changes as they shouldn't be in breaking change reports
+                if ($this->isPrivateMemberChange($operation)) {
+                    continue;
+                }
+                
+                $levelLabel = $this->getLevelLabel($level);
                 $target = $operation->getTarget();
                 $reason = $operation->getReason();
-                $rows[] = [$target, $reason];
+                $rows[] = [$levelLabel, $target, $reason];
             }
         }
         $table->setRows($rows);
         $table->render();
     }
 
+    /**
+     * Get a human-readable label for the change level
+     *
+     * @param int $level
+     * @return string
+     */
+    private function getLevelLabel(int $level): string
+    {
+        switch ($level) {
+            case Level::MAJOR:
+                return '<span style="color: #d73a49; font-weight: bold;">MAJOR (Breaking)</span>';
+            case Level::MINOR:
+                return '<span style="color: #f6a434; font-weight: bold;">MINOR (Non-breaking)</span>';
+            case Level::PATCH:
+                return '<span style="color: #28a745; font-weight: bold;">PATCH</span>';
+            default:
+                return 'UNKNOWN';
+        }
+    }
+
+    /**
+     * Check if the operation represents a private method or property change
+     * 
+     * Private changes are filtered out as they don't affect the public API contract.
+     *
+     * @param Operation $operation
+     * @return bool
+     */
+    private function isPrivateMemberChange(Operation $operation): bool
+    {
+        $target = $operation->getTarget();
+        $reason = $operation->getReason();
+
+        // Simple string check for 'private' keyword (covers all cases)
+        if (stripos($target, 'private') !== false || stripos($reason, 'private') !== false) {
+            return true;
+        }
+        
+        return false;
+    }
+
     /**
      * Generate the HTML header line for a report section
      *