feat(cli): add util shared functions and constants

marioestradarosa · marioestradarosa · commit 26915e5762f9 · 2018-09-18T19:55:33.000-06:00
diff --git a/docs/site/Repository-generator.md b/docs/site/Repository-generator.md
@@ -45,8 +45,8 @@ file.
 
 ### Notes
 
-Service oriented datasources such as REST or SOAP are not considered valid and
-thus not presented to you in the selection list.
+Service oriented datasources such as REST or SOAP are not considered valid in
+this context and will not be 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.
@@ -65,12 +65,12 @@ 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
   name of the model had been supplied from the command line with `--model`
-  option and it is a valid model, the the prompt is skipped, otherwise it will
+  option and it is a valid model, then the prompt is skipped, otherwise it will
   present the error `Error: No models found` in the console.
 
   If no `--model` is supplied, then the it will present you with a valid list of
diff --git a/packages/cli/generators/model/index.js b/packages/cli/generators/model/index.js
@@ -30,12 +30,12 @@ module.exports = class ModelGenerator extends ArtifactGenerator {
   _setupGenerator() {
     this.artifactInfo = {
       type: 'model',
-      rootDir: 'src',
+      rootDir: utils.sourceRootDir,
     };
 
     this.artifactInfo.outDir = path.resolve(
       this.artifactInfo.rootDir,
-      'models',
+      utils.modelsDir,
     );
 
     // Model Property Types
@@ -190,8 +190,7 @@ module.exports = class ModelGenerator extends ArtifactGenerator {
     debug('scaffolding');
 
     // Data for templates
-    this.artifactInfo.fileName = utils.kebabCase(this.artifactInfo.name);
-    this.artifactInfo.outFile = `${this.artifactInfo.fileName}.model.ts`;
+    this.artifactInfo.outFile = utils.getModelFileName(this.artifactInfo.name);
 
     // Resolved Output Path
     const tsPath = this.destinationPath(
diff --git a/packages/cli/generators/repository/index.js b/packages/cli/generators/repository/index.js
@@ -47,7 +47,7 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
     let fileContent = '';
     let modelFile = path.join(
       this.artifactInfo.modelDir,
-      `${utils.kebabCase(modelName)}.model.ts`,
+      utils.getModelFileName(modelName),
     );
     try {
       fileContent = this.fs.read(modelFile, {});
@@ -63,12 +63,12 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
    * helper method to inspect and validate a repository type
    */
   async _inferRepositoryType() {
-    if (!this.artifactInfo.dataSourceClassName) {
+    if (!this.artifactInfo.dataSourceClass) {
       return;
     }
     let result = this._isConnectorOfType(
       KEY_VALUE_CONNECTOR,
-      this.artifactInfo.dataSourceClassName,
+      this.artifactInfo.dataSourceClass,
     );
     debug(`KeyValue Connector: ${result}`);
 
@@ -81,17 +81,19 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
     }
 
     // assign the data source name to the information artifact
-    let dataSourceName = this.artifactInfo.dataSourceClassName
+    let dataSourceName = this.artifactInfo.dataSourceClass
       .replace('Datasource', '')
       .toLowerCase();
-    let dataSourceImportName = this.artifactInfo.dataSourceClassName.replace(
+
+    let dataSourceClassName = this.artifactInfo.dataSourceClass.replace(
       'Datasource',
       'DataSource',
     );
 
     Object.assign(this.artifactInfo, {
-      dataSourceImportName: dataSourceImportName,
+      dataSourceClassName: dataSourceClassName,
     });
+
     Object.assign(this.artifactInfo, {
       dataSourceName: dataSourceName,
     });
@@ -102,19 +104,17 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
    * connectorType supplied for the given connector name
    * @param {string} connectorType single or a comma separated string array
    */
-  _isConnectorOfType(connectorType, dataSourceClassName) {
+  _isConnectorOfType(connectorType, dataSourceClass) {
     debug(`calling isConnectorType ${connectorType}`);
     let jsonFileContent = '';
     let result = false;
 
-    if (!dataSourceClassName) {
+    if (!dataSourceClass) {
       return false;
     }
     let datasourceJSONFile = path.join(
       this.artifactInfo.datasourcesDir,
-      dataSourceClassName
-        .replace('Datasource', '.datasource.json')
-        .toLowerCase(),
+      dataSourceClass.replace('Datasource', '.datasource.json').toLowerCase(),
     );
 
     try {
@@ -141,20 +141,20 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
   _setupGenerator() {
     this.artifactInfo = {
       type: 'repository ',
-      rootDir: 'src',
+      rootDir: utils.sourceRootDir,
     };
 
     this.artifactInfo.outDir = path.resolve(
       this.artifactInfo.rootDir,
-      'repositories',
+      utils.repositoriesDir,
     );
     this.artifactInfo.datasourcesDir = path.resolve(
       this.artifactInfo.rootDir,
-      'datasources',
+      utils.datasourcesDir,
     );
     this.artifactInfo.modelDir = path.resolve(
       this.artifactInfo.rootDir,
-      'models',
+      utils.modelsDir,
     );
 
     this.artifactInfo.defaultTemplate = REPOSITORY_CRUD_TEMPLATE;
@@ -230,7 +230,11 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
         'datasource',
         true,
       );
-      debug(`datasourcesList from src/datasources : ${datasourcesList}`);
+      debug(
+        `datasourcesList from ${utils.sourceRootDir}/${
+          utils.datasourcesDir
+        } : ${datasourcesList}`,
+      );
     } catch (err) {
       return this.exit(err);
     }
@@ -244,17 +248,7 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
       return result;
     });
 
-    if (availableDatasources.includes(cmdDatasourceName)) {
-      Object.assign(this.artifactInfo, {
-        dataSourceClassName: cmdDatasourceName,
-      });
-    }
-
-    debug(
-      `artifactInfo.dataSourceClassName ${
-        this.artifactInfo.dataSourceClassName
-      }`,
-    );
+    debug(`artifactInfo.dataSourceClass ${this.artifactInfo.dataSourceClass}`);
 
     if (availableDatasources.length === 0) {
       return this.exit(
@@ -267,13 +261,19 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
       );
     }
 
+    if (availableDatasources.includes(cmdDatasourceName)) {
+      Object.assign(this.artifactInfo, {
+        dataSourceClass: cmdDatasourceName,
+      });
+    }
+
     return this.prompt([
       {
         type: 'list',
-        name: 'dataSourceClassName',
+        name: 'dataSourceClass',
         message: PROMPT_MESSAGE_DATA_SOURCE,
         choices: availableDatasources,
-        when: !this.artifactInfo.dataSourceClassName,
+        when: !this.artifactInfo.dataSourceClass,
         default: availableDatasources[0],
         validate: utils.validateClassName,
       },
@@ -310,7 +310,11 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
 
       this.options.model = utils.toClassName(this.options.model);
       // assign the model name from the command line only if it is valid
-      if (modelList.length > 0 && modelList.includes(this.options.model)) {
+      if (
+        modelList &&
+        modelList.length > 0 &&
+        modelList.includes(this.options.model)
+      ) {
         Object.assign(this.artifactInfo, {modelNameList: [this.options.model]});
       } else {
         modelList = [];
@@ -399,25 +403,31 @@ module.exports = class RepositoryGenerator extends ArtifactGenerator {
 
     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.getRepositoryFileName(
+        this.options.name,
+      );
 
       // 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';
+      this.artifactInfo.outFile = utils.getRepositoryFileName(
+        this.artifactInfo.modelName,
+      );
     }
 
     if (debug.enabled) {
       debug(`Artifact output filename set to: ${this.artifactInfo.outFile}`);
     }
 
     const source = this.templatePath(
-      path.join('src', 'repositories', this.artifactInfo.defaultTemplate),
+      path.join(
+        utils.sourceRootDir,
+        utils.repositoriesDir,
+        this.artifactInfo.defaultTemplate,
+      ),
     );
 
     if (debug.enabled) {
diff --git a/packages/cli/generators/repository/templates/src/repositories/repository-crud-default-template.ts.ejs b/packages/cli/generators/repository/templates/src/repositories/repository-crud-default-template.ts.ejs
@@ -1,13 +1,14 @@
 import {<%= repositoryTypeClass %>, juggler} from '@loopback/repository';
 import {<%= modelName %>} from '../models';
+import {<%= dataSourceClassName %>} from '../datasources';
 import {inject} from '@loopback/core';
 
 export class <%= className %>Repository extends <%= repositoryTypeClass %><
   <%= modelName %>,
   typeof <%= modelName %>.prototype.<%= idType %>
 > {
   constructor(
-    @inject('datasources.<%= dataSourceName %>') protected datasource: juggler.DataSource,
+    @inject('datasources.<%= dataSourceName %>') protected datasource: <%= dataSourceClassName %>,
   ) {
     super(<%= modelName %>, datasource);
   }
diff --git a/packages/cli/generators/repository/templates/src/repositories/repository-kv-template.ts.ejs b/packages/cli/generators/repository/templates/src/repositories/repository-kv-template.ts.ejs
@@ -1,13 +1,13 @@
 import {<%= repositoryTypeClass %>} from '@loopback/repository';
 import {<%= modelName %>} from '../models';
-import {<%= dataSourceImportName %>} from '../datasources';
+import {<%= dataSourceClassName %>} from '../datasources';
 import {inject} from '@loopback/core';
 
 export class <%= className %>Repository extends <%= repositoryTypeClass %><
   <%= modelName %>
  > {
   constructor(
-    @inject('datasources.<%= dataSourceName %>') datasource: <%= dataSourceImportName %>,
+    @inject('datasources.<%= dataSourceName %>') datasource: <%= dataSourceClassName %>,
   ) {
     super(<%= modelName %>,datasource);
   }
diff --git a/packages/cli/lib/utils.js b/packages/cli/lib/utils.js
@@ -370,3 +370,24 @@ function validateValue(name, unallowedCharacters) {
   }
   return true;
 }
+/**
+ *  Returns the modelName in the directory file format for the model
+ * @param {string} modelName
+ */
+exports.getModelFileName = function(modelName) {
+  return `${_.kebabCase(modelName)}.model.ts`;
+};
+
+/**
+ * Returns the repositoryName in the directory file format for the repository
+ * @param {string} repositoryName
+ */
+exports.getRepositoryFileName = function(repositoryName) {
+  return `${_.kebabCase(repositoryName)}.repository.ts`;
+};
+
+// literal strings with artifacts directory locations
+exports.repositoriesDir = 'repositories';
+exports.datasourcesDir = 'datasources';
+exports.modelsDir = 'models';
+exports.sourceRootDir = 'src';
diff --git a/packages/cli/test/integration/generators/repository.integration.js b/packages/cli/test/integration/generators/repository.integration.js
@@ -30,7 +30,7 @@ describe('lb4 repository', () => {
   describe('generate repositories on special conditions', () => {
     it('generates a multi-word crud repository', async () => {
       const multiItemPrompt = {
-        dataSourceClassName: 'DbmemDatasource',
+        dataSourceClass: 'DbmemDatasource',
         modelNameList: ['MultiWord'],
       };
 
@@ -116,7 +116,7 @@ describe('lb4 repository', () => {
 
     it('generates a repository asking for the ID name', async () => {
       const multiItemPrompt = {
-        dataSourceClassName: 'DbmemDatasource',
+        dataSourceClass: 'DbmemDatasource',
         modelNameList: ['InvalidId'],
         propertyName: 'myid',
       };
@@ -152,7 +152,7 @@ describe('lb4 repository', () => {
   describe('all invalid parameters and usage', () => {
     it('does not run with an invalid model name', async () => {
       const basicPrompt = {
-        dataSourceClassName: 'DbmemDatasource',
+        dataSourceClass: 'DbmemDatasource',
       };
       return expect(
         testUtils
@@ -168,7 +168,7 @@ describe('lb4 repository', () => {
 
     it("does not run when user doesn't select a model", async () => {
       const basicPrompt = {
-        dataSourceClassName: 'DbmemDatasource',
+        dataSourceClass: 'DbmemDatasource',
       };
       return expect(
         testUtils
@@ -197,7 +197,7 @@ describe('lb4 repository', () => {
   describe('valid generation of crud repositories', () => {
     it('generates a crud repository from default model', async () => {
       const basicPrompt = {
-        dataSourceClassName: 'DbmemDatasource',
+        dataSourceClass: 'DbmemDatasource',
       };
       await testUtils
         .executeGenerator(generator)
@@ -283,7 +283,7 @@ describe('lb4 repository', () => {
 
     it('generates a kv repository from decorator defined model', async () => {
       const basicPrompt = {
-        dataSourceClassName: 'DbkvDatasource',
+        dataSourceClass: 'DbkvDatasource',
       };
       await testUtils
         .executeGenerator(generator)
