feat(cli): implements name for repository and change documentation

marioestradarosa · marioestradarosa · commit e9651e130fbf · 2018-09-15T01:04:04.000-06:00
diff --git a/docs/site/Repository-generator.md b/docs/site/Repository-generator.md
@@ -13,29 +13,20 @@ permalink: /doc/en/lb4/Repository-generator.html
 Adds a new [Repository or Multiple Repositories](Repositories.md) class to a
 LoopBack application with one single command.
 
-### Notes
-
-The optional argument `[<name>]`, referes to a valid datasource already created
-in `src/datasources` directory and should match the name property inside any of
-the `.json` files.
-
-Service oriented datasources such as REST or SOAP are not considered valid and
-thus not presented to you in the selection list.
-
-There should be at least one valid _(KeyValue or Persisted)_ data source and one
-model already created in their respective directories.
-
 ```sh
 lb4 repository [options] [<name>]
 ```
 
 ### Options
 
+`--datasource` : _(Optional)_ name of a valid datasource already created in
+src/datasources
+
 `--model` : _(Optional)_ name of a valid model already created in src/models
 
 `--id` : _(Optional)_ name of the property serving as **ID** in the selected
-model. Keep in mind that CLI will still check and try to infer a valid ID from
-the model file and give it priority over the one supplied here.
+model. If you supply this value, the CLI will not try to infer this value from
+the selected model file.
 
 ### Configuration file
 
@@ -45,27 +36,36 @@ file.
 
 ```ts
 {
-  "name": "validDataSourceName",
+  "name": "repositoryNameToBeGenerated",
+  "datasource": "validDataSourceName",
   "model": "validDModelName",
   "id": "anOptionalNameForID"
 }
 ```
 
+### Notes
+
+Service oriented datasources such as REST or SOAP are not considered valid and
+thus not presented to you in the selection list.
+
+There should be at least one valid _(KeyValue or Persisted)_ data source and one
+model already created in their respective directories.
+
 {% include_relative includes/CLI-std-options.md %}
 
 ### Arguments
 
-`<name>` - Optional argument specifyng a valid datasource name. The value should
-match the name property of a valid datasource in any of the `src/datasources`
-json files.
+`<name>` - Optional argument specifyng the respository name to be generated. In
+case you select multiple models, the first model will take this argument for its
+repository file name.
 
 ### Interactive Prompts
 
 The tool will prompt you for:
 
 - **Please select the datasource.** _(name)_ If the name of the datasource had
   been supplied from the command line, the prompt is skipped, otherwise it will
-  present you, the list of available datasources to select one. IT will use this
+  present you, the list of available datasources to select one. It will use this
   datasource to check what kind of repository it will generate.
 
 - **Select the model(s) you want to generate a repository.** _(model)_ If the
diff --git a/packages/cli/generators/repository/index.js b/packages/cli/generators/repository/index.js
@@ -31,7 +31,7 @@ const ERROR_READING_FILE = 'Error reading file';
 const ERROR_NO_DATA_SOURCES_FOUND = 'No datasources found in';
 const ERROR_NO_MODELS_FOUND = 'No models found in';
 const ERROR_NO_MODEL_SELECTED = 'You did not select a valid model';
-const ERROR_NO_DIRECTORY = "couldn't find the directory";
+const ERROR_NO_DIRECTORY = 'The directory was not found';
 
 module.exports = class RepositoryGenerator extends ArtifactGenerator {
   // Note: arguments and options should be defined in the constructor.
@@ -140,7 +140,7 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
 
   _setupGenerator() {
     this.artifactInfo = {
-      type: 'datasource to use ',
+      type: 'repository ',
       rootDir: 'src',
     };
 
@@ -171,6 +171,12 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
       description: 'A valid ID property name for the specified model',
     });
 
+    this.option('datasource', {
+      type: String,
+      required: false,
+      description: 'A valid datasource name',
+    });
+
     return super._setupGenerator();
   }
 
@@ -212,8 +218,8 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
     let datasourcesList;
 
     // grab the datasourcename from the command line
-    cmdDatasourceName = this.options.name
-      ? utils.toClassName(this.options.name) + 'Datasource'
+    cmdDatasourceName = this.options.datasource
+      ? utils.toClassName(this.options.datasource) + 'Datasource'
       : '';
 
     debug(`command line datasource is  ${cmdDatasourceName}`);
