Refactor exception handling and output formatting in BcCheck. Changed BcCheckException to extend from Exception instead of RuntimeException for broader compatibility. Simplified CheckstyleOutputFormatter and TextOutputFormatter by extracting file element creation and grouped break writing into dedicated methods, enhancing code readability and maintainability.

Author: floriankraemer

src/Exception/BcCheckException.php

@@ -16,15 +16,15 @@
 
 namespace Phauthentic\BcCheck\Exception;
 
-use RuntimeException;
+use Exception;
 use Throwable;
 
 /**
  * Base exception class for all BC Check exceptions.
  *
  * All application-specific exceptions should extend this class.
  */
-abstract class BcCheckException extends RuntimeException
+abstract class BcCheckException extends Exception
 {
     protected function __construct(string $message, ?Throwable $previous = null)
     {

src/Output/CheckstyleOutputFormatter.php

@@ -17,6 +17,7 @@
 namespace Phauthentic\BcCheck\Output;
 
 use DOMDocument;
+use DOMElement;
 use Phauthentic\BcCheck\ValueObject\BcBreak;
 use Symfony\Component\Console\Output\OutputInterface;
 
@@ -40,23 +41,12 @@ public function format(array $breaks, OutputInterface $output): void
         $checkstyle->setAttribute('version', self::VERSION);
         $dom->appendChild($checkstyle);
 
-        // Group breaks by class name
         $groupedBreaks = $this->groupByClassName($breaks);
 
         foreach ($groupedBreaks as $className => $classBreaks) {
-            $file = $dom->createElement('file');
-            $file->setAttribute('name', $className);
-
-            foreach ($classBreaks as $break) {
-                $error = $dom->createElement('error');
-                $error->setAttribute('severity', 'error');
-                $error->setAttribute('message', $break->message);
-                $error->setAttribute('source', 'bc-check.' . $break->type->value);
-
-                $file->appendChild($error);
-            }
-
-            $checkstyle->appendChild($file);
+            $checkstyle->appendChild(
+                $this->createFileElement($dom, $className, $classBreaks),
+            );
         }
 
         $xml = $dom->saveXML();
@@ -65,6 +55,26 @@ public function format(array $breaks, OutputInterface $output): void
         }
     }
 
+    /**
+     * @param list<BcBreak> $breaks
+     */
+    private function createFileElement(DOMDocument $dom, string $className, array $breaks): DOMElement
+    {
+        $file = $dom->createElement('file');
+        $file->setAttribute('name', $className);
+
+        foreach ($breaks as $break) {
+            $error = $dom->createElement('error');
+            $error->setAttribute('severity', 'error');
+            $error->setAttribute('message', $break->message);
+            $error->setAttribute('source', 'bc-check.' . $break->type->value);
+
+            $file->appendChild($error);
+        }
+
+        return $file;
+    }
+
     /**
      * Group BC breaks by class name.
      *

src/Output/TextOutputFormatter.php

@@ -41,17 +41,7 @@ public function format(array $breaks, OutputInterface $output): void
 
         // Group breaks by class for better readability
         $groupedByClass = $this->groupBreaksByClass($breaks);
-
-        foreach ($groupedByClass as $className => $classBreaks) {
-            $output->writeln(sprintf('<comment>  Class: %s</comment>', $className));
-            $output->writeln('');
-
-            foreach ($classBreaks as $break) {
-                $this->writeBreak($break, $output);
-            }
-
-            $output->writeln('');
-        }
+        $this->writeGroupedBreaks($groupedByClass, $output);
 
         // Summary
         $output->writeln($this->createSeparator(60));
@@ -68,6 +58,23 @@ public function format(array $breaks, OutputInterface $output): void
         $output->writeln('');
     }
 
+    /**
+     * @param array<string, list<BcBreak>> $groupedBreaks
+     */
+    private function writeGroupedBreaks(array $groupedBreaks, OutputInterface $output): void
+    {
+        foreach ($groupedBreaks as $className => $classBreaks) {
+            $output->writeln(sprintf('<comment>  Class: %s</comment>', $className));
+            $output->writeln('');
+
+            foreach ($classBreaks as $break) {
+                $this->writeBreak($break, $output);
+            }
+
+            $output->writeln('');
+        }
+    }
+
     private function writeBreak(BcBreak $break, OutputInterface $output): void
     {
         $typeLabel = $this->formatTypeName($break->type->value);
@@ -80,6 +87,7 @@ private function writeBreak(BcBreak $break, OutputInterface $output): void
             $typeLabel,
             $memberInfo,
         ));
+
         $output->writeln(sprintf('      %s', $break->message));
     }