patch php generator

1. Supported emit test files.
2. Optimizing the `ResolveImports` method.
3. Optimizing test case.
4. Optimizing emit @throw comment.

Author: wb-hx510875

src/generator.js

@@ -116,6 +116,8 @@ class Generator {
     let thirdPackageClient = {};
     let thirdPackageClientAlias = {};
 
+    const selfClientName = this.config.clientName ? this.config.clientName : this.config.client.name;
+
     if (imports.length > 0) {
       const lockPath = path.join(this.config.pkgDir, '.libraries.json');
       const lock = JSON.parse(fs.readFileSync(lockPath, 'utf8'));
@@ -163,7 +165,7 @@ class Generator {
         // resolve third package model client name
         if (
           clientNameSet.indexOf(clientName.toLowerCase()) > -1 ||
-          clientName.toLowerCase() === this.config.clientName.toLowerCase()
+          clientName.toLowerCase() === selfClientName.toLowerCase()
         ) {
           const alias = packageName.split('.').join('') + '->' + clientName.split('.').join('');
           thirdPackageClientAlias[aliasId] = alias;

src/langs/common/items.js

@@ -378,6 +378,7 @@ class ConstructItem extends Item {
     this.params = params;
     this.body = body;
     this.annotations = annotations;
+    this.throws = [];
   }
 
   addParamNode(node) {
@@ -399,7 +400,7 @@ class ConstructItem extends Item {
 class ObjectItem extends Item {
   constructor(type) {
     super();
-    assert.equal(true, type === 'client' || type === 'model');
+    assert.equal(true, type === 'client' || type === 'model' || type === 'test');
     this.type = type;            // client | model
     this.modify = [];            // Modify
     this.name = '';              // object name

src/langs/php/combinator.js

@@ -8,12 +8,13 @@ const PackageInfo = require('./package_info');
 
 const {
   Symbol,
-  Exceptions
+  Modify
 } = require('../common/enum');
 
 const {
   AnnotationItem,
   ConstructItem,
+  ObjectItem,
   FuncItem,
   PropItem,
 
@@ -163,7 +164,6 @@ class Combinator extends CombinatorBase {
 
   combine(objectArr = []) {
     if (this.config.packageInfo) {
-      this.config.dir = this.config.outputDir + '/src/';
       const packageInfo = new PackageInfo(this.config);
       packageInfo.emit(this.config.packageInfo, this.requirePackage);
     }
@@ -183,9 +183,30 @@ class Combinator extends CombinatorBase {
         }
       });
     }
+
+    if (this.config.withTest) {
+      const object = new ObjectItem('test');
+      object.name = `Tests.${clientObjectItem.name}Test`;
+      object.extends = ['TestCase'];
+      object.includeList = [{ import: 'PHPUnit\\Framework\\TestCase', alias: null }];
+      clientObjectItem.body.forEach(node => {
+        if (node instanceof FuncItem) {
+          const func = new FuncItem();
+          func.name = `test${_upperFirst(node.name)}`;
+          func.modify.push(Modify.public());
+          object.addBodyNode(func);
+        }
+      });
+      const outputParts = this.combineOject(object, false);
+      const config = _deepClone(this.config);
+      config.filename = `${clientObjectItem.name}Test`;
+      config.dir = `${config.dir}/tests/`;
+      config.layer = '';
+      this.combineOutputParts(config, outputParts);
+    }
   }
 
-  combineOject(object) {
+  combineOject(object, output = true) {
     let layer = '';
     if (object.type === 'model') {
       layer = this.config.model.dir;
@@ -202,7 +223,7 @@ class Combinator extends CombinatorBase {
       let tmp = object.name.split('.');
       object.name = tmp[tmp.length - 1];
       tmp.splice(tmp.length - 1, 1);
-      layer = layer + '.' + tmp.join('.');
+      layer = layer ? layer + '.' + tmp.join('.') : tmp.join('.');
     }
     this.emitClass(emitter, object);
     outputParts.body = emitter.output;
@@ -225,12 +246,18 @@ class Combinator extends CombinatorBase {
     outputParts.head = emitter.output;
 
     /***************************** combine output ******************************/
-    const config = _deepClone(this.config);
-    config.filename = object.name;
-    config.layer = layer.split('.').map(m => {
-      return _avoidKeywords(m);
-    }).join('.');
-    this.combineOutputParts(config, outputParts);
+    if (output) {
+      const config = _deepClone(this.config);
+      config.filename = object.name;
+      config.layer = layer.split('.').map(m => {
+        return _avoidKeywords(m);
+      }).join('.');
+      if (config.packageInfo) {
+        config.dir = config.outputDir + '/src/';
+      }
+      this.combineOutputParts(config, outputParts);
+    }
+    return outputParts;
   }
 
   emitClass(emitter, object) {
@@ -596,8 +623,11 @@ class Combinator extends CombinatorBase {
         const desc = returnDesc ? ' ' + returnDesc : '';
         emitter.emitln(` * @return ${t}${desc}`, this.level);
       }
-
-      emitter.emitln(' * @throws ' + _exception(_exception(Exceptions.base())), this.level);
+      if (func.throws.length) {
+        func.throws.forEach(exception => { 
+          emitter.emitln(' * @throws ' + _exception(_exception(exception)), this.level);
+        });
+      }
     }
     emitter.emitln(' */', this.level);
   }

src/langs/php/files/bootstrap.php.tmpl

@@ -0,0 +1,3 @@
+<?php
+
+require dirname(__DIR__) . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';

src/langs/php/package_info.js

@@ -4,6 +4,8 @@ const path = require('path');
 const fs = require('fs');
 const BasePackageInfo = require('../common/package_info');
 
+const { _deepClone } = require('../../lib/helper');
+
 const OPTION_LOCAL = 1;   // use local tmpl file to render content
 const OPTION_SOURCE = 2;  // config by Darafile.{lang}.packageInfo
 const OPTION_RENDER = 4;  // render content from tmpl
@@ -22,22 +24,32 @@ const files = {
 
 class PackageInfo extends BasePackageInfo {
   emit(packageInfo, requirePackage) {
-    let outputDir = this.resolveOutputDir(packageInfo);
+    const config = _deepClone(this.config);
+    let outputDir = this.resolveOutputDir(packageInfo, '');
     this.checkParams(packageInfo, ['name', 'desc', 'github']);
     const params = {
       name: packageInfo.name,
       desc: packageInfo.desc,
       github: packageInfo.github,
-      namespace: this.config.package.split('.').join('\\\\')
+      namespace: config.package.split('.').join('\\\\')
     };
+    if (config.withTest) {
+      if (!fs.existsSync(path.join(config.dir, 'tests'))) {
+        fs.mkdirSync(path.join(config.dir, 'tests'), { recursive: true });
+      }
+      fs.writeFileSync(
+        path.join(config.dir, 'tests', 'bootstrap.php'),
+        fs.readFileSync(path.join(__dirname, './files/bootstrap.php.tmpl'), 'utf-8')
+      );
+    }
     Object.keys(files).forEach(filename => {
       let content = '';
       let optional = files[filename];
       if (optional & OPTION_UPDATE && fs.existsSync(path.join(outputDir, filename))) {
         content = fs.readFileSync(path.join(outputDir, filename), 'utf-8');
       } else if (optional & OPTION_SOURCE && packageInfo.files && packageInfo.files[filename]) {
         let filepath = path.isAbsolute(packageInfo.files[filename]) ?
-          packageInfo.files[filename] : path.join(this.config.pkgDir, packageInfo.files[filename]);
+          packageInfo.files[filename] : path.join(config.pkgDir, packageInfo.files[filename]);
         if (!fs.existsSync(filepath)) {
           return;
         }
@@ -58,9 +70,9 @@ class PackageInfo extends BasePackageInfo {
               json.require[p] = v;
             });
           }
-          if (this.config.maintainers) {
+          if (config.maintainers) {
             json.authors = [];
-            this.config.maintainers.forEach(maintainer => {
+            config.maintainers.forEach(maintainer => {
               let name = maintainer.name ? maintainer.name : '';
               let email = maintainer.email ? maintainer.email : '';
               json.authors.push({ name: name, email: email });

src/resolver/base.js

@@ -2,22 +2,10 @@
 
 const debug = require('../lib/debug');
 
-const {
-  _isBasicType
-} = require('../lib/helper');
-
 const {
   AnnotationItem,
-  PropItem,
 } = require('../langs/common/items');
 
-const {
-  //   Symbol,
-  Modify,
-  //   Exceptions,
-  //   Types
-} = require('../langs/common/enum');
-
 const DSL = require('@darabonba/parser');
 
 class BaseResolver {
@@ -130,47 +118,6 @@ class BaseResolver {
       this.object.annotations.push(this.resolveAnnotation(annotation, this.object.index));
     }
   }
-
-  resolveProps(ast) {
-    this.comments = ast.comments;
-
-    ast.moduleBody.nodes.filter((item) => {
-      return item.type === 'type';
-    }).forEach(item => {
-      const prop = new PropItem();
-      prop.name = item.vid.lexeme.replace('@', '_');
-      const type = item.value.lexeme ? item.value.lexeme : item.value.type;
-      prop.type = type;
-      if (type === 'array') {
-        prop.itemType = item.value.subType;
-        if (!_isBasicType(item.value.subType.lexeme)) {
-          this.combinator.addModelInclude(item.value.subType.lexeme);
-        }
-      } else {
-        if (!_isBasicType(type)) {
-          if (item.value.idType && item.value.idType === 'module') {
-            this.combinator.addInclude(type);
-          } else if (item.value && item.value.returnType) {
-            if (!_isBasicType(item.value.returnType.lexeme)) {
-              this.combinator.addModelInclude(type);
-            }
-          } else {
-            debug.stack(item);
-          }
-        }
-      }
-      prop.addModify(Modify.protected());
-      if (item.tokenRange) {
-        let comments = this.getFrontComments(item.tokenRange[0]);
-        if (comments.length > 0) {
-          comments.forEach(c => {
-            this.object.addBodyNode(this.resolveAnnotation(c, this.object.index));
-          });
-        }
-      }
-      this.object.addBodyNode(prop);
-    });
-  }
 }
 
 module.exports = BaseResolver;

src/resolver/client.js

@@ -4,10 +4,11 @@ const debug = require('../lib/debug');
 const BaseResolver = require('./base');
 
 const {
-  ObjectItem,
   AnnotationItem,
   ConstructItem,
+  ObjectItem,
   FuncItem,
+  PropItem,
 
   GrammerVar,
   GrammerCall,
@@ -51,6 +52,7 @@ class ClientResolver extends BaseResolver {
   constructor(astNode, combinator, globalAst) {
     super(astNode, combinator, globalAst);
     this.object = new ObjectItem('client');
+    this.currThrows = {};
   }
 
   resolve() {
@@ -117,11 +119,53 @@ class ClientResolver extends BaseResolver {
     return object;
   }
 
+  resolveProps(ast) {
+    this.comments = ast.comments;
+
+    ast.moduleBody.nodes.filter((item) => {
+      return item.type === 'type';
+    }).forEach(item => {
+      const prop = new PropItem();
+      prop.name = item.vid.lexeme.replace('@', '_');
+      const type = item.value.lexeme ? item.value.lexeme : item.value.type;
+      prop.type = type;
+      if (type === 'array') {
+        prop.itemType = item.value.subType;
+        if (!_isBasicType(item.value.subType.lexeme)) {
+          this.combinator.addModelInclude(item.value.subType.lexeme);
+        }
+      } else {
+        if (!_isBasicType(type)) {
+          if (item.value.idType && item.value.idType === 'module') {
+            this.combinator.addInclude(type);
+          } else if (item.value && item.value.returnType) {
+            if (!_isBasicType(item.value.returnType.lexeme)) {
+              this.combinator.addModelInclude(type);
+            }
+          } else {
+            debug.stack(item);
+          }
+        }
+      }
+      prop.addModify(Modify.protected());
+      if (item.tokenRange) {
+        let comments = this.getFrontComments(item.tokenRange[0]);
+        if (comments.length > 0) {
+          comments.forEach(c => {
+            this.object.addBodyNode(this.resolveAnnotation(c, this.object.index));
+          });
+        }
+      }
+      this.object.addBodyNode(prop);
+    });
+  }
+
   resolveInitBody(init) {
     const object = this.object;
     const combinator = this.combinator;
 
     let constructNode = new ConstructItem();
+    this.currThrows = {};
     if (init.params && init.params.params) {
       init.params.params.forEach(param => {
         if (param.paramType.idType && param.paramType.idType === 'model') {
@@ -140,10 +184,14 @@ class ClientResolver extends BaseResolver {
         this.visitStmt(constructNode, stmt, constructNode.index);
       });
     }
+    if (Object.keys(this.currThrows).length > 0) {
+      constructNode.throws = Object.values(this.currThrows);
+    }
     object.addBodyNode(constructNode);
   }
 
   resolveFunc(func, ast, body) {
+    this.currThrows = {};
     if (ast.annotation) {
       func.addAnnotation(this.resolveAnnotation(ast.annotation, func.index));
     }
@@ -248,6 +296,9 @@ class ClientResolver extends BaseResolver {
       this.findComments(func, body, 'between');
     }
 
+    if (Object.keys(this.currThrows).length > 0) {
+      func.throws = Object.values(this.currThrows);
+    }
     this.object.addBodyNode(func);
   }
 
@@ -384,6 +435,7 @@ class ClientResolver extends BaseResolver {
       ]),
       new GrammerThrows(null, [exceptionParam])
     ], catchException);
+    this.currThrows[Exceptions.base()] = Exceptions.base();
     this.requestBody(ast, body, requestTryCatch);
     requestTryCatch.addCatch(tryCatch);
 
@@ -399,6 +451,7 @@ class ClientResolver extends BaseResolver {
         ]
       )
     );
+    this.currThrows['$ExceptionUnretryable'] = this.combinator.addInclude('$ExceptionUnretryable');
   }
 
   requestBody(ast, body, func) {
@@ -789,6 +842,7 @@ class ClientResolver extends BaseResolver {
         node.expr = new BehaviorToModel(node.expr, stmt.expectedType.name);
       }
     } else if (stmt.type === 'throw') {
+      this.currThrows['$Exception'] = this.combinator.addInclude('$Exception');
       node = new GrammerThrows(this.combinator.addInclude('$Exception'));
       if (Array.isArray(stmt.expr)) {
         stmt.expr.forEach(e => {