@@ -344,6 +350,7 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
 
   async promptModelId() {
     if (this.shouldExit()) return false;
+    let idType;
 
     debug(`Model ID property name from command line: ${this.options.id}`);
     debug(`Selected Models: ${this.artifactInfo.modelNameList}`);
@@ -364,26 +371,22 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
           },
         ];
 
-        let idType = await this._getModelIdType(item);
-
-        /**
-         *  fallback by asking the user for ID property name if the user
-         *  didn't supplied any from the command line. If we inferred it, then
-         *  the supplied argument is ignored
-         */
-        if (idType === null) {
-          if (this.options.id) {
-            idType = this.options.id;
-            /**  make sure it is only used once, in case user selected more
-             * than one model.
-             */
-            delete this.options.id;
-          } else {
+        // user supplied the id from the command line
+        if (this.options.id) {
+          debug(`passing thru this.options.id with value : ${this.options.id}`);
+
+          idType = this.options.id;
+          /**  make sure it is only used once, in case user selected more
+           * than one model.
+           */
+          delete this.options.id;
+        } else {
+          idType = await this._getModelIdType(item);
+          if (idType === null) {
             const answer = await this.prompt(prompts);
             idType = answer.propertyName;
           }
         }
-
         this.artifactInfo.idType = idType;
         // Generate this repository
         await this._scaffold();
@@ -394,12 +397,20 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
   async _scaffold() {
     if (this.shouldExit()) return false;
 
-    this.artifactInfo.className = utils.toClassName(
-      this.artifactInfo.modelName,
-    );
+    if (this.options.name) {
+      this.artifactInfo.className = utils.toClassName(this.options.name);
+      this.artifactInfo.outFile =
+        utils.kebabCase(this.options.name) + '.repository.ts';
 
-    this.artifactInfo.outFile =
-      utils.kebabCase(this.artifactInfo.modelName) + '.repository.ts';
+      // make sure the name supplied from cmd line is only used once
+      delete this.options.name;
+    } else {
+      this.artifactInfo.className = utils.toClassName(
+        this.artifactInfo.modelName,
+      );
+      this.artifactInfo.outFile =
+        utils.kebabCase(this.artifactInfo.modelName) + '.repository.ts';
+    }
 
     if (debug.enabled) {
       debug(`Artifact output filename set to: ${this.artifactInfo.outFile}`);
diff --git a/packages/cli/test/integration/generators/repository.integration.js b/packages/cli/test/integration/generators/repository.integration.js
@@ -61,6 +61,30 @@ describe('lb4 repository', () => {
       );
     });
 
+    it('generates a custom name repository', async () => {
+      await testUtils
+        .executeGenerator(generator)
+        .inDir(
+          SANDBOX_PATH,
+          async () => await prepareGeneratorForRepository(SANDBOX_PATH),
+        )
+        .withArguments('myrepo --datasource dbmem --model MultiWord');
+      const expectedFile = path.join(
+        SANDBOX_PATH,
+        REPOSITORY_APP_PATH,
+        'myrepo.repository.ts',
+      );
+
+      assert.file(expectedFile);
+      assert.fileContent(
+        expectedFile,
+        /export class MyrepoRepository extends DefaultCrudRepository</,
+      );
+      assert.fileContent(expectedFile, /typeof MultiWord.prototype.pk/);
+      assert.file(INDEX_FILE);
+      assert.fileContent(INDEX_FILE, /export \* from '.\/myrepo.repository';/);
+    });
+
     it('generates a crud repository from a config file', async () => {
       await testUtils
         .executeGenerator(generator)
@@ -208,7 +232,7 @@ describe('lb4 repository', () => {
           SANDBOX_PATH,
           async () => await prepareGeneratorForRepository(SANDBOX_PATH),
         )
-        .withArguments('dbmem --model decoratordefined');
+        .withArguments('--datasource dbmem --model decoratordefined');
       const expectedFile = path.join(
         SANDBOX_PATH,
         REPOSITORY_APP_PATH,
@@ -239,7 +263,7 @@ describe('lb4 repository', () => {
           SANDBOX_PATH,
           async () => await prepareGeneratorForRepository(SANDBOX_PATH),
         )
-        .withArguments('dbkv --model Defaultmodel');
+        .withArguments('--datasource dbkv --model Defaultmodel');
       const expectedFile = path.join(
         SANDBOX_PATH,
         REPOSITORY_APP_PATH,
@@ -302,7 +326,7 @@ const SANDBOX_FILES = [
     path: CONFIG_PATH,
     file: 'myconfig.json',
     content: `{
-      "name": "dbmem",
+      "datasource": "dbmem",
       "model": "decoratordefined"
     }`,
   },
