Organise generator into namespaces

Trying to make this project as easy to contribute to as possible - smaller modules make it easier to focus on parts relevant to an issue

CONTRIBUTING.md

@@ -17,20 +17,15 @@ Safe-PHP code is generated automatically from the PHP doc.
 ### Generator
 
 * `safe.php` is the CLI entry point, with a few utility commands, but the
-  most important one is `generate`, which generates the Safe-PHP code.
-* `GenerateCommand` is the class that actually does the generation:
-  * Call `Scanner` to get a list of all the PHP XML documentation files
-    (returned in a `ScannerResponse`).
-  * Use `DocPage` to parse each XML file and extract the relevant
-    information.
-    * The "relevant information" is a list of `Method`s, which have
-      `Parameter`s, which have `Type`s.
-    * (As well as taking some information from the PHP XML docs, we also
-      take some type-hint information from PHPStan's type-hint database,
-      and merge these sources together to get a more complete picture.)
-  * Given a bunch of `Method` meta-data objects, `FileCreator` will create
-    files in `generated/` and use `WritePhpFunction` to write safe wrappers
-    for each function into those files.
+  most important one is `\Safe\Commands\GenerateCommand`, which does the
+  generation:
+  * Use `\Safe\XmlDocParser` to parse the PHP XML documentation
+    and pull out information about `Method`s, `Parameter`s, and
+    `Type`s - try to figure out which methods are unsafe.
+  * Use `\Safe\PhpStanFunctions` to get a bit of extra data from
+    PHPStan's typehint database, and merge that with the XML info.
+  * Given this list of unsafe functions, use `\Safe\Generator` to
+    write a bunch of safe wrappers.
 
 ### End-Users
 

generator/safe.php

@@ -4,9 +4,9 @@
 
 require __DIR__.'/vendor/autoload.php';
 
-use Safe\GenerateCommand;
-use Safe\ScanObjectsCommand;
-use Safe\FunctionInfoCommand;
+use Safe\Commands\FunctionInfoCommand;
+use Safe\Commands\GenerateCommand;
+use Safe\Commands\ScanObjectsCommand;
 use Symfony\Component\Console\Application;
 
 $application = new Application();

generator/src/FunctionInfoCommand.php → generator/src/Commands/FunctionInfoCommand.php

@@ -2,8 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\Commands;
 
+use Safe\XmlDocParser\Scanner;
+use Safe\XmlDocParser\DocPage;
+use Safe\Generator\WritePhpFunction;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputArgument;

generator/src/GenerateCommand.php → generator/src/Commands/GenerateCommand.php

@@ -2,7 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\Commands;
+
+use Safe\XmlDocParser\Scanner;
+use Safe\XmlDocParser\DocPage;
+use Safe\Generator\FileCreator;
+use Safe\Generator\ComposerJsonEditor;
 
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
@@ -37,9 +42,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $output->writeln('These functions have been ignored and must be dealt with manually: '.\implode(', ', $overloadedFunctions));
 
         $fileCreator = new FileCreator();
-        $fileCreator->generatePhpFile($functions, __DIR__ . '/../../generated/');
-        $fileCreator->generateFunctionsList($functions, __DIR__ . '/../../generated/functionsList.php');
-        $fileCreator->generateRectorFile($functions, __DIR__ . '/../../rector-migrate.php');
+        $fileCreator->generatePhpFile($functions, __DIR__ . '/../../../generated/');
+        $fileCreator->generateFunctionsList($functions, __DIR__ . '/../../../generated/functionsList.php');
+        $fileCreator->generateRectorFile($functions, __DIR__ . '/../../../rector-migrate.php');
 
 
         $modules = [];
@@ -63,7 +68,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     private function rmGenerated(): void
     {
-        $exceptions = \glob(__DIR__.'/../../generated/Exceptions/*.php');
+        $exceptions = \glob(__DIR__.'/../../../generated/Exceptions/*.php');
         if ($exceptions === false) {
             throw new \RuntimeException('Failed to require the generated exception files');
         }
@@ -72,7 +77,7 @@ private function rmGenerated(): void
             \unlink($exception);
         }
 
-        $files = \glob(__DIR__.'/../../generated/*.php');
+        $files = \glob(__DIR__.'/../../../generated/*.php');
         if ($files === false) {
             throw new \RuntimeException('Failed to require the generated files');
         }
