Merge pull request #88 from Insolita/2_0_improves

2 0 improves

src/generator/default/model.php

@@ -1,73 +1,43 @@
-<?= '<?php' ?>
+<?php
+/**
+ * @var \cebe\yii2openapi\lib\items\DbModel $model
+ * @var string $namespace
+ * @var string $relationNamespace
+ **/
+use yii\helpers\Inflector;
+use yii\helpers\VarDumper;
 
+?>
+<?= '<?php' ?>
 
 namespace <?= $namespace ?>;
 
 use yii\base\Model;
 
 /**
- * <?= str_replace("\n", "\n * ", trim($description)) ?>
+ * <?= empty($model->description) ? '' : str_replace("\n", "\n * ", ' ' . trim($model->description)) ?>
 
  *
  */
-class <?= $className ?> extends Model
+class <?= $model->getClassName() ?> extends Model
 {
-<?php foreach ($attributes as $attribute): ?>
+<?php foreach ($model->attributes as $attribute): ?>
     /**
-     * @var <?= trim(($attribute['type'] ?? 'mixed') . ' ' . str_replace("\n", "\n     * ", rtrim($attribute['description']))) ?>
+    * @var <?=$attribute->phpType.' '.$attribute->description.PHP_EOL?>
+    */
+    public $<?= $attribute->propertyName ?>;
 
-     */
-    public $<?= $attribute['name'] ?>;
 <?php endforeach; ?>
+<?php foreach ($model->relations as $relationName => $relation): ?>
+    /**
+    * @var <?=$relation->isHasOne()? $relation->getClassName(): 'array|'.$relation->getClassName().'[]'.PHP_EOL?>
+    */
+    public $<?= $relationName ?>;
 
+<?php endforeach; ?>
 
     public function rules()
     {
-        return [
-<?php
-    $safeAttributes = [];
-    $requiredAttributes = [];
-    $integerAttributes = [];
-    $stringAttributes = [];
-
-    foreach ($attributes as $attribute) {
-        if ($attribute['readOnly']) {
-            continue;
-        }
-        if ($attribute['required']) {
-            $requiredAttributes[$attribute['name']] = $attribute['name'];
-        }
-        switch ($attribute['type']) {
-            case 'integer':
-                $integerAttributes[$attribute['name']] = $attribute['name'];
-                break;
-            case 'string':
-                $stringAttributes[$attribute['name']] = $attribute['name'];
-                break;
-            default:
-            case 'array':
-                $safeAttributes[$attribute['name']] = $attribute['name'];
-                break;
-        }
-    }
-    if (!empty($stringAttributes)) {
-        echo "            [['" . implode("', '", $stringAttributes) . "'], 'trim'],\n";
-    }
-    if (!empty($requiredAttributes)) {
-        echo "            [['" . implode("', '", $requiredAttributes) . "'], 'required'],\n";
-    }
-    if (!empty($stringAttributes)) {
-        echo "            [['" . implode("', '", $stringAttributes) . "'], 'string'],\n";
-    }
-    if (!empty($integerAttributes)) {
-        echo "            [['" . implode("', '", $integerAttributes) . "'], 'integer'],\n";
-    }
-    if (!empty($safeAttributes)) {
-        echo "            // TODO define more concreate validation rules!\n";
-        echo "            [['" . implode("','", $safeAttributes) . "'], 'safe'],\n";
-    }
-
-?>
-        ];
+        return <?=$model->getValidationRules()?>;
     }
 }

src/lib/CodeFiles.php

