Skip to content

Commit 3310737

Browse files
cebecebe
authored
Merge pull request #75 from php-openapi/74-invalid-schema-reference-error
Resolve: Invalid schema reference error
2 parents 914b858 + 09404e0 commit 3310737

File tree

16 files changed

+447
-5
lines changed

16 files changed

+447
-5
lines changed

‎src/lib/AttributeResolver.php‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -498,9 +498,13 @@ protected function resolvePropertyRef(PropertySchema $property, Attribute $attri
498498
$attribute->setPhpType($fkProperty->guessPhpType())
499499
->setDbType($fkProperty->guessDbType(true))
500500
->setSize($fkProperty->getMaxLength())
501-
->setDescription($fkProperty->getAttr('description'))
501+
->setDescription($fkProperty->getAttr('description', ''))
502502
->setDefault($fkProperty->guessDefault())
503503
->setLimits($min, $max, $fkProperty->getMinLength());
504+
505+
if ($fkProperty->hasEnum()) {
506+
$attribute->setEnumValues($fkProperty->getAttr('enum'));
507+
}
504508
$this->attributes[$property->getName()] =
505509
$attribute->setFakerStub($this->guessFakerStub($attribute, $fkProperty));
506510
}

‎src/lib/migrations/BaseMigrationBuilder.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -491,7 +491,7 @@ public function tmpSaveNewCol(string $tableAlias, \cebe\yii2openapi\db\ColumnSch
491491

492492
Yii::$app->db->createCommand()->createTable($tmpTableName, $column)->execute();
493493
if (ApiGenerator::isPostgres() && $columnSchema->comment) {
494-
Yii::$app->db->createCommand("COMMENT ON COLUMN $tmpTableName.$columnSchema->name IS {$this->db->quoteValue($columnSchema->comment)}")->execute();
494+
Yii::$app->db->createCommand("COMMENT ON COLUMN $tmpTableName.\"$columnSchema->name\" IS {$this->db->quoteValue($columnSchema->comment)}")->execute();
495495
}
496496

497497
$table = Yii::$app->db->getTableSchema($tmpTableName);

‎src/lib/openapi/PropertySchema.php‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ class PropertySchema
7070

7171
/** @var string $refPointer */
7272
private $refPointer;
73+
private $uri;
7374

7475
/** @var \cebe\yii2openapi\lib\openapi\ComponentSchema $refSchema */
7576
private $refSchema;
@@ -170,6 +171,7 @@ private function initReference():void
170171
{
171172
$this->isReference = true;
172173
$this->refPointer = $this->property->getJsonReference()->getJsonPointer()->getPointer();
174+
$this->uri = $this->property->getJsonReference()->getDocumentUri();
173175
$refSchemaName = $this->getRefSchemaName();
174176
if ($this->isRefPointerToSelf()) {
175177
$this->refSchema = $this->schema;
@@ -194,6 +196,7 @@ private function initItemsReference():void
194196
return;
195197
}
196198
$this->refPointer = $items->getJsonReference()->getJsonPointer()->getPointer();
199+
$this->uri = $items->getJsonReference()->getDocumentUri();
197200
if ($this->isRefPointerToSelf()) {
198201
$this->refSchema = $this->schema;
199202
} elseif ($this->isRefPointerToSchema()) {
@@ -264,7 +267,9 @@ public function getSelfTargetProperty():?PropertySchema
264267

265268
public function isRefPointerToSchema():bool
266269
{
267-
return $this->refPointer && strpos($this->refPointer, self::REFERENCE_PATH) === 0;
270+
return $this->refPointer &&
271+
((strpos($this->refPointer, self::REFERENCE_PATH) === 0) ||
272+
(str_ends_with($this->uri, '.yml')) || (str_ends_with($this->uri, '.yaml')));
268273
}
269274

270275
public function isRefPointerToSelf():bool
@@ -300,8 +305,13 @@ public function getRefSchemaName():string
300305
$pattern = strpos($this->refPointer, '/properties/') !== false ?
301306
'~^'.self::REFERENCE_PATH.'(?<schemaName>.+)/properties/(?<propName>.+)$~'
302307
: '~^'.self::REFERENCE_PATH.'(?<schemaName>.+)$~';
308+
$separateFilePattern = '/((\.\/)*)(?<schemaName>.+)(\.)(yml|yaml)(.*)/'; # https://github.com/php-openapi/yii2-openapi/issues/74
303309
if (!\preg_match($pattern, $this->refPointer, $matches)) {
304-
throw new InvalidDefinitionException('Invalid schema reference');
310+
if (!\preg_match($separateFilePattern, $this->uri, $separateFilePatternMatches)) {
311+
throw new InvalidDefinitionException('Invalid schema reference');
312+
} else {
313+
return $separateFilePatternMatches['schemaName'];
314+
}
305315
}
306316
return $matches['schemaName'];
307317
}

‎tests/specs/issue_fix/74_invalid_schema_reference_error/Product.yaml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Product:
2+
title: Product
3+
x-table: products
4+
type: object
5+
6+
required:
7+
- id
8+
- vat_rate
9+
10+
properties:
11+
id:
12+
type: integer
13+
vat_rate:
14+
type: string
15+
enum:
16+
- standard
17+
- none
18+
default: standard

‎tests/specs/issue_fix/74_invalid_schema_reference_error/index.php‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?php
2+
3+
return [
4+
'openApiPath' => '@specs/issue_fix/74_invalid_schema_reference_error/index.yaml',
5+
'generateUrls' => false,
6+
'generateModels' => true,
7+
'excludeModels' => [
8+
'Error',
9+
],
10+
'generateControllers' => false,
11+
'generateMigrations' => true,
12+
'generateModelFaker' => true, // `generateModels` must be `true` in order to use `generateModelFaker` as `true`
13+
];

‎tests/specs/issue_fix/74_invalid_schema_reference_error/index.yaml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
openapi: "3.0.0"
2+
info:
3+
version: 1.0.0
4+
title: Invalid schema reference error \#74
5+
paths:
6+
/:
7+
get:
8+
responses:
9+
'200':
10+
description: The information
11+
12+
components:
13+
schemas:
14+
Invoice:
15+
type: object
16+
required:
17+
- vat_rate
18+
properties:
19+
id:
20+
type: integer
21+
vat_rate:
22+
# $ref: '#/components/schemas/Product/properties/vat_rate' # issue is not observed
23+
$ref: './Product.yaml#/properties/vat_rate' # issue is observed
24+
Product:
25+
$ref: ./Product.yaml

‎tests/specs/issue_fix/74_invalid_schema_reference_error/mysql/migrations_mysql_db/m200000_000000_create_table_invoices.php‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
3+
/**
4+
* Table for Invoice
5+
*/
6+
class m200000_000000_create_table_invoices extends \yii\db\Migration
7+
{
8+
public function up()
9+
{
10+
$this->createTable('{{%invoices}}', [
11+
'id' => $this->primaryKey(),
12+
'vat_rate' => 'enum("standard", "none") NOT NULL DEFAULT \'standard\'',
13+
]);
14+
}
15+
16+
public function down()
17+
{
18+
$this->dropTable('{{%invoices}}');
19+
}
20+
}

‎tests/specs/issue_fix/74_invalid_schema_reference_error/mysql/migrations_mysql_db/m200000_000001_create_table_products.php‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
3+
/**
4+
* Table for Product
5+
*/
6+
class m200000_000001_create_table_products extends \yii\db\Migration
7+
{
8+
public function up()
9+
{
10+
$this->createTable('{{%products}}', [
11+
'id' => $this->primaryKey(),
12+
'vat_rate' => 'enum("standard", "none") NOT NULL DEFAULT \'standard\'',
13+
]);
14+
}
15+
16+
public function down()
17+
{
18+
$this->dropTable('{{%products}}');
19+
}
20+
}

‎tests/specs/issue_fix/74_invalid_schema_reference_error/mysql/models/BaseModelFaker.php‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
<?php
2+
3+
namespace app\models;
4+
5+
use Faker\Factory as FakerFactory;
6+
use Faker\Generator;
7+
use Faker\UniqueGenerator;
8+
9+
/**
10+
* Base fake data generator
11+
*/
12+
abstract class BaseModelFaker
13+
{
14+
/**
15+
* @var Generator
16+
*/
17+
protected $faker;
18+
/**
19+
* @var UniqueGenerator
20+
*/
21+
protected $uniqueFaker;
22+
23+
public function __construct()
24+
{
25+
$this->faker = FakerFactory::create(str_replace('-', '_', \Yii::$app->language));
26+
$this->uniqueFaker = new UniqueGenerator($this->faker);
27+
}
28+
29+
abstract public function generateModel($attributes = []);
30+
31+
public function getFaker():Generator
32+
{
33+
return $this->faker;
34+
}
35+
36+
public function getUniqueFaker():UniqueGenerator
37+
{
38+
return $this->uniqueFaker;
39+
}
40+
41+
public function setFaker(Generator $faker):void
42+
{
43+
$this->faker = $faker;
44+
}
45+
46+
public function setUniqueFaker(UniqueGenerator $faker):void
47+
{
48+
$this->uniqueFaker = $faker;
49+
}
50+
51+
/**
52+
* Generate and return model
53+
* @param array|callable $attributes
54+
* @param UniqueGenerator|null $uniqueFaker
55+
* @return \yii\db\ActiveRecord
56+
* @example MyFaker::makeOne(['user_id' => 1, 'title' => 'foo']);
57+
* @example MyFaker::makeOne( function($model, $faker) {
58+
* $model->scenario = 'create';
59+
* $model->setAttributes(['user_id' => 1, 'title' => $faker->sentence]);
60+
* return $model;
61+
* });
62+
*/
63+
public static function makeOne($attributes = [], ?UniqueGenerator $uniqueFaker = null)
64+
{
65+
$fakeBuilder = new static();
66+
if ($uniqueFaker !== null) {
67+
$fakeBuilder->setUniqueFaker($uniqueFaker);
68+
}
69+
$model = $fakeBuilder->generateModel($attributes);
70+
return $model;
71+
}
72+
73+
/**
74+
* Generate, save and return model
75+
* @param array|callable $attributes
76+
* @param UniqueGenerator|null $uniqueFaker
77+
* @return \yii\db\ActiveRecord
78+
* @example MyFaker::saveOne(['user_id' => 1, 'title' => 'foo']);
79+
* @example MyFaker::saveOne( function($model, $faker) {
80+
* $model->scenario = 'create';
81+
* $model->setAttributes(['user_id' => 1, 'title' => $faker->sentence]);
82+
* return $model;
83+
* });
84+
*/
85+
public static function saveOne($attributes = [], ?UniqueGenerator $uniqueFaker = null)
86+
{
87+
$model = static::makeOne($attributes, $uniqueFaker);
88+
$model->save();
89+
return $model;
90+
}
91+
92+
/**
93+
* Generate and return multiple models
94+
* @param int $number
95+
* @param array|callable $commonAttributes
96+
* @return \yii\db\ActiveRecord[]|array
97+
* @example TaskFaker::make(5, ['project_id'=>1, 'user_id' => 2]);
98+
* @example TaskFaker::make(5, function($model, $faker, $uniqueFaker) {
99+
* $model->setAttributes(['name' => $uniqueFaker->username, 'state'=>$faker->boolean(20)]);
100+
* return $model;
101+
* });
102+
*/
103+
public static function make(int $number, $commonAttributes = [], ?UniqueGenerator $uniqueFaker = null):array
104+
{
105+
if ($number < 1) {
106+
return [];
107+
}
108+
$fakeBuilder = new static();
109+
if ($uniqueFaker !== null) {
110+
$fakeBuilder->setUniqueFaker($uniqueFaker);
111+
}
112+
return array_map(function () use ($commonAttributes, $fakeBuilder) {
113+
$model = $fakeBuilder->generateModel($commonAttributes);
114+
return $model;
115+
}, range(0, $number -1));
116+
}
117+
118+
/**
119+
* Generate, save and return multiple models
120+
* @param int $number
121+
* @param array|callable $commonAttributes
122+
* @return \yii\db\ActiveRecord[]|array
123+
* @example TaskFaker::save(5, ['project_id'=>1, 'user_id' => 2]);
124+
* @example TaskFaker::save(5, function($model, $faker, $uniqueFaker) {
125+
* $model->setAttributes(['name' => $uniqueFaker->username, 'state'=>$faker->boolean(20)]);
126+
* return $model;
127+
* });
128+
*/
129+
public static function save(int $number, $commonAttributes = [], ?UniqueGenerator $uniqueFaker = null):array
130+
{
131+
if ($number < 1) {
132+
return [];
133+
}
134+
$fakeBuilder = new static();
135+
if ($uniqueFaker !== null) {
136+
$fakeBuilder->setUniqueFaker($uniqueFaker);
137+
}
138+
return array_map(function () use ($commonAttributes, $fakeBuilder) {
139+
$model = $fakeBuilder->generateModel($commonAttributes);
140+
$model->save();
141+
return $model;
142+
}, range(0, $number -1));
143+
}
144+
}

‎tests/specs/issue_fix/74_invalid_schema_reference_error/mysql/models/Invoice.php‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?php
2+
3+
namespace app\models;
4+
5+
class Invoice extends \app\models\base\Invoice
6+
{
7+
8+
9+
}
10+

0 commit comments

Comments
 (0)