updated helper function genDiff for differ

Alexsey-VR · Alexsey-VR · commit 85d1898a1c1d · 2025-11-24T17:50:12.000Z
diff --git a/bin/gendiff b/bin/gendiff
@@ -9,7 +9,7 @@ if (file_exists($autoload_path_1)) {
     require_once $autoload_path_2;
 }
 
-use Differ\Differ;
+use Differ\Differ\Differ;
 use Differ\Readers\FileReader;
 use Differ\Factories\CommandFactory;
 use Differ\Factories\Formatters;
@@ -27,4 +27,3 @@ try {
 } catch (DifferException $e) {
     print_r("{$e->getMessage()}");
 }
-
diff --git a/composer.json b/composer.json
@@ -18,7 +18,8 @@
             "Differ\\Tests\\": "tests/"
         },
         "files": [
-            "vendor/docopt/docopt/src/docopt.php"
+            "vendor/docopt/docopt/src/docopt.php",
+            "src/Differ/Differ.php"
         ]
     },
     "authors": [
diff --git a/src/Differ/Differ.php b/src/Differ/Differ.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Differ;
+namespace Differ\Differ;
 
 use Differ\Interfaces\CommandFactoryInterface;
 use Differ\Interfaces\FilesDiffCommandInterface;
diff --git a/src/Differ/FilesDiffCommand.php b/src/Differ/FilesDiffCommand.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Differ\Differs;
+namespace Differ\Differ;
 
 use Differ\Interfaces\FilesDiffCommandInterface as FDCI;
 use Differ\Interfaces\CommandLineParserInterface as CLPI;
diff --git a/src/Factories/CommandFactory.php b/src/Factories/CommandFactory.php
@@ -9,13 +9,18 @@
 use Differ\Interfaces\DisplayCommandInterface as DCI;
 use Differ\Interfaces\DocoptDoubleInterface;
 use Differ\Interfaces\FileReaderInterface;
+use Differ\Interfaces\CommandFactoryInterface;
 use Differ\Exceptions\DifferException;
+use Differ\Parsers\CommandLineParser;
+use Differ\Parsers\FileParser;
+use Differ\Differ\FilesDiffCommand;
+use Differ\Displays\DisplayCommand;
 
-class CommandFactory implements \Differ\Interfaces\CommandFactoryInterface
+class CommandFactory implements CommandFactoryInterface
 {
-    private \Docopt|\Differ\Interfaces\DocoptDoubleInterface $parser;
+    private \Docopt|DocoptDoubleInterface $parser;
     private FileReaderInterface $fileReader;
-    private \Differ\Interfaces\CommandFactoryInterface $formatters;
+    private CommandFactoryInterface $formatters;
 
     private const array FORMAT_KEYS = [
         "stylish" => "stylish",
@@ -25,8 +30,8 @@ class CommandFactory implements \Differ\Interfaces\CommandFactoryInterface
 
     public function __construct(
         \Docopt|DocoptDoubleInterface $parser,
-        \Differ\Interfaces\FileReaderInterface $fileReader,
-        \Differ\Interfaces\CommandFactoryInterface $formatters
+        FileReaderInterface $fileReader,
+        CommandFactoryInterface $formatters
     ) {
         $this->parser = $parser;
         $this->fileReader = $fileReader;
@@ -45,13 +50,13 @@ public function createCommand(string $commandType): CLPI | FDCI | FI | DCI | FPI
     {
         switch ($commandType) {
             case "parseCMDLine":
-                $requestedCommand = new \Differ\Parsers\CommandLineParser($this->parser);
+                $requestedCommand = new CommandLineParser($this->parser);
                 break;
             case "parseFile":
-                $requestedCommand = new \Differ\Parsers\FileParser();
+                $requestedCommand = new FileParser();
                 break;
             case "difference":
-                $requestedCommand = new \Differ\Differs\FilesDiffCommand($this->fileReader);
+                $requestedCommand = new FilesDiffCommand($this->fileReader);
                 break;
             case self::FORMAT_KEYS["stylish"]:
                 $requestedCommand = $this->formatters->createCommand(self::FORMAT_KEYS["stylish"]);
@@ -63,7 +68,7 @@ public function createCommand(string $commandType): CLPI | FDCI | FI | DCI | FPI
                 $requestedCommand = $this->formatters->createCommand(self::FORMAT_KEYS["json"]);
                 break;
             case "show":
-                $requestedCommand = new \Differ\Displays\DisplayCommand();
+                $requestedCommand = new DisplayCommand();
                 break;
             default:
                 throw new DifferException("internal error: unknown command factory option\n");
diff --git a/tests/Unit/CommandFactoryTest.php b/tests/Unit/CommandFactoryTest.php
@@ -11,7 +11,7 @@
 use Differ\Factories\CommandFactory;
 use Differ\Factories\Formatters;
 use Differ\Displays\DisplayCommand;
-use Differ\Differs\FilesDiffCommand;
+use Differ\Differ\FilesDiffCommand;
 use Differ\Readers\FileReader;
 use Differ\Exceptions\DifferException;
 use Differ\Formatters\StylishCommand;
diff --git a/tests/Unit/CommandLineParserTest.php b/tests/Unit/CommandLineParserTest.php
@@ -7,10 +7,11 @@
 use PHPUnit\Framework\Attributes\CoversMethod;
 use PHPUnit\Framework\Attributes\DataProvider;
 use Differ\Parsers\DocoptDouble;
+use Differ\Parsers\CommandLineParser;
 
-#[CoversClass(\Differ\Parsers\CommandLineParser::class)]
-#[CoversMethod(\Differ\Parsers\CommandLineParser::class, 'setFileNames')]
-#[CoversMethod(\Differ\Parsers\CommandLineParser::class, 'getFileNames')]
+#[CoversClass(CommandLineParser::class)]
+#[CoversMethod(CommandLineParser::class, 'setFileNames')]
+#[CoversMethod(CommandLineParser::class, 'getFileNames')]
 #[CoversClass(DocoptDouble::class)]
 class CommandLineParserTest extends TestCase
 {
@@ -35,9 +36,9 @@ public static function getFiles(): array
     #[DataProvider('getFiles')]
     public function testFileNames($fileNames)
     {
-        $cmdLineParser = new \Differ\Parsers\CommandLineParser(new DocoptDouble());
+        $cmdLineParser = new CommandLineParser(new DocoptDouble());
 
-        $this->assertInstanceOf(\Differ\Parsers\CommandLineParser::class, $cmdLineParser->setFileNames($fileNames));
+        $this->assertInstanceOf(CommandLineParser::class, $cmdLineParser->setFileNames($fileNames));
 
         $this->assertEquals($fileNames, $cmdLineParser->setFileNames($fileNames)
                                                       ->getFileNames());
@@ -46,7 +47,7 @@ public function testFileNames($fileNames)
     public function testExecute()
     {
         $parser = new DocoptDouble();
-        $cmdLineParser = new \Differ\Parsers\CommandLineParser($parser);
+        $cmdLineParser = new CommandLineParser($parser);
 
         ob_start();
         $cmdLineParser->execute($cmdLineParser);
@@ -61,7 +62,7 @@ public function testExecute()
     public function testPlainExecute()
     {
         $parser = new DocoptDouble("plain");
-        $cmdLineParser = new \Differ\Parsers\CommandLineParser($parser);
+        $cmdLineParser = new CommandLineParser($parser);
 
         ob_start();
         $cmdLineParser->execute($cmdLineParser);
@@ -76,7 +77,7 @@ public function testPlainExecute()
     public function testSetFormat()
     {
         $parser = new DocoptDouble("plain");
-        $cmdLineParser = new \Differ\Parsers\CommandLineParser($parser);
+        $cmdLineParser = new CommandLineParser($parser);
 
         $outputFormat = $cmdLineParser->setFormat("stylish")
                                     ->getFormat();
diff --git a/tests/Unit/FileParserTest.php b/tests/Unit/FileParserTest.php
@@ -6,9 +6,10 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\CoversMethod;
 use Differ\Readers\FileReader;
+use Differ\Parsers\FileParser;
 
 #[CoversClass(FileReader::class)]
-#[CoversClass(\Differ\Parsers\FileParser::class)]
+#[CoversClass(FileParser::class)]
 #[CoversMethod(FileReader::class, 'readFile')]
 class FileParserTest extends TestCase
 {
@@ -17,7 +18,7 @@ public function testReadFileAsObject()
         $jsonFileForArray = $_ENV['FIXTURES_PATH'] . "/fileForArray.json";
 
         $fileReader = new FileReader();
-        $fileParser = new \Differ\Parsers\FileParser();
+        $fileParser = new FileParser();
 
         $fileReaderContainer = $fileReader->readFile(
             $jsonFileForArray
@@ -51,7 +52,7 @@ public function testReadFileAsArray()
         $jsonFileForArray = $_ENV['FIXTURES_PATH'] . "/fileForArray.json";
 
         $fileReader = new FileReader();
-        $fileParser = new \Differ\Parsers\FileParser();
+        $fileParser = new FileParser();
 
         $fileContent = $fileParser->execute(
             $fileReader->readFile(
@@ -69,7 +70,7 @@ public function testReadFileAsArray()
     public function testReadFileNotJson()
     {
         $fileReader = new FileReader();
-        $fileParser = new \Differ\Parsers\FileParser();
+        $fileParser = new FileParser();
 
         $fileContent = $fileParser->execute(
             $fileReader->readFile(
diff --git a/tests/Unit/FilesDiffCommandTest.php b/tests/Unit/FilesDiffCommandTest.php
@@ -6,13 +6,14 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\CoversMethod;
 use PHPUnit\Framework\Attributes\DataProvider;
-use Differ\Differs\FilesDiffCommand;
+use Differ\Differ\FilesDiffCommand;
 use Differ\Readers\FileReader;
 use Differ\Exceptions\DifferException;
+use Differ\Parsers\FileParser;
 
 #[CoversClass(FilesDiffCommand::class)]
 #[CoversClass(FileReader::class)]
-#[CoversClass(\Differ\Parsers\FileParser::class)]
+#[CoversClass(FileParser::class)]
 #[CoversMethod(FilesDiffCommand::class, 'execute')]
 #[CoversClass(DifferException::class)]
 class FilesDiffCommandTest extends TestCase
@@ -62,7 +63,7 @@ public function testExecute($fileNamesInput, $outputFilePath)
         $diffCommand = new FilesDiffCommand(
             new FileReader()
         );
-        $fileParser = new \Differ\Parsers\FileParser();
+        $fileParser = new FileParser();
 
         $resultContent1Descriptor = $diffCommand->execute($cmdLineParser, $fileParser)
                                  ->getContent1Descriptor();
@@ -93,7 +94,7 @@ public function testExecuteForException()
         );
 
         $diffCommand = new FilesDiffCommand(new FileReader());
-        $fileParser = new \Differ\Parsers\FileParser();
+        $fileParser = new FileParser();
 
         $this->expectException(DifferException::class);
         $this->expectExceptionMessageMatches("/unknown files format: use json, yaml \(yml\) enstead\\n/");
diff --git a/tests/Unit/FormattersTest.php b/tests/Unit/FormattersTest.php
@@ -7,25 +7,30 @@
 use PHPUnit\Framework\Attributes\CoversMethod;
 use PHPUnit\Framework\Attributes\DataProvider;
 use Differ\Parsers\DocoptDouble;
+use Differ\Parsers\CommandLineParser;
+use Differ\Parsers\FileParser;
 use Differ\Factories\CommandFactory;
 use Differ\Factories\Formatters;
 use Differ\Displays\DisplayCommand;
-use Differ\Differs\FilesDiffCommand;
+use Differ\Differ\FilesDiffCommand;
 use Differ\Readers\FileReader;
 use Differ\Exceptions\DifferException;
+use Differ\Formatters\StylishCommand;
+use Differ\Formatters\PlainCommand;
+use Differ\Formatters\JSONCommand;
 
 #[CoversClass(CommandFactory::class)]
-#[CoversClass(\Differ\Parsers\CommandLineParser::class)]
-#[CoversClass(\Differ\Parsers\FileParser::class)]
+#[CoversClass(CommandLineParser::class)]
+#[CoversClass(FileParser::class)]
 #[CoversClass(Formatters::class)]
 #[CoversClass(FilesDiffCommand::class)]
 #[CoversClass(DocoptDouble::class)]
 #[CoversClass(FileReader::class)]
 #[CoversMethod(FilesDiffCommand::class, 'execute')]
 #[CoversClass(DifferException::class)]
-#[CoversClass(\Differ\Formatters\StylishCommand::class)]
-#[CoversClass(\Differ\Formatters\PlainCommand::class)]
-#[CoversClass(\Differ\Formatters\JSONCommand::class)]
+#[CoversClass(StylishCommand::class)]
+#[CoversClass(PlainCommand::class)]
+#[CoversClass(JSONCommand::class)]
 #[CoversClass(DisplayCommand::class)]
 class FormattersTest extends TestCase
 {
@@ -93,7 +98,7 @@ public static function getParserArguments(): array
     public function testExecute($fileNamesInput, $contentFilePath, $outputFormat, $outputDiffsPath)
     {
         $cmdLineParser = $this->createConfiguredStub(
-            \Differ\Parsers\CommandLineParser::class,
+            CommandLineParser::class,
             [
                 'getFileNames' => $fileNamesInput,
                 'getFormat' => $outputFormat
@@ -156,7 +161,7 @@ public function testFormatException()
         ];
 
         $cmdLineParser = $this->createConfiguredStub(
-            \Differ\Parsers\CommandLineParser::class,
+            CommandLineParser::class,
             [
                 'getFileNames' => $fileNamesInput,
                 'getFormat' => 'undefined'
diff --git a/tests/Unit/GendiffConsoleTest.php b/tests/Unit/GendiffConsoleTest.php
@@ -5,19 +5,20 @@
 use PHPUnit\Framework\TestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\CoversMethod;
+use PHPUnit\Framework\Attributes\CoversNothing;
 use PHPUnit\Framework\Attributes\DataProvider;
 use Differ\Parsers\DocoptDouble;
 use Differ\Parsers\FileParser;
 use Differ\Parsers\CommandLineParser;
 use Differ\Readers\FileReader;
 use Differ\Factories\CommandFactory;
 use Differ\Factories\Formatters;
-use Differ\Differs\FilesDiffCommand;
+use Differ\Differ\FilesDiffCommand;
+use Differ\Differ\Differ;
 use Differ\Formatters\StylishCommand;
 use Differ\Formatters\PlainCommand;
 use Differ\formatters\JSONCommand;
 use Differ\Displays\DisplayCommand;
-use Differ\Differ;
 
 #[CoversClass(CommandFactory::class)]
 #[CoversClass(Formatters::class)]
diff --git a/tests/Unit/GendiffHelperTest.php b/tests/Unit/GendiffHelperTest.php
@@ -0,0 +1,69 @@
+<?php
+
+namespace Differ\Tests\Unit;
+
+use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\Attributes\CoversNothing;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Differ\Parsers\DocoptDouble;
+use Differ\Parsers\FileParser;
+use Differ\Parsers\CommandLineParser;
+use Differ\Readers\FileReader;
+use Differ\Factories\CommandFactory;
+use Differ\Factories\Formatters;
+use Differ\Differ\FilesDiffCommand;
+use Differ\Differ\Differ;
+use Differ\Formatters\StylishCommand;
+use Differ\Formatters\PlainCommand;
+use Differ\formatters\JSONCommand;
+use Differ\Displays\DisplayCommand;
+use function Differ\Differ\genDiff;
+
+#[CoversNothing]
+class GendiffHelperTest extends TestCase
+{
+    public static function getTestData(): array
+    {
+        return [
+            [
+                "formatter" => null,
+                "filePath" => $_ENV['FIXTURES_PATH'] . "/filesRecursiveStylishDiffs.txt"
+            ],
+            [
+                "formatter" => "stylish",
+                "filePath" => $_ENV['FIXTURES_PATH'] . "/filesRecursiveStylishDiffs.txt"
+            ],
+            [
+                "formatter" => "plain",
+                "filePath" => $_ENV['FIXTURES_PATH'] . "/filesRecursivePlainDiffs.txt"
+            ],
+            [
+                "formatter" => "json",
+                "filePath" => $_ENV['FIXTURES_PATH'] . "/filesRecursiveJSONDiffs.json"
+            ]
+        ];
+    }
+
+    #[DataProvider('getTestData')]
+    public function testHelperDiffer($formatter, $filePath)
+    {
+        $outputBuffer = "";
+        if (is_null($formatter)) {
+            $outputBuffer = genDiff(
+                $_ENV['FIXTURES_PATH'] . "/file1.json",
+                $_ENV['FIXTURES_PATH'] . "/file2.json"
+            );
+        } else {
+            $outputBuffer = genDiff(
+                $_ENV['FIXTURES_PATH'] . "/file1.json",
+                $_ENV['FIXTURES_PATH'] . "/file2.json",
+                $formatter
+            );
+        }
+
+        $this->assertStringEqualsFile(
+            $filePath,
+            $outputBuffer
+        );
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ if (file_exists($autoload_path_1)) {`
`9`	`9`	`require_once $autoload_path_2;`
`10`	`10`	`}`
`11`	`11`
`12`		`-use Differ\Differ;`
	`12`	`+use Differ\Differ\Differ;`
`13`	`13`	`use Differ\Readers\FileReader;`
`14`	`14`	`use Differ\Factories\CommandFactory;`
`15`	`15`	`use Differ\Factories\Formatters;`
`@@ -27,4 +27,3 @@ try {`
`27`	`27`	`} catch (DifferException $e) {`
`28`	`28`	`print_r("{$e->getMessage()}");`
`29`	`29`	`}`
`30`		`-`