Enable external network references

Author: wol-soft

src/Model/SchemaDefinition/SchemaDefinitionDictionary.php

@@ -117,7 +117,6 @@ public function getDefinition(string $key, SchemaProcessor $schemaProcessor, arr
 
         if (!isset($this[$key]) && strstr($key, '#', true)) {
             [$jsonSchemaFile, $externalKey] = explode('#', $key);
-            $jsonSchemaFile = $this->sourceDirectory . DIRECTORY_SEPARATOR . $jsonSchemaFile;
 
             if (array_key_exists($jsonSchemaFile, $this->parsedExternalFileSchemas)) {
                 return $this->parsedExternalFileSchemas[$jsonSchemaFile]->getSchemaDictionary()->getDefinition(
@@ -151,17 +150,21 @@ protected function parseExternalFile(
         SchemaProcessor $schemaProcessor,
         array &$path
     ): ?SchemaDefinition {
-        if (!is_file($jsonSchemaFile)) {
-            return null;
+        $jsonSchemaFilePath = filter_var($jsonSchemaFile, FILTER_VALIDATE_URL)
+            ? $jsonSchemaFile
+            : $this->sourceDirectory . '/' . $jsonSchemaFile;
+
+        if (!filter_var($jsonSchemaFilePath, FILTER_VALIDATE_URL) && !is_file($jsonSchemaFilePath)) {
+            throw new SchemaException("Reference to non existing JSON-Schema file $path");
         }
 
-        $jsonSchema = file_get_contents($jsonSchemaFile);
+        $jsonSchema = file_get_contents($jsonSchemaFilePath);
 
         if (!$jsonSchema || !($jsonSchema = json_decode($jsonSchema, true))) {
-            throw new SchemaException("Invalid JSON-Schema file $jsonSchemaFile");
+            throw new SchemaException("Invalid JSON-Schema file $jsonSchemaFilePath");
         }
 
-        $schema = new Schema(new self(dirname($jsonSchemaFile)));
+        $schema = new Schema(new self(dirname($jsonSchemaFilePath)));
         $schema->getSchemaDictionary()->setUpDefinitionDictionary($jsonSchema, $schemaProcessor, $schema);
         $this->parsedExternalFileSchemas[$jsonSchemaFile] = $schema;
 

src/PropertyProcessor/Property/ReferenceProcessor.php

@@ -25,14 +25,15 @@ public function process(string $propertyName, array $propertyData): PropertyInte
         $path = [];
         $reference = $propertyData['$ref'];
         $dictionary = $this->schema->getSchemaDictionary();
-        $definition = $dictionary->getDefinition($reference, $this->schemaProcessor, $path);
 
-        if ($definition) {
-            try {
+        try {
+            $definition = $dictionary->getDefinition($reference, $this->schemaProcessor, $path);
+
+            if ($definition) {
                 return $definition->resolveReference($propertyName, $path, $this->propertyCollectionProcessor);
-            } catch (Exception $exception) {
-                throw new SchemaException("Unresolved Reference: $reference", 0, $exception);
             }
+        } catch (Exception $exception) {
+            throw new SchemaException("Unresolved Reference: $reference", 0, $exception);
         }
 
         throw new SchemaException("Unresolved Reference: $reference");

tests/Objects/ReferencePropertyTest.php

@@ -389,13 +389,17 @@ public function invalidCombinedReferenceObjectPropertyTypeDataProvider(): array
     }
 
     /**
+     * @dataProvider nestedReferenceProvider
+     *
+     * @param string $reference
+     *
      * @throws FileSystemException
      * @throws RenderException
      * @throws SchemaException
      */
-    public function testNestedExternalReference(): void
+    public function testNestedExternalReference(string $reference): void
     {
-        $className = $this->generateObjectFromFile('NestedExternalReference.json');
+        $className = $this->generateObjectFromFileTemplate('NestedExternalReference.json', [$reference]);
 
         $object = new $className([
             'family' => [
@@ -422,6 +426,14 @@ public function testNestedExternalReference(): void
         $this->assertEmpty($object->getFamily()->getMember()[1]->getChildren());
     }
 
+    public function nestedReferenceProvider(): array
+    {
+        return [
+            'Local reference' => ['external/library.json'],
+            'Network reference' => ['https://raw.githubusercontent.com/wol-soft/php-json-schema-model-generator/master/tests/Schema/ReferencePropertyTest/external/library.json'],
+        ];
+    }
+
     /**
      * Combine two data providers
      *

tests/Schema/ReferencePropertyTest/NestedExternalReference.json

@@ -2,7 +2,7 @@
   "type": "object",
   "properties": {
     "family": {
-      "$ref": "external/library.json#/definitions/family"
+      "$ref": "%s#/definitions/family"
     }
   }
 }