Instead of a source directory the generateModels method now accepts a SchemaProvider which provides all JSON Schema files.

Available providers are: RecursiveDirectoryProvider (replacement for the previous behaviour) and the OpenAPIv3Provider

Author: wol-soft

README.md

@@ -62,7 +62,7 @@ $generator = new Generator(
 
 $generator
     ->generateModelDirectory(__DIR__ . '/result');
-    ->generateModels(__DIR__ . '/schema', __DIR__ . '/result');
+    ->generateModels(new RecursiveDirectoryProvider(__DIR__ . '/schema'), __DIR__ . '/result');
 ```
 
 The generator will check the given source directory recursive and convert all found *.json files to models. All JSON-Schema files inside the source directory must provide a schema of an object.

docs/source/complexTypes/object.rst

@@ -66,9 +66,7 @@ If the given main object in a JSON-Schema file contains a `$id` the id will be u
 Naming of nested classes
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-Nested classes are prefixed with the parent class. If an object `Person` has a nested object `car` the class for car will be named **Person_Car**.
-
-For the class name of a nested class the `$id` property of the nested object is used. If the id property isn't present the property key combined with a uniqid will be used.
+For the class name of a nested class the `$id` property of the nested object is used. If the id property isn't present the property key will be prefixed with the parent class. If an object `Person` has a nested object `car` without a `$id` the class for car will be named **Person_Car**.
 
 Property Name Normalization
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^

docs/source/generic/namespaces.rst

@@ -34,7 +34,7 @@ Your model generation code inside `generateModels.php` now could look like:
 
     $generator
         ->generateModelDirectory(__DIR__ . '/build')
-        ->generateModels(__DIR__ . '/Models', __DIR__ . '/build');
+        ->generateModels(new RecursiveDirectoryProvider(__DIR__ . '/Models'), __DIR__ . '/build');
 
 The generated main classes will be:
 

docs/source/gettingStarted.rst

@@ -21,7 +21,18 @@ The base object for generating models is the *Generator*. After you have created
 .. code-block:: php
 
     (new Generator())
-        ->generateModels(__DIR__ . '/schema', __DIR__ . '/result');
+        ->generateModels(new RecursiveDirectoryProvider(__DIR__ . '/schema'), __DIR__ . '/result');
+
+The first parameter of the *generateModels* method must be a class implementing the *SchemaProviderInterface*. The provider fetches the JSON schema files and provides them for the generator. The following providers are available:
+
+=========================== ===========
+Provider                    Description
+=========================== ===========
+RecursiveDirectoryProvider  Fetches all *.json files from the given source directory. Each file must contain a JSON Schema object definition on the top level
+OpenAPIv3Provider           Fetches all objects defined in the #/components/schemas section of an Open API v3 spec file
+=========================== ===========
+
+The second parameter must point to an existing and empty directory. This directory will contain the generated PHP classes after the generator is finished.
 
 As an optional parameter you can set up a *GeneratorConfiguration* object to configure your Generator and/or use the method *generateModelDirectory* to generate your model directory (will generate the directory if it doesn't exist; if it exists, all contained files and folders will be removed for a clean generation process):
 
@@ -35,7 +46,7 @@ As an optional parameter you can set up a *GeneratorConfiguration* object to con
 
     $generator
         ->generateModelDirectory(__DIR__ . '/result');
-        ->generateModels(__DIR__ . '/schema', __DIR__ . '/result');
+        ->generateModels(new RecursiveDirectoryProvider(__DIR__ . '/schema'), __DIR__ . '/result');
 
 The generator will check the given source directory recursive and convert all found \*.json files to models. All JSON-Schema files inside the source directory must provide a schema of an object.
 

src/ModelGenerator.php

@@ -11,10 +11,9 @@
 use PHPModelGenerator\Model\GeneratorConfiguration;
 use PHPModelGenerator\SchemaProcessor\RenderQueue;
 use PHPModelGenerator\SchemaProcessor\SchemaProcessor;
+use PHPModelGenerator\SchemaProvider\SchemaProviderInterface;
 use RecursiveDirectoryIterator;
 use RecursiveIteratorIterator;
-use RecursiveRegexIterator;
-use RegexIterator;
 
 /**
  * Class ModelGenerator
@@ -64,8 +63,8 @@ public function generateModelDirectory(string $modelPath, int $directoryMode = 0
     /**
      * Generate models from JSON-Schema files. Returns an array of generated file names on success.
      *
-     * @param string $source      The directory with the JSON-Schema files
-     * @param string $destination The directory where to put the generated PHP models
+     * @param SchemaProviderInterface $schemaProvider The provider used to fetch the JSON schemas to process
+     * @param string $destination                     The directory where to put the generated PHP models
      *
      * @return array
      *
@@ -75,21 +74,22 @@ public function generateModelDirectory(string $modelPath, int $directoryMode = 0
      * @throws FileSystemException      Will be thrown if a file system error occurred
      * @throws RenderException          Will be thrown if a class can't be rendered correctly
      */
-    public function generateModels(string $source, string $destination): array
+    public function generateModels(SchemaProviderInterface $schemaProvider, string $destination): array
     {
-        if (!is_dir($source)) {
-            throw new FileSystemException("Source directory '$source' doesn't exist");
-        }
-
         if (!is_dir($destination) || count(scandir($destination)) > 2) {
             throw new FileSystemException("Destination directory '$destination' doesn't exist or is not empty");
         }
 
         $renderQueue = new RenderQueue();
-        $schemaProcessor = new SchemaProcessor($source, $destination, $this->generatorConfiguration, $renderQueue);
-
-        foreach ($this->getSchemaFiles($source) as $jsonSchemaFile) {
-            $schemaProcessor->process($jsonSchemaFile);
+        $schemaProcessor = new SchemaProcessor(
+            $schemaProvider->getBaseDirectory(),
+            $destination,
+            $this->generatorConfiguration,
+            $renderQueue
+        );
+
+        foreach ($schemaProvider->getSchemas() as [$filePath, $jsonSchema]) {
+            $schemaProcessor->process($jsonSchema, $filePath);
         }
 
         // render all collected classes
@@ -104,24 +104,4 @@ public function generateModels(string $source, string $destination): array
 
         return $schemaProcessor->getGeneratedFiles();
     }
-
-    /**
-     * Get all json files from a given directory
-     *
-     * @param string $directory
-     *
-     * @return array
-     */
-    protected function getSchemaFiles(string $directory) : array
-    {
-        $directory = new RecursiveDirectoryIterator($directory);
-        $iterator = new RecursiveIteratorIterator($directory);
-        $files = [];
-
-        foreach (new RegexIterator($iterator, '/^.+\.json$/i', RecursiveRegexIterator::GET_MATCH) as $file) {
-            $files[] = $file[0];
-        }
-
-        return $files;
-    }
 }

src/SchemaProcessor/SchemaProcessor.php

@@ -25,7 +25,7 @@ class SchemaProcessor
     /** @var RenderQueue */
     protected $renderQueue;
     /** @var string */
-    protected $source;
+    protected $baseSource;
     /** @var string */
     protected $destination;
 
@@ -42,18 +42,18 @@ class SchemaProcessor
     /**
      * SchemaProcessor constructor.
      *
-     * @param string                 $source
+     * @param string                 $baseSource
      * @param string                 $destination
      * @param GeneratorConfiguration $generatorConfiguration
      * @param RenderQueue            $renderQueue
      */
     public function __construct(
-        string $source,
+        string $baseSource,
         string $destination,
         GeneratorConfiguration $generatorConfiguration,
         RenderQueue $renderQueue
     ) {
-        $this->source = $source;
+        $this->baseSource = $baseSource;
         $this->destination = $destination;
         $this->generatorConfiguration = $generatorConfiguration;
         $this->renderQueue = $renderQueue;
@@ -62,30 +62,25 @@ public function __construct(
     /**
      * Process a given json schema file
      *
-     * @param string $jsonSchemaFile
+     * @param array $jsonSchema
+     * @param string $sourcePath
      *
      * @throws SchemaException
      */
-    public function process(string $jsonSchemaFile): void
+    public function process(array $jsonSchema, string $sourcePath): void
     {
-        $jsonSchema = file_get_contents($jsonSchemaFile);
-
-        if (!$jsonSchema || !($decodedJsonSchema = json_decode($jsonSchema, true))) {
-            throw new SchemaException("Invalid JSON-Schema file $jsonSchemaFile");
-        }
-
-        $this->setCurrentClassPath($jsonSchemaFile);
+        $this->setCurrentClassPath($sourcePath);
         $this->currentClassName = $this->generatorConfiguration->getClassNameGenerator()->getClassName(
-            str_ireplace('.json', '', basename($jsonSchemaFile)),
-            $decodedJsonSchema,
+            str_ireplace('.json', '', basename($sourcePath)),
+            $jsonSchema,
             false
         );
 
         $this->processSchema(
-            $decodedJsonSchema,
+            $jsonSchema,
             $this->currentClassPath,
             $this->currentClassName,
-            new SchemaDefinitionDictionary(dirname($jsonSchemaFile)),
+            new SchemaDefinitionDictionary(dirname($sourcePath)),
             true
         );
     }
@@ -205,7 +200,7 @@ public function generateClassFile(
      */
     protected function setCurrentClassPath(string $jsonSchemaFile): void
     {
-        $path = str_replace($this->source, '', dirname($jsonSchemaFile));
+        $path = str_replace($this->baseSource, '', dirname($jsonSchemaFile));
         $pieces = array_map(
             function ($directory) {
                 return ucfirst($directory);

src/SchemaProvider/OpenAPIv3Provider.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPModelGenerator\SchemaProvider;
+
+use PHPModelGenerator\Exception\SchemaException;
+
+/**
+ * Class OpenAPIv3Provider
+ *
+ * @package PHPModelGenerator\SchemaProvider
+ */
+class OpenAPIv3Provider implements SchemaProviderInterface
+{
+    /** @var array */
+    private $openAPIv3Spec;
+    /** @var string */
+    private $sourceFile;
+
+    /**
+     * OpenAPIv3Provider constructor.
+     *
+     * @param string $sourceFile
+     *
+     * @throws SchemaException
+     */
+    public function __construct(string $sourceFile)
+    {
+        $this->sourceFile = $sourceFile;
+        $jsonSchema = file_get_contents($sourceFile);
+
+        if (!$jsonSchema || !($this->openAPIv3Spec = json_decode($jsonSchema, true))) {
+            throw new SchemaException("Invalid JSON-Schema file $sourceFile");
+        }
+
+        if (!isset($this->openAPIv3Spec['components']['schemas'])) {
+            throw new SchemaException("Open API v3 spec file $sourceFile doesn't contain any schemas to process");
+        }
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getSchemas(): iterable
+    {
+        foreach ($this->openAPIv3Spec['components']['schemas'] as $schemaKey => $schema) {
+            // use the key of the current schema as $id if no $id is specified
+            if (!isset($schema['$id'])) {
+                $schema['$id'] = $schemaKey;
+            }
+
+            yield [$this->sourceFile, $schema];
+        }
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getBaseDirectory(): string
+    {
+        return dirname($this->sourceFile);
+    }
+}

src/SchemaProvider/RecursiveDirectoryProvider.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPModelGenerator\SchemaProvider;
+
+use PHPModelGenerator\Exception\FileSystemException;
+use PHPModelGenerator\Exception\SchemaException;
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+use RecursiveRegexIterator;
+use RegexIterator;
+
+/**
+ * Class RecursiveDirectoryProvider
+ *
+ * @package PHPModelGenerator\SchemaProvider
+ */
+class RecursiveDirectoryProvider implements SchemaProviderInterface
+{
+    /** @var string */
+    private $sourceDirectory;
+
+    /**
+     * RecursiveDirectoryProvider constructor.
+     *
+     * @param string $sourceDirectory
+     *
+     * @throws FileSystemException
+     */
+    public function __construct(string $sourceDirectory)
+    {
+        if (!is_dir($sourceDirectory)) {
+            throw new FileSystemException("Source directory '$sourceDirectory' doesn't exist");
+        }
+
+        $this->sourceDirectory = $sourceDirectory;
+    }
+
+    /**
+     * @inheritDoc
+     *
+     * @throws SchemaException
+     */
+    public function getSchemas(): iterable
+    {
+        $directory = new RecursiveDirectoryIterator($this->sourceDirectory);
+        $iterator = new RecursiveIteratorIterator($directory);
+
+        foreach (new RegexIterator($iterator, '/^.+\.json$/i', RecursiveRegexIterator::GET_MATCH) as $file) {
+            $jsonSchema = file_get_contents($file[0]);
+
+            if (!$jsonSchema || !($decodedJsonSchema = json_decode($jsonSchema, true))) {
+                throw new SchemaException("Invalid JSON-Schema file {$file[0]}");
+            }
+
+            yield [$file[0], $decodedJsonSchema];
+        }
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getBaseDirectory(): string
+    {
+        return $this->sourceDirectory;
+    }
+}

src/SchemaProvider/SchemaProviderInterface.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPModelGenerator\SchemaProvider;
+
+/**
+ * Interface SchemaProviderInterface
+ *
+ * @package PHPModelGenerator\SchemaProvider
+ */
+interface SchemaProviderInterface
+{
+    /**
+     * Provide an iterable containing all schemas which should be processed.
+     * Each entry must be represented by a data tuple [string $sourceFile, array $jsonSchema] where $sourceFile contains
+     * the full file path of the file which contains the JSON schema (used for namespacing) and $jsonSchema must contain
+     * the decoded schema.
+     *
+     * @return iterable
+     */
+    public function getSchemas(): iterable;
+
+    /**
+     * Get the base directory of the provider
+     *
+     * @return string
+     */
+    public function getBaseDirectory(): string;
+}