@@ -0,0 +1,46 @@
+<?php
+
+/**
+ * @copyright Copyright (c) 2018 Carsten Brandt <[email protected]> and contributors
+ * @license https://github.com/cebe/yii2-openapi/blob/master/LICENSE
+ */
+
+namespace cebe\yii2openapi\lib;
+
+use yii\gii\CodeFile;
+use function array_merge;
+
+class CodeFiles
+{
+    /**
+     * @var array|\yii\gii\CodeFile[]
+     */
+    private $files;
+
+    /**
+     * @param array|\yii\gii\CodeFile[] $files
+     */
+    public function __construct(array $files = [])
+    {
+        $this->files = $files;
+    }
+
+    public function add(CodeFile $file):void
+    {
+        $this->files[] = $file;
+    }
+
+
+    public function merge(CodeFiles $files):void
+    {
+        $this->files = array_merge($this->files, $files->all());
+    }
+
+    /**
+     * @return array|\yii\gii\CodeFile[]
+     */
+    public function all():array
+    {
+        return $this->files;
+    }
+}

src/lib/Config.php

@@ -0,0 +1,201 @@
+<?php
+
+/**
+ * @copyright Copyright (c) 2018 Carsten Brandt <[email protected]> and contributors
+ * @license https://github.com/cebe/yii2-openapi/blob/master/LICENSE
+ */
+
+namespace cebe\yii2openapi\lib;
+
+use cebe\openapi\Reader;
+use cebe\openapi\spec\OpenApi;
+use Closure;
+use Yii;
+use yii\base\BaseObject;
+use yii\base\InvalidConfigException;
+use yii\helpers\StringHelper;
+use function call_user_func;
+
+class Config extends BaseObject
+{
+    /**
+     * @var string path to the OpenAPI specification file. This can be an absolute path or a Yii path alias.
+     */
+    public $openApiPath;
+
+    /**
+     * @var bool whether to generate URL rules for Yii UrlManager from the API spec.
+     */
+    public $generateUrls = true;
+
+    /**
+     * @var string file name for URL rules.
+     */
+    public $urlConfigFile = '@app/config/urls.rest.php';
+
+    /**
+     * @var array Special url prefixes
+     * @example
+     * 'urlPrefixes' => [
+     * //Prefix will be ignored in url pattern,
+     * //Rule like ['/calendar/<controller>/<action>' => '<controller>/<action>']
+     *    'calendar' => '',
+     * //Controller for url with this prefix will be located directly at defined path and namespace
+     * //Rule like ['/api/v1/<controller>/<action>' => '/api/v1/<controller>/<action>']
+     *    'api/v1/' => ['path' => '@app/modules/api/controllers/v1/', 'namespace' => '\app\modules\api\v1'],
+     * //Controller for url with this prefix will be located directly at defined namespace, path resolved by namespace
+     * //Rule like ['/prefix/<controller>/<action>' => '/xxx/<controller>/<action>']
+     *    'prefix' => ['module' => 'xxx','namespace' => '\app\modules\xxx\controllers']
+     * ]
+     **/
+    public $urlPrefixes = [];
+
+    /**
+     * @var bool whether to generate Controllers from the spec.
+     */
+    public $generateControllers = true;
+
+    /**
+     * @var bool use actions that return responses by JsonApi spec instead of default yii rest
+     */
+    public $useJsonApi = false;
+
+    /**
+     * @var bool if true, transformers will be generate in base subdirectory and overridable classes will extend it
+     */
+    public $extendableTransformers = true;
+
+    /**
+     * @var bool if true singular resource keys will be used /post/{id}, plural by default
+     */
+    public $singularResourceKeys = false;
+
+    /**
+     * @var string namespace to create controllers in. This must be resolvable via Yii alias.
+     * Defaults to `null` which means to use the application controller namespace: `Yii::$app->controllerNamespace`.
+     */
+    public $controllerNamespace;
+
+    /**
+     * @var bool whether to generate ActiveRecord models from the spec.
+     */
+    public $generateModels = true;
+
+    /**
+     * @var bool whether to generate Faker for generating dummy data for each model.
+     */
+    public $generateModelFaker = true;
+
+    /**
+     * @var bool namespace to create models in. This must be resolvable via Yii alias.
+     * Defaults to `app\models`.
+     */
+    public $modelNamespace = 'app\\models';
+
+    /**
+     * @var bool namespace to create fake data generators in. This must be resolvable via Yii alias.
+     * Defaults to `app\models`.
+     */
+    public $fakerNamespace = 'app\\models';
+
+    /**
+     * @var string namespace to create fractal transformers in. (Only when generatedControllers and useJsonApi checked)
+     * Defaults to `app\transformers`.
+     */
+    public $transformerNamespace = 'app\\transformers';
+
+    /**
+     * @var array List of model names to exclude.
+     */
+    public $excludeModels = [];
+
+    /**
+     * @var array Map for custom controller names not based on model name for exclusive cases
+     * @example
+     *  'controllerModelMap' => [
+     *      'User' => 'Profile',  //use ProfileController for User model
+     *      'File' => 'Upload',   //use UploadController for File model
+     *  ]
+     **/
+    public $controllerModelMap = [];
+
+    /**
+     * @var bool Generate database models only for Schemas that not starts with underscore
+     */
+    public $skipUnderscoredSchemas = true;
+
+    /**
+     * @var bool Generate database models only for Schemas that have the `x-table` annotation.
+     */
+    public $generateModelsOnlyXTable = false;
+
+    /**
+     * @var bool whether to generate database migrations.
+     */
+    public $generateMigrations = true;
+
+    /**
+     * @var string path to create migration files in.
+     * Defaults to `@app/migrations`.
+     */
+    public $migrationPath = '@app/migrations';
+
+    /**
+     * @var string namespace to create migrations in.
+     * Defaults to `null` which means that migrations are generated without namespace.
+     */
+    public $migrationNamespace;
+
+    private $fileRenderer;
+
+    /**
+     * @var OpenApi
+     */
+    private $openApi;
+
+    /**
+     * @return \cebe\openapi\spec\OpenApi
+     * @throws \cebe\openapi\exceptions\IOException
+     * @throws \cebe\openapi\exceptions\TypeErrorException
+     * @throws \cebe\openapi\exceptions\UnresolvableReferenceException
+     */
+    public function getOpenApi():OpenApi
+    {
+        if ($this->openApi === null) {
+            $file = Yii::getAlias($this->openApiPath);
+            if (StringHelper::endsWith($this->openApiPath, '.json', false)) {
+                $this->openApi = Reader::readFromJsonFile($file, OpenApi::class, false);
+            } else {
+                $this->openApi = Reader::readFromYamlFile($file, OpenApi::class, false);
+            }
+        }
+        return $this->openApi;
+    }
+
+    public function getPathFromNamespace(string $namespace):string
+    {
+        return Yii::getAlias('@' . str_replace('\\', '/', ltrim($namespace, '\\')));
+    }
+
+    public function setFileRenderer(Closure $renderCallback):void
+    {
+        $this->fileRenderer = $renderCallback;
+    }
+
+    /**
+     * Generates code using the specified code template and parameters.
+     * Note that the code template will be used as a PHP file.
+     * @param string $template the code template file. This must be specified as a file path
+     * relative to [[templatePath]].
+     * @param array  $params list of parameters to be passed to the template file.
+     * @return string the generated code
+     * @throws \yii\base\InvalidConfigException
+     */
+    public function render(string $template, array $params = []):string
+    {
+        if (!$this->fileRenderer) {
+            throw new InvalidConfigException('Renderer is not configured');
+        }
+        return call_user_func($this->fileRenderer, $template, $params);
+    }
+}

src/lib/CustomSpecAttr.php

@@ -12,7 +12,7 @@ class CustomSpecAttr
     // --- For component schema ---
     //Custom table name
     public const TABLE = 'x-table';
-    //Primary key property name, if it different from "id" (Only one value, compound keys not supported yet)
+    //Primary key property name, if it is different from "id" (Only one value, compound keys not supported yet)
     public const PRIMARY_KEY = 'x-pk';
     //List of table indexes
     public const INDEXES = 'x-indexes';