improved evaluating references and guessing model from referenced schema

cebe · cebe · commit 9bff78df132f · 2019-06-26T11:41:18.000+02:00
diff --git a/README.md b/README.md
@@ -4,8 +4,6 @@ REST API application generator for Yii2, openapi 3.0 YAML -> Yii2.
 
 Base on [Gii, the Yii Framework Code Generator](https://www.yiiframework.com/extension/yiisoft/yii2-gii).
 
-[![Total Downloads](https://poser.pugx.org/phpunit/phpunit/downloads)](https://packagist.org/packages/phpunit/phpunit)
-
 [![Latest Stable Version](https://poser.pugx.org/cebe/yii2-openapi/v/stable)](https://packagist.org/packages/cebe/yii2-openapi)
 [![Total Downloads](https://poser.pugx.org/cebe/yii2-openapi/downloads)](https://packagist.org/packages/cebe/yii2-openapi)
 [![License](https://poser.pugx.org/cebe/yii2-openapi/license)](https://packagist.org/packages/cebe/yii2-openapi)
diff --git a/src/generator/ApiGenerator.php b/src/generator/ApiGenerator.php
@@ -396,7 +396,7 @@ protected function generateUrls()
                     'route' => "$controller/$a$action",
                     'actionParams' => $actionParams,
                     'openApiOperation' => $operation,
-                    'modelClass' => $this->modelNamespace . '\\' . $modelClass,
+                    'modelClass' => $modelClass !== null ? $this->modelNamespace . '\\' . $modelClass : null,
                     'responseWrapper' => $responseWrapper,
                 ];
             }
@@ -464,16 +464,16 @@ private function guessModelClassFromContent(MediaType $content)
             $referencedSchema = $content->schema->resolve();
             // Model data is directly returned
             if ($referencedSchema->type === null || $referencedSchema->type === 'object') {
-                $ref = $content->schema->getReference();
-                if (strpos($ref, '#/components/schemas/') === 0) {
-                    return [substr($ref, 21), '', ''];
+                $ref = $content->schema->getJsonReference()->getJsonPointer()->getPointer();
+                if (strpos($ref, '/components/schemas/') === 0) {
+                    return [substr($ref, 20), '', ''];
                 }
             }
             // an array of Model data is directly returned
             if ($referencedSchema->type === 'array' && $referencedSchema->items instanceof Reference) {
-                $ref = $referencedSchema->items->getReference();
-                if (strpos($ref, '#/components/schemas/') === 0) {
-                    return [substr($ref, 21), '', ''];
+                $ref = $referencedSchema->items->getJsonReference()->getJsonPointer()->getPointer();
+                if (strpos($ref, '/components/schemas/') === 0) {
+                    return [substr($ref, 20), '', ''];
                 }
             }
         } else {
@@ -488,26 +488,32 @@ private function guessModelClassFromContent(MediaType $content)
                     $referencedModelSchema = $property->resolve();
                     if ($referencedModelSchema->type === null || $referencedModelSchema->type === 'object') {
                         // Model data is wrapped
-                        $ref = $property->getReference();
-                        if (strpos($ref, '#/components/schemas/') === 0) {
-                            return [substr($ref, 21), $propertyName, null];
+                        $ref = $property->getJsonReference()->getJsonPointer()->getPointer();
+                        if (strpos($ref, '/components/schemas/') === 0) {
+                            return [substr($ref, 20), $propertyName, null];
                         }
                     } elseif ($referencedModelSchema->type === 'array' && $referencedModelSchema->items instanceof Reference) {
                         // an array of Model data is wrapped
-                        $ref = $referencedModelSchema->items->getReference();
-                        if (strpos($ref, '#/components/schemas/') === 0) {
-                            return [substr($ref, 21), null, $propertyName];
+                        $ref = $referencedModelSchema->items->getJsonReference()->getJsonPointer()->getPointer();
+                        if (strpos($ref, '/components/schemas/') === 0) {
+                            return [substr($ref, 20), null, $propertyName];
                         }
                     }
                 } elseif ($property->type === 'array' && $property->items instanceof Reference) {
                     // an array of Model data is wrapped
-                    $ref = $property->items->getReference();
-                    if (strpos($ref, '#/components/schemas/') === 0) {
-                        return [substr($ref, 21), null, $propertyName];
+                    $ref = $property->items->getJsonReference()->getJsonPointer()->getPointer();
+                    if (strpos($ref, '/components/schemas/') === 0) {
+                        return [substr($ref, 20), null, $propertyName];
                     }
                 }
             }
         }
+        if ($referencedSchema->type === 'array' && $referencedSchema->items instanceof Reference) {
+            $ref = $referencedSchema->items->getJsonReference()->getJsonPointer()->getPointer();
+            if (strpos($ref, '/components/schemas/') === 0) {
+                return [substr($ref, 20), '', ''];
+            }
+        }
         return [null, null, null];
     }
 
@@ -588,13 +594,13 @@ protected function generateModels()
 
             foreach ($schema->properties as $name => $property) {
                 if ($property instanceof Reference) {
-                    $ref = $property->getReference();
+                    $ref = $property->getJsonReference()->getJsonPointer()->getPointer();
                     $resolvedProperty = $property->resolve();
                     $dbName = "{$name}_id";
                     $dbType = 'integer'; // for a foreign key
-                    if (strpos($ref, '#/components/schemas/') === 0) {
+                    if (strpos($ref, '/components/schemas/') === 0) {
                         // relation
-                        $type = substr($ref, 21);
+                        $type = substr($ref, 20);
                         $relations[$name] = [
                             'class' => $type,
                             'method' => 'hasOne',
@@ -777,9 +783,9 @@ protected function getSchemaType($schema)
                 return 'float';
             case 'array':
                 if (isset($schema->items) && $schema->items instanceof Reference) {
-                    $ref = $schema->items->getReference();
-                    if (strpos($ref, '#/components/schemas/') === 0) {
-                        return [substr($ref, 21) . '[]', substr($ref, 21)];
+                    $ref = $schema->items->getJsonReference()->getJsonPointer()->getPointer();
+                    if (strpos($ref, '/components/schemas/') === 0) {
+                        return [substr($ref, 20) . '[]', substr($ref, 20)];
                     }
                 }
                 // no break here
@@ -813,9 +819,9 @@ protected function getDbType($name, $schema)
 //            case 'array':
         // TODO array might refer to has_many relation
 //                if (isset($schema->items) && $schema->items instanceof Reference) {
-//                    $ref = $schema->items->getReference();
-//                    if (strpos($ref, '#/components/schemas/') === 0) {
-//                        return substr($ref, 21) . '[]';
+//                    $ref = $schema->items->getJsonReference()->getJsonPointer()->getPointer();
+//                    if (strpos($ref, '/components/schemas/') === 0) {
+//                        return substr($ref, 20) . '[]';
 //                    }
 //                }
 //                // no break here
diff --git a/tests/specs/petstore_arrayref.php b/tests/specs/petstore_arrayref.php
@@ -0,0 +1,12 @@
+<?php
+
+return [
+    'openApiPath' => '@specs/petstore_arrayref.yaml',
+    'generateUrls' => true,
+    'generateModels' => true,
+    'excludeModels' => [
+        'Error',
+    ],
+    'generateControllers' => true,
+    'generateMigrations' => false, // TODO add tests for migrations
+];
diff --git a/tests/specs/petstore_arrayref.yaml b/tests/specs/petstore_arrayref.yaml
@@ -0,0 +1,116 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+servers:
+  - url: http://petstore.swagger.io/v1
+paths:
+  /pets:
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+        - pets
+      parameters:
+        - name: limit
+          in: query
+          description: How many items to return at one time (max 100)
+          required: false
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '200':
+          description: A paged array of pets
+          headers:
+            x-next:
+              description: A link to the next page of responses
+              schema:
+                type: string
+          content:
+            application/json:    
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+        - pets
+      responses:
+        '201':
+          description: Null response
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: The id of the pet to retrieve
+          schema:
+            type: string
+      responses:
+        '200':
+          $ref: "#/components/responses/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+components:
+  schemas:
+    Pet:
+      description: A Pet
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+          x-faker: "$faker->randomElement(['one', 'two', 'three', 'four'])"
+    Pets:
+      type: array
+      items:
+        $ref: "#/components/schemas/Pet"
+    Error:
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string
+  responses:
+    Pets:
+      description: Expected response to a valid request
+      content:
+        application/json:
+          schema:
+            type: array
+            items:
+              $ref: "#/components/schemas/Pet"
diff --git a/tests/specs/petstore_arrayref/config/urls.rest.php b/tests/specs/petstore_arrayref/config/urls.rest.php
@@ -0,0 +1,11 @@
+<?php
+/**
+ * OpenAPI UrlRules
+ *
+ * This file is auto generated.
+ */
+return array (
+  'GET pets' => 'pet/index',
+  'POST pets' => 'pet/create',
+  'GET pets/<petId>' => 'pet/view',
+);
diff --git a/tests/specs/petstore_arrayref/controllers/PetController.php b/tests/specs/petstore_arrayref/controllers/PetController.php
@@ -0,0 +1,48 @@
+<?php
+
+namespace app\controllers;
+
+class PetController extends \yii\rest\Controller
+{
+    public function actions()
+    {
+        return [
+            'index' => [
+                'class' => \yii\rest\IndexAction::class,
+                'modelClass' => \app\models\Pet::class,
+                'checkAccess' => [$this, 'checkAccess'],
+            ],
+            'create' => [
+                'class' => \yii\rest\CreateAction::class,
+                'modelClass' => \app\models\Pet::class,
+                'checkAccess' => [$this, 'checkAccess'],
+            ],
+            'view' => [
+                'class' => \yii\rest\ViewAction::class,
+                'modelClass' => \app\models\Pet::class,
+                'checkAccess' => [$this, 'checkAccess'],
+            ],
+            'options' => [
+                'class' => \yii\rest\OptionsAction::class,
+            ],
+        ];
+    }
+
+    /**
+     * Checks the privilege of the current user.
+     *
+     * This method checks whether the current user has the privilege
+     * to run the specified action against the specified data model.
+     * If the user does not have access, a [[ForbiddenHttpException]] should be thrown.
+     *
+     * @param string $action the ID of the action to be executed
+     * @param object $model the model to be accessed. If null, it means no specific model is being accessed.
+     * @param array $params additional parameters
+     * @throws \yii\web\ForbiddenHttpException if the user does not have access
+     */
+    public function checkAccess($action, $model = null, $params = [])
+    {
+        // TODO implement checkAccess
+    }
+
+}
diff --git a/tests/specs/petstore_arrayref/models/Pet.php b/tests/specs/petstore_arrayref/models/Pet.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace app\models;
+
+/**
+ * A Pet
+ *
+ * @property int $id
+ * @property string $name
+ * @property string $tag
+ */
+class Pet extends \yii\db\ActiveRecord
+{
+    public static function tableName()
+    {
+        return '{{%pets}}';
+    }
+
+}
diff --git a/tests/specs/petstore_arrayref/models/PetFaker.php b/tests/specs/petstore_arrayref/models/PetFaker.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace app\models;
+
+use Faker\Factory as FakerFactory;
+
+/**
+ * Fake data generator for Pet
+ */
+class PetFaker
+{
+    public function generateModel()
+    {
+        $faker = FakerFactory::create(\Yii::$app->language);
+        $model = new Pet;
+        $model->id = $faker->numberBetween(0, PHP_INT_MAX);
+        $model->name = $faker->sentence;
+        $model->tag = $faker->randomElement(['one', 'two', 'three', 'four']);
+        return $model;
+    }
+}
