Update code style to match codacy check

darthtrevino · darthtrevino · commit a0ce1480b620 · 2017-02-19T11:41:56.000-08:00
diff --git a/index.js b/index.js
@@ -1,80 +1,80 @@
-'use strict';
-const _ = require('lodash');
-const BbPromise = require('bluebird');
-const AWS = require('aws-sdk');
-const dynamodbLocal = require('dynamodb-localhost');
-const { writeSeeds, locateSeeds } = require('./src/seeder');
+"use strict";
+const _ = require("lodash");
+const BbPromise = require("bluebird");
+const AWS = require("aws-sdk");
+const dynamodbLocal = require("dynamodb-localhost");
+const { writeSeeds, locateSeeds } = require("./src/seeder");
 
 class ServerlessDynamodbLocal {
     constructor(serverless, options) {
         this.serverless = serverless;
         this.service = serverless.service;
         this.options = options;
-        this.provider = 'aws';
+        this.provider = "aws";
         this.commands = {
             dynamodb: {
                 commands: {
                     migrate: {
-                        lifecycleEvents: ['migrateHandler'],
-                        usage: 'Creates local DynamoDB tables from the current Serverless configuration'
+                        lifecycleEvents: ["migrateHandler"],
+                        usage: "Creates local DynamoDB tables from the current Serverless configuration"
                     },
                     seed: {
-                        lifecycleEvents: ['seedHandler'],
-                        usage: 'Seeds local DynamoDB tables with data'
+                        lifecycleEvents: ["seedHandler"],
+                        usage: "Seeds local DynamoDB tables with data"
                     },
                     start: {
-                        lifecycleEvents: ['startHandler'],
-                        usage: 'Starts local DynamoDB',
+                        lifecycleEvents: ["startHandler"],
+                        usage: "Starts local DynamoDB",
                         options: {
                             port: {
-                                shortcut: 'p',
-                                usage: 'The port number that DynamoDB will use to communicate with your application. If you do not specify this option, the default port is 8000'
+                                shortcut: "p",
+                                usage: "The port number that DynamoDB will use to communicate with your application. If you do not specify this option, the default port is 8000"
                             },
                             cors: {
-                                shortcut: 'c',
-                                usage: 'Enable CORS support (cross-origin resource sharing) for JavaScript. You must provide a comma-separated "allow" list of specific domains. The default setting for -cors is an asterisk (*), which allows public access.'
+                                shortcut: "c",
+                                usage: "Enable CORS support (cross-origin resource sharing) for JavaScript. You must provide a comma-separated \"allow\" list of specific domains. The default setting for -cors is an asterisk (*), which allows public access."
                             },
                             inMemory: {
-                                shortcut: 'i',
-                                usage: 'DynamoDB; will run in memory, instead of using a database file. When you stop DynamoDB;, none of the data will be saved. Note that you cannot specify both -dbPath and -inMemory at once.'
+                                shortcut: "i",
+                                usage: "DynamoDB; will run in memory, instead of using a database file. When you stop DynamoDB;, none of the data will be saved. Note that you cannot specify both -dbPath and -inMemory at once."
                             },
                             dbPath: {
-                                shortcut: 'd',
-                                usage: 'The directory where DynamoDB will write its database file. If you do not specify this option, the file will be written to the current directory. Note that you cannot specify both -dbPath and -inMemory at once. For the path, current working directory is <projectroot>/node_modules/serverless-dynamodb-local/dynamob. For example to create <projectroot>/node_modules/serverless-dynamodb-local/dynamob/<mypath> you should specify -d <mypath>/ or --dbPath <mypath>/ with a forwardslash at the end.'
+                                shortcut: "d",
+                                usage: "The directory where DynamoDB will write its database file. If you do not specify this option, the file will be written to the current directory. Note that you cannot specify both -dbPath and -inMemory at once. For the path, current working directory is <projectroot>/node_modules/serverless-dynamodb-local/dynamob. For example to create <projectroot>/node_modules/serverless-dynamodb-local/dynamob/<mypath> you should specify -d <mypath>/ or --dbPath <mypath>/ with a forwardslash at the end."
                             },
                             sharedDb: {
-                                shortcut: 'h',
-                                usage: 'DynamoDB will use a single database file, instead of using separate files for each credential and region. If you specify -sharedDb, all DynamoDB clients will interact with the same set of tables regardless of their region and credential configuration.'
+                                shortcut: "h",
+                                usage: "DynamoDB will use a single database file, instead of using separate files for each credential and region. If you specify -sharedDb, all DynamoDB clients will interact with the same set of tables regardless of their region and credential configuration."
                             },
                             delayTransientStatuses: {
-                                shortcut: 't',
-                                usage: 'Causes DynamoDB to introduce delays for certain operations. DynamoDB can perform some tasks almost instantaneously, such as create/update/delete operations on tables and indexes; however, the actual DynamoDB service requires more time for these tasks. Setting this parameter helps DynamoDB simulate the behavior of the Amazon DynamoDB web service more closely. (Currently, this parameter introduces delays only for global secondary indexes that are in either CREATING or DELETING status.'
+                                shortcut: "t",
+                                usage: "Causes DynamoDB to introduce delays for certain operations. DynamoDB can perform some tasks almost instantaneously, such as create/update/delete operations on tables and indexes; however, the actual DynamoDB service requires more time for these tasks. Setting this parameter helps DynamoDB simulate the behavior of the Amazon DynamoDB web service more closely. (Currently, this parameter introduces delays only for global secondary indexes that are in either CREATING or DELETING status."
                             },
                             optimizeDbBeforeStartup: {
-                                shortcut: 'o',
-                                usage: 'Optimizes the underlying database tables before starting up DynamoDB on your computer. You must also specify -dbPath when you use this parameter.'
+                                shortcut: "o",
+                                usage: "Optimizes the underlying database tables before starting up DynamoDB on your computer. You must also specify -dbPath when you use this parameter."
                             },
                             migrate: {
-                                shortcut: 'm',
-                                usage: 'After starting dynamodb local, create DynamoDB tables from the current serverless configuration'
+                                shortcut: "m",
+                                usage: "After starting dynamodb local, create DynamoDB tables from the current serverless configuration"
                             },
                             seed: {
-                                shortcut: 's',
-                                usage: 'After starting and migrating dynamodb local, injects seed data into your tables',
+                                shortcut: "s",
+                                usage: "After starting and migrating dynamodb local, injects seed data into your tables",
                             }
                         }
                     },
                     remove: {
-                        lifecycleEvents: ['removeHandler'],
-                        usage: 'Removes local DynamoDB'
+                        lifecycleEvents: ["removeHandler"],
+                        usage: "Removes local DynamoDB"
                     },
                     install: {
-                        usage: 'Installs local DynamoDB',
-                        lifecycleEvents: ['installHandler'],
+                        usage: "Installs local DynamoDB",
+                        lifecycleEvents: ["installHandler"],
                         options: {
                             localPath: {
-                                shortcut: 'x',
-                                usage: 'Local dynamodb install path'
+                                shortcut: "x",
+                                usage: "Local dynamodb install path"
                             }
                         }
 
@@ -84,23 +84,23 @@ class ServerlessDynamodbLocal {
         };
 
         this.hooks = {
-            'dynamodb:migrate:migrateHandler': this.migrateHandler.bind(this),
-            'dynamodb:migrate:seedHandler': this.seedHandler.bind(this),
-            'dynamodb:remove:removeHandler': this.removeHandler.bind(this),
-            'dynamodb:install:installHandler': this.installHandler.bind(this),
-            'dynamodb:start:startHandler': this.startHandler.bind(this),
-            'before:offline:start:init': this.startHandler.bind(this),
+            "dynamodb:migrate:migrateHandler": this.migrateHandler.bind(this),
+            "dynamodb:migrate:seedHandler": this.seedHandler.bind(this),
+            "dynamodb:remove:removeHandler": this.removeHandler.bind(this),
+            "dynamodb:install:installHandler": this.installHandler.bind(this),
+            "dynamodb:start:startHandler": this.startHandler.bind(this),
+            "before:offline:start:init": this.startHandler.bind(this),
         };
     }
 
     dynamodbOptions() {
         const config = this.service.custom.dynamodb || {};
         const port = config.start && config.start.port || 8000;
         const dynamoOptions = {
-            endpoint: 'http://localhost:' + port,
-            region: 'localhost',
-            accessKeyId: 'MOCK_ACCESS_KEY_ID',
-            secretAccessKey: 'MOCK_SECRET_ACCESS_KEY'
+            endpoint: "http://localhost:" + port,
+            region: "localhost",
+            accessKeyId: "MOCK_ACCESS_KEY_ID",
+            secretAccessKey: "MOCK_SECRET_ACCESS_KEY"
         };
 
         return {
@@ -120,7 +120,7 @@ class ServerlessDynamodbLocal {
         const { seedSources } = this;
         return BbPromise.each(seedSources, source => {
             if (!source.table) {
-                throw new Error('seeding source "table" not defined');
+                throw new Error("seeding source 'table' not defined");
             }
             return locateSeeds(source.sources || [])
             .then((seeds) => writeSeeds(documentClient, source.table, seeds));
@@ -159,7 +159,7 @@ class ServerlessDynamodbLocal {
     get tables() {
         const resources = this.service.resources.Resources;
         return Object.keys(resources).map((key) => {
-            if (resources[key].Type == 'AWS::DynamoDB::Table') {
+            if (resources[key].Type == "AWS::DynamoDB::Table") {
                 return resources[key].Properties;
             }
         }).filter(n => n);
@@ -170,7 +170,7 @@ class ServerlessDynamodbLocal {
      */
     get seedSources() {
         const config = this.service.custom.dynamodb;
-        return _.get(config, 'start.seeds', []);
+        return _.get(config, "start.seeds", []);
     }
 
     createTable(dynamodb, migration) {
diff --git a/src/seeder.js b/src/seeder.js
@@ -1,8 +1,8 @@
-const AWS = require('aws-sdk');
-const BbPromise = require('bluebird');
-const _ = require('lodash');
-const path = require('path');
-const fs = require('fs');
+const AWS = require("aws-sdk");
+const BbPromise = require("bluebird");
+const _ = require("lodash");
+const path = require("path");
+const fs = require("fs");
 
 // DynamoDB has a 25 item limit in batch requests
 // https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html
@@ -29,7 +29,7 @@ function writeSeedBatch(dynamodb, tableName, seeds) {
     },
   };
   return new BbPromise((resolve, reject) => {
-    // interval lets us know how much time we've burnt so far. This lets us have a backoff mechanism to try
+    // interval lets us know how much time we have burnt so far. This lets us have a backoff mechanism to try
     // again a few times in case the Database resources are in the middle of provisioning.
     let interval = 0;
     function execute(interval) {
@@ -47,7 +47,7 @@ function writeSeedBatch(dynamodb, tableName, seeds) {
     };
     execute(interval);
   });
-};
+}
 
 /**
  * Writes a seed corpus to the given database table
@@ -57,13 +57,13 @@ function writeSeedBatch(dynamodb, tableName, seeds) {
  */
 function writeSeeds(dynamodb, tableName, seeds) {
   if (!dynamodb) {
-    throw new Error('dynamodb argument must be provided');
+    throw new Error("dynamodb argument must be provided");
   }
   if (!tableName) {
-    throw new Error('table name argument must be provided');
+    throw new Error("table name argument must be provided");
   }
   if (!seeds) {
-    throw new Error('seeds argument must be provided');
+    throw new Error("seeds argument must be provided");
   }
 
   if (seeds.length > 0) {
@@ -77,37 +77,50 @@ function writeSeeds(dynamodb, tableName, seeds) {
   }
 }
 
+/**
+ * A promise-based function that determines if a file exists
+ * @param {string} fileName The path to the file
+ */
 function fileExists(fileName) {
   return new BbPromise((resolve) => {
     fs.exists(fileName, (exists) => resolve(exists));
   });
 }
 
+/**
+ * Scrapes seed files out of a given location. This file may contain
+ * either a simple json object, or an array of simple json objects. An array
+ * of json objects is returned.
+ *
+ * @param {any} location the filename to read seeds from.
+ */
+function getSeedsAtLocation(location) {
+  // load the file as JSON
+  const result = require(location);
+
+  // Ensure the output is an array
+  if (Array.isArray(result)) {
+    return result;
+  } else {
+    return [ result ];
+  }
+}
+
 /**
  * Locates seeds given a set of files to scrape
  * @param {string[]} sources The filenames to scrape for seeds
  */
 function locateSeeds(sources = [], cwd = process.cwd()) {
   const locations = sources.map(source => path.join(cwd, source));
   return BbPromise.map(locations, (location) => {
-    return fileExists(location)
-    .then((exists) => {
+    return fileExists(location).then((exists) => {
       if(!exists) {
-        throw new Error('source file ' + location + ' does not exist');
-      }
-
-      // load the file as JSON
-      const result = require(location);
-
-      // Ensure the output is an array
-      if (Array.isArray(result)) {
-        return result;
-      } else {
-        return [ result ];
+        throw new Error("source file " + location + " does not exist");
       }
+      return getSeedsAtLocation(location);
     });
   // Smash the arrays together
-  }).then(seedArrays => [].concat.apply([], seedArrays));
+  }).then((seedArrays) => [].concat.apply([], seedArrays));
 }
 
 module.exports = { writeSeeds, locateSeeds };
