Moving generator to a subdirectory and another composer.json file

.gitignore

@@ -1,3 +1,5 @@
-/vendor/
-/build/
-/doc/doc-en/
+/generator/vendor/
+/generator/build/
+/generator/doc/doc-en/
+/generator/doc/entities/generated.ent
+/composer.lock

.travis.yml

@@ -8,28 +8,31 @@ matrix:
 
 cache:
   directories:
-  - doc/doc-en
+  - generator/doc/doc-en
   - vendor
+  - generator/vendor
   - $HOME/.composer
 
 before_script:
-- composer install --no-interaction
-- mkdir -p build/logs
+- cd generator && composer install --no-interaction && cd ..
 - |
-  if [ ! -d "doc/doc-en/en" ]; then
-    cd doc
+  if [ ! -d "generator/doc/doc-en/en" ]; then
+    cd generator/doc
     svn co https://svn.php.net/repository/phpdoc/modules/doc-en doc-en
-    cd ..
+    cd ../..
   else
-    cd doc/doc-en
+    cd generator/doc/doc-en
     svn update
-    cd ../..
+    cd ../../..
   fi
+- composer update
 
 script:
-- "./vendor/bin/phpunit"
-#- "./vendor/bin/composer-require-checker --config-file=composer-require-checker.json"
+- cd generator && ./vendor/bin/phpunit && cd ..
+- cd generator && composer cs-check && cd ..
+- cd generator && composer phpstan && cd ..
 - composer cs-check
 - composer phpstan
+
 after_script:
 - travis_retry php vendor/bin/php-coveralls

CONTRIBUTING.md

@@ -7,31 +7,25 @@ Safe-PHP code is generated automatically from the PHP doc.
 The first step is to download the PHP documentation project locally.
 You will need Subversion (svn) installed on your computer.
 
+```bash
+$ cd generator/doc
+$ svn co https://svn.php.net/repository/phpdoc/modules/doc-en doc-en
+$ cd ../..
 ```
-cd doc
-svn co https://svn.php.net/repository/phpdoc/modules/doc-en doc-en
-cd ..
-```
-
-Generating the documentation is a 2 pass process.
 
-### First pass: generating the function list
+At any point, if you want to update the documentation to the latest version, you can use:
 
 ```bash
-php ./parse.php
+$ cd generator/doc/doc-en
+$ svn update
 ```
 
-The first pass is used to find all the functions in the documentation and to put them in a CSV file called `generated/functions.csv`
 
-This CSV file is then **manually edited** to cope for the specific cases of some functions (for instance, the cURL exception
-messages can be fetched from `curl_strerror`).
+### Generating the functions
 
-### Second pass: generating the function list
+Generating the functions can be done with a simple command line.
 
 ```bash
