Refactor CheckCommand to utilize OutputFormatterFactory for output format handling, improving code organization and maintainability. Introduced OutputFormatterFactory class to centralize formatter creation and support format retrieval.

Author: floriankraemer

src/Command/CheckCommand.php

@@ -22,16 +22,8 @@
 use Phauthentic\BcCheck\Config\ConfigurationException;
 use Phauthentic\BcCheck\Config\ConfigurationLoader;
 use Phauthentic\BcCheck\DependencyInjection\ContainerFactory;
+use Phauthentic\BcCheck\Factory\OutputFormatterFactory;
 use Phauthentic\BcCheck\Git\GitException;
-use Phauthentic\BcCheck\Output\CheckstyleOutputFormatter;
-use Phauthentic\BcCheck\Output\GithubActionsFormatter;
-use Phauthentic\BcCheck\Output\GitlabCodeQualityOutputFormatter;
-use Phauthentic\BcCheck\Output\JsonOutputFormatter;
-use Phauthentic\BcCheck\Output\JunitOutputFormatter;
-use Phauthentic\BcCheck\Output\MarkdownOutputFormatter;
-use Phauthentic\BcCheck\Output\OutputFormatterInterface;
-use Phauthentic\BcCheck\Output\SarifOutputFormatter;
-use Phauthentic\BcCheck\Output\TextOutputFormatter;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -45,14 +37,11 @@
 )]
 final class CheckCommand extends Command
 {
-    private const FORMAT_TEXT = 'text';
-    private const FORMAT_JSON = 'json';
-    private const FORMAT_MARKDOWN = 'markdown';
-    private const FORMAT_GITHUB = 'github-actions';
-    private const FORMAT_SARIF = 'sarif';
-    private const FORMAT_CHECKSTYLE = 'checkstyle';
-    private const FORMAT_JUNIT = 'junit';
-    private const FORMAT_GITLAB = 'gitlab';
+    public function __construct(
+        private readonly OutputFormatterFactory $formatterFactory = new OutputFormatterFactory(),
+    ) {
+        parent::__construct();
+    }
 
     protected function configure(): void
     {
@@ -83,17 +72,10 @@ protected function configure(): void
                 'f',
                 InputOption::VALUE_REQUIRED,
                 sprintf(
-                    'Output format (%s, %s, %s, %s, %s, %s, %s, %s)',
-                    self::FORMAT_TEXT,
-                    self::FORMAT_JSON,
-                    self::FORMAT_MARKDOWN,
-                    self::FORMAT_GITHUB,
-                    self::FORMAT_SARIF,
-                    self::FORMAT_CHECKSTYLE,
-                    self::FORMAT_JUNIT,
-                    self::FORMAT_GITLAB,
+                    'Output format (%s)',
+                    implode(', ', $this->formatterFactory->getSupportedFormats()),
                 ),
-                self::FORMAT_TEXT,
+                OutputFormatterFactory::FORMAT_TEXT,
             )
             ->addOption(
                 'show-files',
@@ -140,7 +122,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         // Get formatter
-        $formatter = $this->getFormatter($format);
+        $formatter = $this->formatterFactory->create($format);
 
         // Build container with services
         try {
@@ -205,18 +187,4 @@ private function loadConfiguration(?string $configPath): Configuration
 
         return $loader->createDefault();
     }
-
-    private function getFormatter(string $format): OutputFormatterInterface
-    {
-        return match ($format) {
-            self::FORMAT_JSON => new JsonOutputFormatter(),
-            self::FORMAT_MARKDOWN => new MarkdownOutputFormatter(),
-            self::FORMAT_GITHUB => new GithubActionsFormatter(),
-            self::FORMAT_SARIF => new SarifOutputFormatter(),
-            self::FORMAT_CHECKSTYLE => new CheckstyleOutputFormatter(),
-            self::FORMAT_JUNIT => new JunitOutputFormatter(),
-            self::FORMAT_GITLAB => new GitlabCodeQualityOutputFormatter(),
-            default => new TextOutputFormatter(),
-        };
-    }
 }

src/Factory/OutputFormatterFactory.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) Florian Krämer (https://florian-kraemer.net)
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright Copyright (c) Florian Krämer (https://florian-kraemer.net)
+ * @author    Florian Krämer
+ * @link      https://github.com/Phauthentic
+ * @license   https://opensource.org/licenses/GPL-3.0 GPL License
+ */
+
+namespace Phauthentic\BcCheck\Factory;
+
+use Phauthentic\BcCheck\Output\CheckstyleOutputFormatter;
+use Phauthentic\BcCheck\Output\GithubActionsFormatter;
+use Phauthentic\BcCheck\Output\GitlabCodeQualityOutputFormatter;
+use Phauthentic\BcCheck\Output\JsonOutputFormatter;
+use Phauthentic\BcCheck\Output\JunitOutputFormatter;
+use Phauthentic\BcCheck\Output\MarkdownOutputFormatter;
+use Phauthentic\BcCheck\Output\OutputFormatterInterface;
+use Phauthentic\BcCheck\Output\SarifOutputFormatter;
+use Phauthentic\BcCheck\Output\TextOutputFormatter;
+
+final readonly class OutputFormatterFactory
+{
+    public const FORMAT_TEXT = 'text';
+    public const FORMAT_JSON = 'json';
+    public const FORMAT_MARKDOWN = 'markdown';
+    public const FORMAT_GITHUB = 'github-actions';
+    public const FORMAT_SARIF = 'sarif';
+    public const FORMAT_CHECKSTYLE = 'checkstyle';
+    public const FORMAT_JUNIT = 'junit';
+    public const FORMAT_GITLAB = 'gitlab';
+
+    public function create(string $format): OutputFormatterInterface
+    {
+        return match ($format) {
+            self::FORMAT_JSON => new JsonOutputFormatter(),
+            self::FORMAT_MARKDOWN => new MarkdownOutputFormatter(),
+            self::FORMAT_GITHUB => new GithubActionsFormatter(),
+            self::FORMAT_SARIF => new SarifOutputFormatter(),
+            self::FORMAT_CHECKSTYLE => new CheckstyleOutputFormatter(),
+            self::FORMAT_JUNIT => new JunitOutputFormatter(),
+            self::FORMAT_GITLAB => new GitlabCodeQualityOutputFormatter(),
+            default => new TextOutputFormatter(),
+        };
+    }
+
+    /**
+     * @return list<string>
+     */
+    public function getSupportedFormats(): array
+    {
+        return [
+            self::FORMAT_TEXT,
+            self::FORMAT_JSON,
+            self::FORMAT_MARKDOWN,
+            self::FORMAT_GITHUB,
+            self::FORMAT_SARIF,
+            self::FORMAT_CHECKSTYLE,
+            self::FORMAT_JUNIT,
+            self::FORMAT_GITLAB,
+        ];
+    }
+}