Add FormatNotFoundException exception

Author: williamdes

src/Exceptions/FormatNotFoundException.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace CodeLts\CliTools\Exceptions;
+
+class FormatNotFoundException extends \Exception
+{
+
+	public function __construct(string $formatName)
+	{
+		parent::__construct(sprintf('The format "%s" is not implemented.', $formatName));
+	}
+
+	public function getTip(): ?string
+	{
+		return null;
+	}
+
+}

src/OutputFormat.php

@@ -14,6 +14,7 @@
 use CodeLts\CliTools\ErrorFormatter\RawTextErrorFormatter;
 use CodeLts\CliTools\ErrorFormatter\TableErrorFormatter;
 use CodeLts\CliTools\ErrorFormatter\TeamcityErrorFormatter;
+use CodeLts\CliTools\Exceptions\FormatNotFoundException;
 use CodeLts\CliTools\File\FuzzyRelativePathHelper;
 use CodeLts\CliTools\File\NullRelativePathHelper;
 use CodeLts\CliTools\File\RelativePathHelper;
@@ -52,14 +53,14 @@ class OutputFormat
      * @param string $outputFormat The format to check
      * @return true
      *
-     * @throws Exception
+     * @throws FormatNotFoundException if the format does not exist
      */
     public static function checkOutputFormatIsValid(string $outputFormat): bool
     {
         if (in_array($outputFormat, OutputFormat::VALID_OUTPUT_FORMATS)) {
             return true;
         }
-        throw new Exception(
+        throw new FormatNotFoundException(
             sprintf(
                 'Error formatter "%s" not found. Available error formatters are: %s',
                 $outputFormat,
@@ -97,7 +98,7 @@ public static function displayUserChoiceFormat(
     /**
      * get an ErrorFormatter for the given format
      *
-     * @throws Exception if the format is not implemented
+     * @throws FormatNotFoundException if the format is not implemented
      */
     public static function getFormatterForChoice(
         string $outputFormat,
@@ -143,6 +144,6 @@ public static function getFormatterForChoice(
             return new TeamcityErrorFormatter($pathHelper);
         }
 
-        throw new Exception('Not implemented format');
+        throw new FormatNotFoundException($outputFormat);
     }
 }

tests/OutputFormatTest.php

@@ -5,9 +5,9 @@
 namespace CodeLts\CliTools\Tests;
 
 use CodeLts\CliTools\ErrorFormatter\ErrorFormatter;
+use CodeLts\CliTools\Exceptions\FormatNotFoundException;
 use CodeLts\CliTools\File\NullRelativePathHelper;
 use CodeLts\CliTools\OutputFormat;
-use Exception;
 
 class OutputFormatTest extends ErrorFormatterTestCase
 {
@@ -38,7 +38,7 @@ public function testValidFormats(string $formatName): void
     public function testInValidFormats(string $formatName): void
     {
         $formatName = 'foo' . $formatName;
-        $this->expectException(Exception::class);
+        $this->expectException(FormatNotFoundException::class);
         $this->expectExceptionMessage(
             'Error formatter "' . $formatName . '" not found.'
             . ' Available error formatters are: raw, rawtext, table, checkstyle, json, junit, prettyJson, gitlab, github, teamcity'
@@ -54,6 +54,19 @@ public function testGetFormatterForChoice(string $formatName): void
         $this->assertInstanceOf(ErrorFormatter::class, OutputFormat::getFormatterForChoice($formatName, new NullRelativePathHelper()));
     }
 
+    /**
+     * @dataProvider dataProviderFormatsNames
+     */
+    public function testGetFormatterForChoiceInvalid(string $formatName): void
+    {
+        $formatName = 'foo' . $formatName;
+        $this->expectException(FormatNotFoundException::class);
+        $this->expectExceptionMessage(
+            'The format "' . $formatName . '" is not implemented.'
+        );
+        OutputFormat::getFormatterForChoice($formatName, new NullRelativePathHelper());
+    }
+
     /**
      * @dataProvider dataProviderFormatsNames
      */