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

Author: shish

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 renamed to 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 renamed to 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;

generator/src/ScanObjectsCommand.php renamed to 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 renamed to 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 renamed to generator/src/Generator/FileCreator.php

@@ -2,7 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Safe;
+namespace Safe\Generator;
+
+use Safe\XmlDocParser\Method;
 
 use function array_merge;
 use function file_exists;
@@ -151,7 +153,7 @@ public static function createFromPhpError(): self
 
     public static function getSafeRootDir(): string
     {
-        return __DIR__ . '/../..';
+        return __DIR__ . '/../../..';
     }
 
     /**

generator/src/WritePhpFunction.php renamed to 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/PhpStanFunctionMapReader.php

@@ -4,6 +4,8 @@
 
 namespace Safe\PhpStanFunctions;
 
+use Safe\Generator\FileCreator;
+
 class PhpStanFunctionMapReader
 {
     /**
@@ -18,8 +20,8 @@ class PhpStanFunctionMapReader
 
     public function __construct()
     {
-        $this->functionMap = require 'phar://' . \Safe\FileCreator::getSafeRootDir() . '/generator/vendor/phpstan/phpstan/phpstan.phar/resources/functionMap.php';
-        $this->customFunctionMap = require \Safe\FileCreator::getSafeRootDir() . '/generator/config/CustomPhpStanFunctionMap.php';
+        $this->functionMap = require 'phar://' . FileCreator::getSafeRootDir() . '/generator/vendor/phpstan/phpstan/phpstan.phar/resources/functionMap.php';
+        $this->customFunctionMap = require FileCreator::getSafeRootDir() . '/generator/config/CustomPhpStanFunctionMap.php';
     }
 
     public function hasFunction(string $functionName): bool

generator/src/PhpStanFunctions/PhpStanParameter.php

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