fix(cli): rework template to use inline param decoration

Author: Kevin Delisle

packages/cli/generators/controller/templates/src/controllers/controller-rest-template.ts

@@ -7,54 +7,51 @@ import {<%= repositoryName %>} from '../repositories';
 export class <%= name %>Controller {
 
   constructor(
-    @inject('repositories.<%= modelNameCamel %>')
+    @inject('repositories.<%= repositoryName %>')
     public <%= repositoryNameCamel %> : <%= repositoryName %>,
   ) {}
 
   @post('/<%= modelNameCamel %>')
-  @param.body('obj', <%= modelName %>)
-  async create(obj: <%= modelName %>) : Promise<<%= modelName %>> {
+  async create(@param.body('obj') obj: <%= modelName %>)
+    : Promise<<%= modelName %>> {
     return await this.<%= repositoryNameCamel %>.create(obj);
   }
 
   @get('/<%= modelNameCamel %>/count')
-  @param.query.string('where')
-  async count(where: Where) : Promise<number> {
+  async count(@param.query.string('where') where: Where) : Promise<number> {
     return await this.<%= repositoryNameCamel %>.count(where);
   }
 
   @get('/<%= modelNameCamel %>')
-  @param.query.string('filter')
-  async find(filter: Filter) : Promise<<%= modelName %>[]> {
-    return await this.<%= repositoryNameCamel %>.find(filter);
+  async find(@param.query.string('filter') filter: Filter)
+    : Promise<<%= modelName %>[]> {
+      return await this.<%= repositoryNameCamel %>.find(filter);
   }
 
   @patch('/<%= modelNameCamel %>')
-  @param.query.string('where')
-  @param.body('obj', <%= modelName %>)
-  async updateAll(where: Where, obj: <%= modelName %>) : Promise<number> {
-    return await this.<%= repositoryNameCamel %>.updateAll(where, obj);
+  async updateAll(@param.query.string('where') where: Where,
+    @param.body('obj') obj: <%= modelName %>) : Promise<number> {
+      return await this.<%= repositoryNameCamel %>.updateAll(where, obj);
   }
 
   @del('/<%= modelNameCamel %>')
-  @param.query.string('where')
-  async deleteAll(where: Where) : Promise<number> {
+  async deleteAll(@param.query.string('where') where: Where) : Promise<number> {
     return await this.<%= repositoryNameCamel %>.deleteAll(where);
   }
 
   @get('/<%= modelNameCamel %>/{id}')
-  async findById(id: <%= idType %>) : Promise<<%= modelName %>> {
+  async findById(@param.path.number('id') id: <%= idType %>) : Promise<<%= modelName %>> {
     return await this.<%= repositoryNameCamel %>.findById(id);
   }
 
   @patch('/<%= modelNameCamel %>/{id}')
-  @param.body('obj', <%= modelName %>)
-  async updateById(id: <%= idType %>, obj: <%= modelName %>) : Promise<boolean> {
+  async updateById(@param.path.number('id') id: <%= idType %>, @param.body('obj')
+   obj: <%= modelName %>) : Promise<boolean> {
     return await this.<%= repositoryNameCamel %>.updateById(id, obj);
   }
 
   @del('/<%= modelNameCamel %>/{id}')
-  async deleteById(id: <%= idType %>) : Promise<boolean> {
+  async deleteById(@param.path.number('id') id: <%= idType %>) : Promise<boolean> {
     return await this.<%= repositoryNameCamel %>.deleteById(id);
   }
 }

packages/cli/test/controller.js

@@ -270,104 +270,60 @@ describe('lb4 controller', () => {
 
   /**
    * Assertions against the template to determine if it contains the
-   * required signatures for a CRUD controller.
-   * @param {String} tmpDir The temporary directory path to check. Uses
-   * withInputName to determine the file name.
+   * required signatures for a REST CRUD controller, specifically to ensure
+   * that decorators are grouped correctly (for their corresponding
+   * target functions)
+   *
+   * This function calls checkCrudContents.
+   * @param {String} tmpDir
    */
-  function checkCrudContents(tmpDir) {
+  function checkRestCrudContents(tmpDir) {
     assert.fileContent(tmpDir + withInputName, /class FooBarController/);
 
     // Repository and injection
     assert.fileContent(
       tmpDir + withInputName,
-      /\@inject\('repositories.foo'\)/
+      /\@inject\('repositories.BarRepository'\)/
     );
     assert.fileContent(
       tmpDir + withInputName,
       /barRepository \: BarRepository/
     );
-    // Check function signatures
-    assert.fileContent(
-      tmpDir + withInputName,
-      /async create\(obj\: Foo\) \: Promise\<Foo\>/
-    );
-    assert.fileContent(
-      tmpDir + withInputName,
-      /async count\(where\: Where\) \: Promise\<number\>/
-    );
-    assert.fileContent(
-      tmpDir + withInputName,
-      /async find\(filter\: Filter\) \: Promise\<Foo\[\]\>/
-    );
-    assert.fileContent(
-      tmpDir + withInputName,
-      /async updateAll\(where\: Where, obj\: Foo\) \: Promise\<number\>/
-    );
-    assert.fileContent(
-      tmpDir + withInputName,
-      /async deleteAll\(where\: Where\) \: Promise\<number\>/
-    );
-    assert.fileContent(
-      tmpDir + withInputName,
-      /async findById\(id\: number\) \: Promise\<Foo\>/
-    );
-    assert.fileContent(
-      tmpDir + withInputName,
-      /async updateById\(id\: number, obj\: Foo\) \: Promise\<boolean\>/
-    );
-    assert.fileContent(
-      tmpDir + withInputName,
-      /async deleteById\(id\: number\) \: Promise\<boolean\>/,
-      ''
-    );
-  }
-
-  /**
-   * Assertions against the template to determine if it contains the
-   * required signatures for a REST CRUD controller, specifically to ensure
-   * that decorators are grouped correctly (for their corresponding
-   * target functions)
-   *
-   * This function calls checkCrudContents.
-   * @param {String} tmpDir
-   */
-  function checkRestCrudContents(tmpDir) {
-    checkCrudContents(tmpDir);
 
     // Assert that the decorators are present in the correct groupings!
     assert.fileContent(
       tmpDir + withInputName,
-      /\@post\('\/foo'\)\s{1,}\@param.body\('obj', Foo\)\s{1,}async create/
+      /\@post\('\/foo'\)\s{1,}async create\(\@param.body\('obj'\)/
     );
 
     assert.fileContent(
       tmpDir + withInputName,
-      /\@get\('\/foo\/count'\)\s{1,}\@param.query.string\('where'\)\s{1,}async count/
+      /\@get\('\/foo\/count'\)\s{1,}async count\(\@param.query.string\('where'\)/
     );
 
     assert.fileContent(
       tmpDir + withInputName,
-      /\@get\('\/foo'\)\s{1,}\@param.query.string\('filter'\)\s{1,}async find/
+      /\@get\('\/foo'\)\s{1,}async find\(\@param.query.string\('filter'\)/
     );
     assert.fileContent(
       tmpDir + withInputName,
-      /\@patch\('\/foo'\)\s{1,}\@param.query.string\('where'\)\s{1,}\@param.body\('obj', Foo\)\s{1,}async updateAll/
+      /\@patch\('\/foo'\)\s{1,}async updateAll\(\@param.query.string\('where'\) where: Where,\s{1,}\@param.body\('obj'\)/
     );
     assert.fileContent(
       tmpDir + withInputName,
-      /\@del\('\/foo'\)\s{1,}\@param.query.string\('where'\)\s{1,}async deleteAll/
+      /\@del\('\/foo'\)\s{1,}async deleteAll\(\@param.query.string\('where'\)/
     );
     assert.fileContent(
       tmpDir + withInputName,
-      /\@get\('\/foo\/{id}'\)\s{1,}async findById/
+      /\@get\('\/foo\/{id}'\)\s{1,}async findById\(\@param.path.number\('id'\)/
     );
     assert.fileContent(
       tmpDir + withInputName,
-      /\@patch\('\/foo\/{id}'\)\s{1,}\@param.body\('obj', Foo\)\s{1,}async updateById/
+      /\@patch\('\/foo\/{id}'\)\s{1,}async updateById\(\@param.path.number\('id'\) id: number, \@param.body\('obj'\)/
     );
     assert.fileContent(
       tmpDir + withInputName,
-      /\@del\('\/foo\/{id}'\)\s{1,}async deleteById/
+      /\@del\('\/foo\/{id}'\)\s{1,}async deleteById\(\@param.path.number\('id'\) id: number\)/
     );
   }
 });