improved maintainability

Author: Alexsey-VR

src/CommandFactory.php

@@ -6,7 +6,6 @@ class CommandFactory implements CommandFactoryInterface
 {
     private $parser;
     private $fileReader;
-    private $displayMode;
 
     public function __construct($parser, $fileReader)
     {
@@ -28,7 +27,7 @@ public function getCommand(string $commandType): ?CommandInterface
                 $requestedCommand = new DisplayCommand();
                 break;
             default:
-                return null;
+                throw new DifferException("internal error: unknown command factory option\n");
         }
         return $requestedCommand;
     }

src/DifferException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Differ;
+
+class DifferException extends \Exception
+{
+    public function __construct(string $message)
+    {
+        parent::__construct($message);
+    }
+}

src/DisplayCommand.php

@@ -4,7 +4,7 @@
 
 class DisplayCommand implements CommandInterface
 {
-    // Property to store displaying mode
+    // Property to store displaying mode for debug
     private string $mode;
     public const AVAILABLE_MODES = [
         "differents",
@@ -27,7 +27,7 @@ public function execute(CommandInterface $command = null): CommandInterface
                     print_r($command->getFilesContent());
                     break;
                 default:
-                    throw new \Exception("internal error: unknown mode for display\n");
+                    throw new DifferException("internal error: unknown mode for display\n");
             }
         }
 

src/FileReader.php

@@ -26,28 +26,24 @@ public function readFile(string $filename, bool $isArray = null): ?array
             $fileFormat = end($fileNameParts);
             if ($fileFormat === 'json') {
                 $handle = fopen($filename, "r");
-                $result = json_decode(fread($handle, self::MAX_FILE_SIZE), $isArray);
+                $jsonVariables = json_decode(fread($handle, self::MAX_FILE_SIZE), $isArray);
                 fclose($handle);
-                $type = gettype($result);
+                $type = gettype($jsonVariables);
                 if ($type === 'object') {
-                    return get_object_vars($result);
+                    $fileContentArray = get_object_vars($jsonVariables);
                 } elseif ($type === 'array') {
-                    return $result;
+                    $fileContentArray = $jsonVariables;
                 }
             } elseif ($fileFormat === 'yaml' || $fileFormat === 'yml') {
                 $handle = fopen($filename, "r");
-                $result = Yaml::parse(fread($handle, self::MAX_FILE_SIZE), Yaml::PARSE_OBJECT_FOR_MAP);
+                $yamlVariables = Yaml::parse(fread($handle, self::MAX_FILE_SIZE), Yaml::PARSE_OBJECT_FOR_MAP);
                 fclose($handle);
-                $type = gettype($result);
-                if ($type === 'object') {
-                    return get_object_vars($result);
-                } elseif ($type === 'array') {
-                    return $result;
-                }
+                $fileContentArray = get_object_vars($yamlVariables);
             } else {
-                throw new \Exception("Unknown files format: \n" .
-                                    "use .json, .yaml (.yml) enstead \n");
+                throw new DifferException("unknown files format: use json, yaml (yml) enstead\n");
             }
+
+            return $fileContentArray;
         } else {
             return null;
         }

src/Gendiff.php

@@ -11,7 +11,7 @@ function runGendiff(
     $consoleApp = new ConsoleApp($commandFactory);
     try {
         $consoleApp->run();
-    } catch (\Exception $e) {
+    } catch (DifferException $e) {
         print_r("{$e->getMessage()}");
     }
 }

tests/CommandFactoryTest.php

@@ -11,13 +11,15 @@
 use Differ\DisplayCommand;
 use Differ\FileReader;
 use Differ\DocoptDouble;
+use Differ\DifferException;
 
 #[CoversClass(CommandFactory::class)]
 #[CoversClass(CommandLineParser::class)]
 #[CoversClass(FilesDiffCommand::class)]
 #[CoversClass(DisplayCommand::class)]
 #[CoversClass(DocoptDouble::class)]
 #[CoversClass(FileReader::class)]
+#[CoversClass(DifferException::class)]
 class CommandFactoryTest extends TestCase
 {
     private $commandFactory;
@@ -45,6 +47,9 @@ public function testGetCommand()
         $this->assertInstanceOf(DisplayCommand::class, $this->commandFactory->getCommand('show'));
 
         // Test for undefined command
-        $this->assertNull($this->commandFactory->getCommand('undefined'));
+        $this->expectException(DifferException::class);
+        $this->expectExceptionMessageMatches("/internal error: unknown command factory option\\n/");
+
+        $this->commandFactory->getCommand('undefined');
     }
 }

tests/DisplayCommandTest.php

@@ -6,9 +6,11 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\CoversMethod;
 use Differ\DisplayCommand;
+use Differ\DifferException;
 
 #[CoversClass(DisplayCommand::class)]
 #[CoversMethod(DisplayCommand::class, 'execute')]
+#[CoversClass(DifferException::class)]
 class DisplayCommandTest extends TestCase
 {
     private $filesContent;
@@ -74,7 +76,7 @@ public function testUnknownDisplayMode()
     {
         $displayCmd = new DisplayCommand();
 
-        $this->expectException(\Exception::class);
+        $this->expectException(DifferException::class);
         $this->expectExceptionMessageMatches("/internal error: unknown mode for display\\n/");
 
         $displayCmd->setMode("extra")->execute($this->filesDiffCmd);

tests/FilesDiffCommandTest.php

@@ -6,11 +6,13 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\CoversMethod;
 use Differ\FileReader;
+use Differ\DifferException;
 
 #[CoversClass(FilesDiffCommand::class)]
 #[CoversClass(FileReader::class)]
 #[CoversMethod(FilesDiffCommand::class, 'setFileReader')]
 #[CoversMethod(FilesDiffCommand::class, 'execute')]
+#[CoversClass(DifferException::class)]
 class FilesDiffCommandTest extends TestCase
 {
     private $fileNames;
@@ -25,6 +27,10 @@ protected function setUp(): void
             "FILE1" => __DIR__ . "/../file1.yaml",
             "FILE2" => __DIR__ . "/../file2.yaml"
         ];
+        $this->fileNames['Exception'] = [
+            "FILE1" => __DIR__ . "/../fixtures/file1.txt",
+            "FILE2" => __DIR__ . "/../file2.yaml"
+        ];
     }
 
     public function testSetFileReader()
@@ -95,4 +101,22 @@ public function testExecuteForYAML()
             $resultDiffs
         );
     }
+
+    public function testExecuteForException()
+    {
+        $cmdLineParser = $this->createConfiguredStub(
+            CommandLineParser::class,
+            [
+                'getFileNames' => $this->fileNames['Exception']
+            ]
+        );
+
+        $diffCommand = new FilesDiffCommand();
+
+        $this->expectException(DifferException::class);
+        $this->expectExceptionMessageMatches("/unknown files format: use json, yaml \(yml\) enstead\\n/");
+
+        $diffCommand->setFileReader(new FileReader())
+                                 ->execute($cmdLineParser);
+    }
 }