@@ -88,7 +93,7 @@ private function rmGenerated(): void
 
     private function runCsFix(OutputInterface $output): void
     {
-        $process = new Process(['vendor/bin/phpcbf'], __DIR__.'/../..');
+        $process = new Process(['vendor/bin/phpcbf'], __DIR__.'/../../..');
         $process->setTimeout(600);
         $process->run(function ($type, $buffer) use ($output) {
             if (Process::ERR === $type) {

generator/src/ScanObjectsCommand.php → generator/src/Commands/ScanObjectsCommand.php

@@ -2,8 +2,10 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\Commands;
 
+use Safe\XmlDocParser\Scanner;
+use Safe\XmlDocParser\DocPage;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;

generator/src/ComposerJsonEditor.php → generator/src/Generator/ComposerJsonEditor.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\Generator;
 
 /**
  * This class will edit the main composer.json file to add the list of files generated from modules.

generator/src/FileCreator.php → generator/src/Generator/FileCreator.php

@@ -2,7 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\Generator;
+
+use Safe\XmlDocParser\Method;
 
 use Rector\Config\RectorConfig;
 use Rector\Renaming\Rector\FuncCall\RenameFunctionRector;

generator/src/WritePhpFunction.php → generator/src/Generator/WritePhpFunction.php

@@ -2,7 +2,10 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\Generator;
+
+use Safe\XmlDocParser\Method;
+use Safe\XmlDocParser\Parameter;
 
 class WritePhpFunction
 {

generator/src/PhpStanFunctions/PhpStanParameter.php

@@ -4,7 +4,7 @@
 
 namespace Safe\PhpStanFunctions;
 
-use Safe\Type;
+use Safe\XmlDocParser\Type;
 
 class PhpStanParameter
 {

generator/src/PhpStanFunctions/PhpStanType.php

@@ -4,8 +4,8 @@
 
 namespace Safe\PhpStanFunctions;
 
-use Safe\Method;
-use Safe\Type;
+use Safe\XmlDocParser\Method;
+use Safe\XmlDocParser\Type;
 
 /**
  * This class will parse the type from either parameters or return as given by phpstan and generate appropriate doc-block comments or typehints

generator/src/DocPage.php → generator/src/XmlDocParser/DocPage.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\XmlDocParser;
 
 use function explode;
 use function strpos;
@@ -15,7 +15,7 @@ public function __construct(private readonly string $path)
 
     public static function findDocDir(): string
     {
-        return __DIR__ . '/../doc';
+        return __DIR__ . '/../../doc';
     }
 
     public static function findReferenceDir(): string

generator/src/Method.php → generator/src/XmlDocParser/Method.php

@@ -2,11 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\XmlDocParser;
 
 use Safe\PhpStanFunctions\PhpStanFunction;
 use Safe\PhpStanFunctions\PhpStanFunctionMapReader;
 use Safe\PhpStanFunctions\PhpStanType;
+use Safe\Generator\FileCreator;
 
 class Method
 {

generator/src/Parameter.php → generator/src/XmlDocParser/Parameter.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\XmlDocParser;
 
 use Safe\PhpStanFunctions\PhpStanFunction;
 use Safe\PhpStanFunctions\PhpStanParameter;

generator/src/Scanner.php → generator/src/XmlDocParser/Scanner.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\XmlDocParser;
 
 use function array_merge;
 use function iterator_to_array;

generator/src/ScannerResponse.php → generator/src/XmlDocParser/ScannerResponse.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\XmlDocParser;
 
 class ScannerResponse
 {

generator/src/Type.php → generator/src/XmlDocParser/Type.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\XmlDocParser;
 
 class Type
 {

generator/tests/ComposerJsonEditorTest.php → generator/tests/Generator/ComposerJsonEditorTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\Generator;
 
 use PHPUnit\Framework\TestCase;
 

generator/tests/PhpStanFunctions/PhpStanTypeTest.php

@@ -4,13 +4,12 @@
 
 namespace Safe\PhpStanFunctions;
 
-
 use PHPUnit\Framework\TestCase;
-use Safe\Method;
+use Safe\XmlDocParser\Method;
 
 class PhpStanTypeTest extends TestCase
 {
-    public function testMixedTypes(): void 
+    public function testMixedTypes(): void
     {
         $param = new PhpStanType('array|string|int');
         $this->assertEquals('array|string|int', $param->getDocBlockType());
@@ -54,8 +53,8 @@ public function testGenerics(): void
         $this->assertEquals('array{0:float,1:float,2:float,3:float,4:float,5:float}', $param->getDocBlockType());
         $this->assertEquals('array', $param->getSignatureType());
     }
-    
-    public function testNullable(): void 
+
+    public function testNullable(): void
     {
         $param = new PhpStanType('array|null');
         $this->assertEquals(true, $param->isNullable());
@@ -77,8 +76,8 @@ public function testNullable(): void
         $this->assertEquals('\HashContext|null', $param->getDocBlockType());
         $this->assertEquals('?\HashContext', $param->getSignatureType());
     }
-    
-    public function testParenthesisOutsideOfCallable(): void 
+
+    public function testParenthesisOutsideOfCallable(): void
     {
         $param = new PhpStanType('(?int)|(?string)');
         $this->assertEquals(true, $param->isNullable());
@@ -93,8 +92,8 @@ public function testFalsable(): void
         $this->assertEquals('string|false', $param->getDocBlockType());
         $this->assertEquals('string', $param->getSignatureType());
     }
-    
-    public function testResource(): void 
+
+    public function testResource(): void
     {
         $param = new PhpStanType('resource');
         $this->assertEquals('resource', $param->getDocBlockType());
@@ -107,8 +106,8 @@ public function testNamespace(): void
         $this->assertEquals('\GMP', $param->getDocBlockType());
         $this->assertEquals('\GMP', $param->getSignatureType());
     }
-    
-    public function testVoid(): void 
+
+    public function testVoid(): void
     {
         $param = new PhpStanType('');
         $this->assertEquals('', $param->getDocBlockType());
@@ -122,8 +121,8 @@ public function testVoid(): void
         $this->assertEquals('void', $param->getDocBlockType());
         $this->assertEquals('void', $param->getSignatureType());
     }
-    
-    public function testOciSpecialCases(): void 
+
+    public function testOciSpecialCases(): void
     {
         $param = new PhpStanType('OCI-Collection');
         $this->assertEquals('\OCI-Collection', $param->getDocBlockType());
@@ -133,14 +132,14 @@ public function testOciSpecialCases(): void
         $this->assertEquals('\OCI-Lob', $param->getDocBlockType());
         $this->assertEquals('', $param->getSignatureType());
     }
-    
-    public function testErrorTypeInteraction(): void 
+
+    public function testErrorTypeInteraction(): void
     {
         //bool => void if the method is falsy
         $param = new PhpStanType('bool');
         $this->assertEquals('void', $param->getDocBlockType(Method::FALSY_TYPE));
         $this->assertEquals('void', $param->getSignatureType(Method::FALSY_TYPE));
-        
+
         //int|false => int if the method is falsy
         $param = new PhpStanType('int|false');
         $this->assertEquals('int', $param->getDocBlockType(Method::FALSY_TYPE));
@@ -155,8 +154,8 @@ public function testErrorTypeInteraction(): void
         $this->assertEquals('array|null', $param->getDocBlockType(Method::FALSY_TYPE));
         $this->assertEquals('?array', $param->getSignatureType(Method::FALSY_TYPE));
     }
-    
-    public function testDuplicateType(): void 
+
+    public function testDuplicateType(): void
     {
         $param = new PhpStanType('array<string,string>|array<string,false>|array<string,array<int,mixed>>');
         $this->assertEquals('array<string,string>|array<string,false>|array<string,array<int,mixed>>', $param->getDocBlockType());

generator/tests/DocPageTest.php → generator/tests/XmlDocParser/DocPageTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\XmlDocParser;
 
 use PHPUnit\Framework\TestCase;
 

generator/tests/MethodTest.php → generator/tests/XmlDocParser/MethodTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\XmlDocParser;
 
 use PHPUnit\Framework\TestCase;
 use Safe\PhpStanFunctions\PhpStanFunctionMapReader;

generator/tests/ScannerTest.php → generator/tests/XmlDocParser/ScannerTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\XmlDocParser;
 
 use PHPUnit\Framework\TestCase;
 
@@ -20,7 +20,7 @@ public function testGetMethodsPaths(): void
 
     public function testGetFunctionsPaths(): void
     {
-        $scanner = new Scanner(DocPage::findReferenceDir());
+        $scanner = new Scanner(DocPage::findReferenceDir() . '/');
         $paths = $scanner->getMethodsPaths();
 
         $this->assertArrayNotHasKey(DocPage::findReferenceDir() . '/filesystem/functions/chmod.xml', $paths);

generator/tests/TypeTest.php → generator/tests/XmlDocParser/TypeTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\XmlDocParser;
 
 use PHPUnit\Framework\TestCase;