Skip to content

Commit 98ffcb9

Browse files
vearutopvearutop
authored
Merge pull request #41 from swaggest/deep-ref-export
keep intermediate references in path
2 parents dfe67fc + fcefa57 commit 98ffcb9

File tree

10 files changed

+269
-10
lines changed

10 files changed

+269
-10
lines changed

‎src/Context.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ class Context extends MagicMap
4848
public $version = Schema::VERSION_AUTO;
4949

5050
public $exportedDefinitions = [];
51+
52+
public $isRef = false;
53+
5154
/**
5255
* @param boolean $skipValidation
5356
* @return Context

‎src/Schema.php‎

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -706,6 +706,9 @@ private function processObject($data, Context $options, $path, $result = null)
706706
try {
707707
$refResult = $this->process($data, $options, $path . '->$ref:' . $refString, $result);
708708
if ($refResult instanceof ObjectItemContract) {
709+
if ($refResult->getFromRefs()) {
710+
$refResult = clone $refResult; // @todo check performance, consider option
711+
}
709712
$refResult->setFromRef($refString);
710713
}
711714
$ref->setImported($refResult);
@@ -1025,24 +1028,39 @@ public function process($data, Context $options, $path = '#', $result = null)
10251028
if ('#' === $path) {
10261029
$injectDefinitions = new ScopeExit(function () use ($result, $options) {
10271030
foreach ($options->exportedDefinitions as $ref => $data) {
1028-
JsonPointer::add($result, JsonPointer::splitPath($ref), $data,
1029-
JsonPointer::SKIP_IF_ISSET + JsonPointer::RECURSIVE_KEY_CREATION);
1031+
if ($data !== null) {
1032+
JsonPointer::add($result, JsonPointer::splitPath($ref), $data,
1033+
/*JsonPointer::SKIP_IF_ISSET + */
1034+
JsonPointer::RECURSIVE_KEY_CREATION);
1035+
}
10301036
}
10311037
});
10321038
}
10331039