-php ./generate.php
+$ cd generator
+$ php ./safe.php generate
 ```
-
-The second pass uses the `generated/functions.csv` and the downloaded documentation to create the functions wrapper file
-in `generated/lib.php`.
-

composer.json

@@ -1,30 +1,19 @@
 {
   "name": "thecodingmachine/safe",
-  "description": "Create a list of functional PHP functions which return false on error",
+  "description": "PHP core functions that throw exceptions instead of returning FALSE on error",
   "autoload": {
     "psr-4": {
       "Safe\\": ["lib/", "generated/"]
     }
   },
-  "autoload-dev": {
-    "psr-4": {
-      "Safe\\": "src/"
-    }
-  },
   "require-dev": {
     "php": ">=7.1",
-    "ext-simplexml": "*",
-    "phpunit/phpunit": "^7",
     "phpstan/phpstan": "^0.10.3",
     "thecodingmachine/phpstan-strict-rules": "^0.10.3",
-    "phpoffice/phpspreadsheet": "^1.4",
-    "ext-json": "^1.5",
-    "symfony/console": "^4.1.4",
-    "squizlabs/php_codesniffer": "^3.2",
-    "php-coveralls/php-coveralls": "^2.1"
+    "squizlabs/php_codesniffer": "^3.2"
   },
   "scripts": {
-    "phpstan": "phpstan analyse src -c phpstan.neon --level=7 --no-progress -vvv",
+    "phpstan": "phpstan analyse lib -c phpstan.neon --level=7 --no-progress -vvv",
     "cs-fix": "phpcbf",
     "cs-check": "phpcs"
   },

generator/composer.json

@@ -0,0 +1,31 @@
+{
+  "name": "thecodingmachine/safe-generator",
+  "description": "Generated the files for thecodingmachine/safe",
+  "autoload-dev": {
+    "psr-4": {
+      "Safe\\": "src/"
+    }
+  },
+  "require-dev": {
+    "php": ">=7.1",
+    "ext-simplexml": "*",
+    "phpunit/phpunit": "^7",
+    "phpstan/phpstan": "^0.10.3",
+    "thecodingmachine/phpstan-strict-rules": "^0.10.3",
+    "phpoffice/phpspreadsheet": "^1.4",
+    "ext-json": "^1.5",
+    "symfony/console": "^4.1.4",
+    "squizlabs/php_codesniffer": "^3.2",
+    "php-coveralls/php-coveralls": "^2.1"
+  },
+  "scripts": {
+    "phpstan": "phpstan analyse src -c phpstan.neon --level=7 --no-progress -vvv",
+    "cs-fix": "phpcbf",
+    "cs-check": "phpcs"
+  },
+  "extra": {
+    "branch-alias": {
+      "dev-master": "0.1-dev"
+    }
+  }
+}

generator/phpcs.xml.dist

@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<ruleset name="Expressive Skeleton coding standard">
+    <description>Expressive Skeleton coding standard</description>
+
+    <!-- display progress -->
+    <arg value="p"/>
+    <arg name="colors"/>
+
+    <!-- inherit rules from: -->
+    <rule ref="PSR2"/>
+
+    <!-- Paths to check -->
+    <file>src</file>
+
+    <rule ref="Generic.Files.LineLength">
+        <properties>
+            <property name="lineLimit" value="300"/>
+            <property name="absoluteLineLimit" value="500"/>
+        </properties>
+    </rule>
+</ruleset>

generator/phpstan.neon

@@ -0,0 +1,6 @@
+parameters:
+    ignoreErrors:
+        - "#subject of function str_replace expects array|string, string|true given#"
+        - "#createExceptionFile\\(\\) expects string, int|string given#"
+includes:
+    - vendor/thecodingmachine/phpstan-strict-rules/phpstan-strict-rules.neon

generator/src/ComposerJsonEditor.php

@@ -0,0 +1,29 @@
+<?php
+
+
+namespace Safe;
+
+/**
+ * This class will edit the main composer.json file to add the list of files generated from modules.
+ */
+class ComposerJsonEditor
+{
+    /**
+     * @param string[] $modules A list of modules
+     */
+    public static function editFiles(array $modules): void
+    {
+        $files = \array_map(function (string $module) {
+            return 'generated/'.lcfirst($module).'.php';
+        }, $modules);
+        $composerContent = file_get_contents(__DIR__.'/../../composer.json');
+        if ($composerContent === false) {
+            throw new \RuntimeException('Error while loading composer.json file for edition.');
+        }
+        $composerJson = \json_decode($composerContent, true);
+        $composerJson['autoload']['files'] = $files;
+
+        $newContent = json_encode($composerJson, \JSON_PRETTY_PRINT);
+        \file_put_contents(__DIR__.'/../../composer.json', $newContent);
+    }
+}

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

@@ -105,7 +105,7 @@ public function createExceptionFile(string $moduleName): void
     {
         if (!\class_exists("Safe\\Exceptions\\{$moduleName}Exception")) {
             \file_put_contents(
-                __DIR__.'/../generated/Exceptions/'.$moduleName.'Exception.php',
+                __DIR__.'/../../generated/Exceptions/'.$moduleName.'Exception.php',
                 <<<EOF
 <?php
 namespace Safe\Exceptions;

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

@@ -37,36 +37,39 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         $fileCreator = new FileCreator();
         //$fileCreator->generateXlsFile($protoFunctions, __DIR__ . '/../generated/lib.xls');
-        $fileCreator->generatePhpFile($functions, __DIR__ . '/../generated/');
-        $fileCreator->generateFunctionsList($functions, __DIR__ . '/../generated/functionsList.php');
+        $fileCreator->generatePhpFile($functions, __DIR__ . '/../../generated/');
+        $fileCreator->generateFunctionsList($functions, __DIR__ . '/../../generated/functionsList.php');
 
 
         $modules = [];
         foreach ($functions as $function) {
-            $modules[$function->getModuleName()] = true;
+            $modules[$function->getModuleName()] = $function->getModuleName();
         }
 
         foreach ($modules as $moduleName => $foo) {
             $fileCreator->createExceptionFile($moduleName);
         }
 
         // Finally, let's require the generated file to check there is no error.
-        $files = \glob(__DIR__.'/../generated/*.php');
+        $files = \glob(__DIR__.'/../../generated/*.php');
 
         foreach ($files as $file) {
             require($file);
         }
+
+        // Finally, let's edit the composer.json file
+        ComposerJsonEditor::editFiles($modules);
     }
 
     private function rmGenerated(): void
     {
-        $exceptions = \glob(__DIR__.'/../generated/Exceptions/*.php');
+        $exceptions = \glob(__DIR__.'/../../generated/Exceptions/*.php');
 
         foreach ($exceptions as $exception) {
             \unlink($exception);
         }
 
-        $files = \glob(__DIR__.'/../generated/*.php');
+        $files = \glob(__DIR__.'/../../generated/*.php');
 
         foreach ($files as $file) {
             \unlink($file);

lib/Exceptions/AbstractSafeException.php

@@ -3,7 +3,6 @@
 
 namespace Safe\Exceptions;
 
-
 abstract class AbstractSafeException extends \ErrorException implements SafeExceptionInterface
 {
     public static function createFromPhpError(): self

lib/Exceptions/CurlException.php

@@ -3,7 +3,6 @@
 
 namespace Safe\Exceptions;
 
-
 class CurlException extends AbstractSafeException
 {
     /**

lib/Exceptions/JsonException.php

@@ -3,7 +3,6 @@
 
 namespace Safe\Exceptions;
 
-
 class JsonException extends \Exception implements SafeExceptionInterface
 {
     public static function createFromPhpError(): self

lib/Exceptions/SafeExceptionInterface.php

@@ -3,8 +3,7 @@
 
 namespace Safe\Exceptions;
 
-
 interface SafeExceptionInterface extends \Throwable
 {
 
-}
+}

phpcs.xml.dist

@@ -10,7 +10,7 @@
     <rule ref="PSR2"/>
 
     <!-- Paths to check -->
-    <file>src</file>
+    <file>lib</file>
 
     <rule ref="Generic.Files.LineLength">
         <properties>

phpstan.neon

@@ -1,6 +1,4 @@
 parameters:
     ignoreErrors:
-        - "#subject of function str_replace expects array|string, string|true given#"
-        - "#createExceptionFile\\(\\) expects string, int|string given#"
 includes:
     - vendor/thecodingmachine/phpstan-strict-rules/phpstan-strict-rules.neon