Merge pull request #16 from moufmouf/special_cases

Adding a file to handle special cases.

Author: moufmouf

.travis.yml

@@ -31,6 +31,7 @@ script:
 - cd generator && ./vendor/bin/phpunit && cd ..
 - cd generator && composer cs-check && cd ..
 - cd generator && composer phpstan && cd ..
+- composer dump-autoload
 - composer cs-check
 - composer phpstan
 # Now, let's regenerate all files and see if we obtain the same set of files as the ones commited:

composer.json

@@ -88,7 +88,8 @@
             "generated/yaml.php",
             "generated/yaz.php",
             "generated/zip.php",
-            "generated/zlib.php"
+            "generated/zlib.php",
+            "lib/special_cases.php"
         ]
     },
     "require": {

generated/functionsList.php

@@ -931,4 +931,5 @@
     'inflate_add',
     'inflate_init',
     'zlib_decode',
+    'json_decode',
 ];

generator/config/specialCasesFunctions.php

@@ -0,0 +1,8 @@
+<?php
+/**
+ * A list of functions that must be dealt with manually.
+ * They are declared in lib/special_cases.php
+ */
+return [
+    'json_decode'
+];

generator/src/ComposerJsonEditor.php

@@ -16,6 +16,7 @@ public static function editFiles(array $modules): void
         $files = \array_map(function (string $module) {
             return 'generated/'.lcfirst($module).'.php';
         }, $modules);
+        $files[] = 'lib/special_cases.php';
         $composerContent = file_get_contents(__DIR__.'/../../composer.json');
         if ($composerContent === false) {
             throw new \RuntimeException('Error while loading composer.json file for edition.');

generator/src/FileCreator.php

@@ -2,6 +2,7 @@
 
 namespace Safe;
 
+use function array_merge;
 use Complex\Exception;
 use PhpOffice\PhpSpreadsheet\Spreadsheet;
 use PhpOffice\PhpSpreadsheet\Writer\Xlsx;
@@ -89,6 +90,8 @@ public function generateFunctionsList(array $functions, string $path): void
         $functionNames = array_map(function (Method $function) {
             return $function->getFunctionName();
         }, $functions);
+        $specialCases = require __DIR__.'/../config/specialCasesFunctions.php';
+        $functionNames = array_merge($functionNames, $specialCases);
         $stream = fopen($path, 'w');
         if ($stream === false) {
             throw new \RuntimeException('Unable to write to '.$path);

lib/special_cases.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * This file contains all the functions that could not be dealt with automatically using the code generator.
+ * If you add a function in this list, do not forget to add it in the generator/config/speicalCasesFunctions.php
+ *
+ */
+
+namespace Safe;
+
+use Safe\Exceptions\JsonException;
+
+/**
+ * Wrapper for json_decode that throws when an error occurs.
+ *
+ * @param string $json    JSON data to parse
+ * @param bool $assoc     When true, returned objects will be converted
+ *                        into associative arrays.
+ * @param int $depth   User specified recursion depth.
+ * @param int $options Bitmask of JSON decode options.
+ *
+ * @return mixed
+ * @throws JsonException if the JSON cannot be decoded.
+ * @link http://www.php.net/manual/en/function.json-decode.php
+ */
+function json_decode(string $json, bool $assoc = false, int $depth = 512, int $options = 0)
+{
+    $data = \json_decode($json, $assoc, $depth, $options);
+    if (JSON_ERROR_NONE !== json_last_error()) {
+        throw JsonException::createFromPhpError();
+    }
+    return $data;
+}