1034-
if ('#' !== $path && $ref = $data->getFromRef()) {
1035-
if ($ref[0] === '#') {
1036-
if (isset($options->exportedDefinitions[$ref])) {
1037-
$result->{self::PROP_REF} = $ref;
1038-
return $result;
1039-
} elseif (!array_key_exists($ref, $options->exportedDefinitions)) {
1040+
if ($options->isRef) {
1041+
$options->isRef = false;
1042+
} else {
1043+
if ('#' !== $path && $refs = $data->getFromRefs()) {
1044+
$ref = $refs[0];
1045+
if (!array_key_exists($ref, $options->exportedDefinitions) && strpos($ref, '://') === false) {
10401046
$exported = null;
10411047
$options->exportedDefinitions[$ref] = &$exported;
1048+
$options->isRef = true;
10421049
$exported = $this->process($data, $options, $ref);
1043-
$result->{self::PROP_REF} = $ref;
1044-
return $result;
1050+
unset($exported);
1051+
}
1052+
1053+
for ($i = 1; $i < count($refs); $i++) {
1054+
$ref = $refs[$i];
1055+
if (!array_key_exists($ref, $options->exportedDefinitions) && strpos($ref, '://') === false) {
1056+
$exported = new \stdClass();
1057+
$exported->{self::PROP_REF} = $refs[$i - 1];
1058+
$options->exportedDefinitions[$ref] = $exported;
1059+
}
10451060
}
1061+
1062+
$result->{self::PROP_REF} = $refs[count($refs) - 1];
1063+
return $result;
10461064
}
10471065
}
10481066

‎src/Structure/ObjectItem.php‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
namespace Swaggest\JsonSchema\Structure;
44

5+
/**
6+
* @method getNestedObject($className);
7+
* @method setNestedProperty($propertyName, $value, Egg $nestedEgg);
8+
* @method addAdditionalPropertyName($name);
9+
* @method setDocumentPath($path);
10+
* @method setFromRef($ref);
11+
* @method string|null getFromRef();
12+
* @method string[]|null getFromRefs();
13+
*/
514
class ObjectItem implements ObjectItemContract
615
{
716
use ObjectItemTrait;

‎src/Structure/ObjectItemContract.php‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,15 @@ public function setNestedProperty($propertyName, $value, Egg $nestedEgg);
1010
public function addAdditionalPropertyName($name);
1111
public function setDocumentPath($path);
1212
public function setFromRef($ref);
13+
14+
/**
15+
* @return string
16+
* @deprecated
17+
*/
1318
public function getFromRef();
19+
20+
/**
21+
* @return string[]|null
22+
*/
23+
public function getFromRefs();
1424
}

‎src/Structure/ObjectItemTrait.php‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,13 +104,31 @@ public function setDocumentPath($path)
104104
}
105105

106106
/**
107+
* @see ObjectItemContract::getFromRef
108+
* @deprecated use ObjectItemContract::getFromRefs
109+
* @see ObjectItemContract::getFromRefs
110+
* @todo remove
107111
* @return string
108112
*/
109113
public function getFromRef()
110114
{
111115
return null === $this->__fromRef ? null : $this->__fromRef[0];
112116
}
113117

118+
/**
119+
* @see ObjectItemContract::getFromRef
120+
* @return string
121+
*/
122+
public function getFromRefs()
123+
{
124+
return $this->__fromRef;
125+
}
126+
127+
/**
128+
* @see ObjectItemContract::setFromRef
129+
* @param string $ref
130+
* @return $this
131+
*/
114132
public function setFromRef($ref)
115133
{
116134
if (null === $this->__fromRef) {

‎tests/src/Helper/DeepRefAnotherTitle.php‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?php
2+
3+
namespace Swaggest\JsonSchema\Tests\Helper;
4+
5+
6+
use Swaggest\JsonSchema\Constraint\Properties;
7+
use Swaggest\JsonSchema\Schema;
8+
use Swaggest\JsonSchema\Structure\ClassStructure;
9+
10+
class DeepRefAnotherTitle extends ClassStructure
11+
{
12+
/**
13+
* @param Properties|static $properties
14+
* @param Schema $ownerSchema
15+
*/
16+
public static function setUpProperties($properties, Schema $ownerSchema)
17+
{
18+
$ownerSchema->setFromRef('http://json-schema.org/draft-04/schema#/properties/title');
19+
$ownerSchema->setFromRef('#/definitions/anotherTitle');
20+
}
21+
22+
}

‎tests/src/Helper/DeepRefProperty.php‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?php
2+
3+
namespace Swaggest\JsonSchema\Tests\Helper;
4+
5+
use Swaggest\JsonSchema\Constraint\Properties;
6+
use Swaggest\JsonSchema\Schema;
7+
use Swaggest\JsonSchema\Structure\ClassStructure;
8+
9+
class DeepRefProperty extends ClassStructure
10+
{
11+
/**
12+
* @param Properties|static $properties
13+
* @param Schema $ownerSchema
14+
*/
15+
public static function setUpProperties($properties, Schema $ownerSchema)
16+
{
17+
$ownerSchema->type = Schema::OBJECT;
18+
$ownerSchema->setFromRef('#/definitions/lvlA');
19+
$ownerSchema->setFromRef('#/definitions/lvlB');
20+
$ownerSchema->setFromRef('#/definitions/lvlC');
21+
$ownerSchema->setFromRef('#/definitions/lvlD');
22+
}
23+
24+
25+
}

‎tests/src/Helper/DeepRefRoot.php‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<?php
2+
3+
namespace Swaggest\JsonSchema\Tests\Helper;
4+
5+
6+
use Swaggest\JsonSchema\Constraint\Properties;
7+
use Swaggest\JsonSchema\Schema;
8+
use Swaggest\JsonSchema\Structure\ClassStructure;
9+
10+
class DeepRefRoot extends ClassStructure
11+
{
12+
public $directTitle;
13+
14+
public $intermediateTitle;
15+
16+
public $anotherTitle;
17+
18+
public $prop;
19+
20+
/**
21+
* @param Properties|static $properties
22+
* @param Schema $ownerSchema
23+
*/
24+
public static function setUpProperties($properties, Schema $ownerSchema)
25+
{
26+
$properties->prop = DeepRefProperty::schema();
27+
28+
$properties->directTitle = new Schema();
29+
$properties->directTitle->ref = 'http://json-schema.org/draft-04/schema#/properties/title';
30+
31+
$properties->intermediateTitle = DeepRefTitle::schema();
32+
33+
$properties->anotherTitle = DeepRefAnotherTitle::schema();
34+
35+
$ownerSchema->type = Schema::STRING;
36+
}
37+
}

‎tests/src/Helper/DeepRefTitle.php‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<?php
2+
3+
namespace Swaggest\JsonSchema\Tests\Helper;
4+
5+
6+
use Swaggest\JsonSchema\Constraint\Properties;
7+
use Swaggest\JsonSchema\Schema;
8+
use Swaggest\JsonSchema\Structure\ClassStructure;
9+
10+
class DeepRefTitle extends ClassStructure
11+
{
12+
/**
13+
* @param Properties|static $properties
14+
* @param Schema $ownerSchema
15+
*/
16+
public static function setUpProperties($properties, Schema $ownerSchema)
17+
{
18+
$ownerSchema->setFromRef('http://json-schema.org/draft-04/schema#/properties/title');
19+
$ownerSchema->setFromRef('#/definitions/title');
20+
}
21+
}

‎tests/src/PHPUnit/ClassStructure/ExportSchemaTest.php‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
use Swaggest\JsonSchema\Schema;
77
use Swaggest\JsonSchema\Tests\Helper\DbId;
8+
use Swaggest\JsonSchema\Tests\Helper\DeepRefRoot;
89

910
class ExportSchemaTest extends \PHPUnit_Framework_TestCase
1011
{
@@ -34,4 +35,99 @@ public function testSchemaExport()
3435
$this->assertSame($expected, json_encode($schemaData, JSON_PRETTY_PRINT + JSON_UNESCAPED_SLASHES));
3536
}
3637

38+
public function testDeepRef()
39+
{
40+
$schema = DeepRefRoot::schema();
41+
$schemaData = Schema::export($schema);
42+
43+
$expected = <<<'JSON'
44+
{
45+
"properties": {
46+
"prop": {
47+
"$ref": "#/definitions/lvlD"
48+
},
49+
"directTitle": {
50+
"$ref": "http://json-schema.org/draft-04/schema#/properties/title"
51+
},
52+
"intermediateTitle": {
53+
"$ref": "#/definitions/title"
54+
},
55+
"anotherTitle": {
56+
"$ref": "#/definitions/anotherTitle"
57+
}
58+
},
59+
"type": "string",
60+
"definitions": {
61+
"lvlA": {
62+
"type": "object"
63+
},
64+
"lvlB": {
65+
"$ref": "#/definitions/lvlA"
66+
},
67+
"lvlC": {
68+
"$ref": "#/definitions/lvlB"
69+
},
70+
"lvlD": {
71+
"$ref": "#/definitions/lvlC"
72+
},
73+
"title": {
74+
"$ref": "http://json-schema.org/draft-04/schema#/properties/title"
75+
},
76+
"anotherTitle": {
77+
"$ref": "http://json-schema.org/draft-04/schema#/properties/title"
78+
}
79+
}
80+
}
81+
JSON;
82+
83+
$this->assertSame($expected, json_encode($schemaData, JSON_PRETTY_PRINT + JSON_UNESCAPED_SLASHES));
84+
85+
86+
}
87+
88+
public function testDeepRefSchema()
89+
{
90+
$schemaJson = <<<'JSON'
91+
{
92+
"definitions": {
93+
"lvl1": {
94+
"$ref": "#/definitions/lvl2"
95+
},
96+
"lvl2": {
97+
"$ref": "#/definitions/lvl3"
98+
},
99+
"lvl3": {
100+
"$ref": "#/definitions/lvl4"
101+
},
102+
"lvl4": {
103+
"type": "integer"
104+
},
105+
"title": {
106+
"$ref": "http://json-schema.org/draft-04/schema#/properties/title"
107+
},
108+
"anotherTitle": {
109+
"$ref": "http://json-schema.org/draft-04/schema#/properties/title"
110+
}
111+
},
112+
"properties": {
113+
"prop": {
114+
"$ref": "#/definitions/lvl1"
115+
},
116+
"intermediateTitle": {
117+
"$ref": "#/definitions/title"
118+
},
119+
"anotherTitle": {
120+
"$ref": "#/definitions/anotherTitle"
121+
}
122+
},
123+
"type": "object"
124+
}
125+
JSON;
126+
$schemaData = json_decode($schemaJson);
127+
128+
$schema = Schema::import($schemaData);
129+
$exported = Schema::export($schema);
130+
$this->assertSame($schemaJson, json_encode($exported, JSON_PRETTY_PRINT + JSON_UNESCAPED_SLASHES));
131+
}
132+
37133
}

0 commit comments

Comments
 (0)