faker 5.3.1 → 5.5.2

package/lib/address.js

@@ -4,7 +4,7 @@
  */
 function Address (faker) {
   var f = faker.fake,
-      Helpers = faker.helpers;
+    Helpers = faker.helpers;
 
   /**
    * Generates random zipcode from format. If format is not specified, the
@@ -39,7 +39,7 @@ function Address (faker) {
   this.zipCodeByState = function (state) {
     var zipRange = faker.definitions.address.postcode_by_state[state];
     if (zipRange) {
-      return faker.random.number(zipRange);
+      return faker.datatype.number(zipRange);
     }
     return faker.address.zipCode();
   }
@@ -55,6 +55,7 @@ function Address (faker) {
    * * `{{address.cityPrefix}} {{name.firstName}}`
    * * `{{name.firstName}}{{address.citySuffix}}`
    * * `{{name.lastName}}{{address.citySuffix}}`
+   * * `{{address.cityName}}` when city name is available
    *
    * @method faker.address.city
    * @param {String} format
@@ -67,8 +68,12 @@ function Address (faker) {
       '{{name.lastName}}{{address.citySuffix}}'
     ];
 
+    if (!format && faker.definitions.address.city_name) {
+      formats.push('{{address.cityName}}');
+    }
+
     if (typeof format !== "number") {
-      format = faker.random.number(formats.length - 1);
+      format = faker.datatype.number(formats.length - 1);
     }
 
     return f(formats[format]);
@@ -92,27 +97,36 @@ function Address (faker) {
     return faker.random.arrayElement(faker.definitions.address.city_suffix);
   }
 
+  /**
+   * Returns a random city name
+   * 
+   * @method faker.address.cityName
+   */
+  this.cityName = function() {
+    return faker.random.arrayElement(faker.definitions.address.city_name);
+  }
+
   /**
    * Returns a random localized street name
    *
    * @method faker.address.streetName
    */
   this.streetName = function () {
-      var result;
-      var suffix = faker.address.streetSuffix();
-      if (suffix !== "") {
-          suffix = " " + suffix
-      }
+    var result;
+    var suffix = faker.address.streetSuffix();
+    if (suffix !== "") {
+      suffix = " " + suffix
+    }
 
-      switch (faker.random.number(1)) {
+    switch (faker.datatype.number(1)) {
       case 0:
-          result = faker.name.lastName() + suffix;
-          break;
+        result = faker.name.lastName() + suffix;
+        break;
       case 1:
-          result = faker.name.firstName() + suffix;
-          break;
-      }
-      return result;
+        result = faker.name.firstName() + suffix;
+        break;
+    }
+    return result;
   }
 
   //
@@ -125,20 +139,20 @@ function Address (faker) {
    * @param {Boolean} useFullAddress
    */
   this.streetAddress = function (useFullAddress) {
-      if (useFullAddress === undefined) { useFullAddress = false; }
-      var address = "";
-      switch (faker.random.number(2)) {
+    if (useFullAddress === undefined) { useFullAddress = false; }
+    var address = "";
+    switch (faker.datatype.number(2)) {
       case 0:
-          address = Helpers.replaceSymbolWithNumber("#####") + " " + faker.address.streetName();
-          break;
+        address = Helpers.replaceSymbolWithNumber("#####") + " " + faker.address.streetName();
+        break;
       case 1:
-          address = Helpers.replaceSymbolWithNumber("####") +  " " + faker.address.streetName();
-          break;
+        address = Helpers.replaceSymbolWithNumber("####") +  " " + faker.address.streetName();
+        break;
       case 2:
-          address = Helpers.replaceSymbolWithNumber("###") + " " + faker.address.streetName();
-          break;
-      }
-      return useFullAddress ? (address + " " + faker.address.secondaryAddress()) : address;
+        address = Helpers.replaceSymbolWithNumber("###") + " " + faker.address.streetName();
+        break;
+    }
+    return useFullAddress ? (address + " " + faker.address.secondaryAddress()) : address;
   }
 
   /**
@@ -147,7 +161,7 @@ function Address (faker) {
    * @method faker.address.streetSuffix
    */
   this.streetSuffix = function () {
-      return faker.random.arrayElement(faker.definitions.address.street_suffix);
+    return faker.random.arrayElement(faker.definitions.address.street_suffix);
   }
 
   /**
@@ -156,7 +170,7 @@ function Address (faker) {
    * @method faker.address.streetPrefix
    */
   this.streetPrefix = function () {
-      return faker.random.arrayElement(faker.definitions.address.street_prefix);
+    return faker.random.arrayElement(faker.definitions.address.street_prefix);
   }
 
   /**
@@ -165,12 +179,12 @@ function Address (faker) {
    * @method faker.address.secondaryAddress
    */
   this.secondaryAddress = function () {
-      return Helpers.replaceSymbolWithNumber(faker.random.arrayElement(
-          [
-              'Apt. ###',
-              'Suite ###'
-          ]
-      ));
+    return Helpers.replaceSymbolWithNumber(faker.random.arrayElement(
+      [
+        'Apt. ###',
+        'Suite ###'
+      ]
+    ));
   }
 
   /**
@@ -200,11 +214,11 @@ function Address (faker) {
   this.countryCode = function (alphaCode) {
     
     if (typeof alphaCode === 'undefined' || alphaCode === 'alpha-2') {
-        return faker.random.arrayElement(faker.definitions.address.country_code);
+      return faker.random.arrayElement(faker.definitions.address.country_code);
     }
 
     if (alphaCode === 'alpha-3') {
-        return faker.random.arrayElement(faker.definitions.address.country_code_alpha_3);
+      return faker.random.arrayElement(faker.definitions.address.country_code_alpha_3);
     }
       
     return faker.random.arrayElement(faker.definitions.address.country_code);
@@ -218,7 +232,7 @@ function Address (faker) {
    * @param {Boolean} useAbbr
    */
   this.state = function (useAbbr) {
-      return faker.random.arrayElement(faker.definitions.address.state);
+    return faker.random.arrayElement(faker.definitions.address.state);
   }
 
   /**
@@ -227,7 +241,7 @@ function Address (faker) {
    * @method faker.address.stateAbbr
    */
   this.stateAbbr = function () {
-      return faker.random.arrayElement(faker.definitions.address.state_abbr);
+    return faker.random.arrayElement(faker.definitions.address.state_abbr);
   }
 
   /**
@@ -239,15 +253,15 @@ function Address (faker) {
    * @param {number} precision default is 4
    */
   this.latitude = function (max, min, precision) {
-      max       = max || 90
-      min       = min || -90
-      precision = precision || 4
-
-      return faker.random.number({
-        max: max,
-        min: min,
-        precision: parseFloat((0.0).toPrecision(precision) + '1')
-      }).toFixed(precision);
+    max       = max || 90
+    min       = min || -90
+    precision = precision || 4
+
+    return faker.datatype.number({
+      max: max,
+      min: min,
+      precision: parseFloat((0.0).toPrecision(precision) + '1')
+    }).toFixed(precision);
   }
 
   /**
@@ -259,15 +273,15 @@ function Address (faker) {
    * @param {number} precision default is 4
    */
   this.longitude = function (max, min, precision) {
-      max       = max || 180
-      min       = min || -180
-      precision = precision || 4
-
-      return faker.random.number({
-        max: max,
-        min: min,
-        precision: parseFloat((0.0).toPrecision(precision) + '1')
-      }).toFixed(precision);
+    max       = max || 180
+    min       = min || -180
+    precision = precision || 4
+
+    return faker.datatype.number({
+      max: max,
+      min: min,
+      precision: parseFloat((0.0).toPrecision(precision) + '1')
+    }).toFixed(precision);
   }
 
   /**
@@ -333,64 +347,64 @@ function Address (faker) {
   };
 
   this.nearbyGPSCoordinate = function(coordinate, radius, isMetric) {
-        function randomFloat(min, max) {
-            return Math.random() * (max-min) + min;
-        }
-        function degreesToRadians(degrees) {
-            return degrees * (Math.PI/180.0);
-        }
-        function radiansToDegrees(radians) {
-            return radians * (180.0/Math.PI);
-        }
-        function kilometersToMiles(miles) {
-            return miles * 0.621371;
-        }
-        function coordinateWithOffset(coordinate, bearing, distance, isMetric) {
-            var R = 6378.137; // Radius of the Earth (http://nssdc.gsfc.nasa.gov/planetary/factsheet/earthfact.html)
-            var d = isMetric ? distance : kilometersToMiles(distance); // Distance in km
-
-            var lat1 = degreesToRadians(coordinate[0]); //Current lat point converted to radians
-            var lon1 = degreesToRadians(coordinate[1]); //Current long point converted to radians
-
-            var lat2 = Math.asin(Math.sin(lat1) * Math.cos(d/R) +
+    function randomFloat(min, max) {
+      return Math.random() * (max-min) + min;
+    }
+    function degreesToRadians(degrees) {
+      return degrees * (Math.PI/180.0);
+    }
+    function radiansToDegrees(radians) {
+      return radians * (180.0/Math.PI);
+    }
+    function kilometersToMiles(miles) {
+      return miles * 0.621371;
+    }
+    function coordinateWithOffset(coordinate, bearing, distance, isMetric) {
+      var R = 6378.137; // Radius of the Earth (http://nssdc.gsfc.nasa.gov/planetary/factsheet/earthfact.html)
+      var d = isMetric ? distance : kilometersToMiles(distance); // Distance in km
+
+      var lat1 = degreesToRadians(coordinate[0]); //Current lat point converted to radians
+      var lon1 = degreesToRadians(coordinate[1]); //Current long point converted to radians
+
+      var lat2 = Math.asin(Math.sin(lat1) * Math.cos(d/R) +
                 Math.cos(lat1) * Math.sin(d/R) * Math.cos(bearing));
 
-            var lon2 = lon1 + Math.atan2(
-                Math.sin(bearing) * Math.sin(d/R) * Math.cos(lat1),
-                Math.cos(d/R) - Math.sin(lat1) * Math.sin(lat2));
-
-            // Keep longitude in range [-180, 180]
-            if (lon2 > degreesToRadians(180)) {
-                lon2 = lon2 - degreesToRadians(360);
-            } else if (lon2 < degreesToRadians(-180)) {
-                lon2 = lon2 + degreesToRadians(360);
-            }
-
-            return [radiansToDegrees(lat2), radiansToDegrees(lon2)];
-        }
-
-        // If there is no coordinate, the best we can do is return a random GPS coordinate.
-        if (coordinate === undefined) {
-            return [faker.address.latitude(), faker.address.longitude()]
-        }
-        radius = radius || 10.0;
-        isMetric = isMetric || false;
-
-        // TODO: implement either a gaussian/uniform distribution of points in cicular region.
-        // Possibly include param to function that allows user to choose between distributions.
-
-        // This approach will likely result in a higher density of points near the center.
-        var randomCoord = coordinateWithOffset(coordinate, degreesToRadians(Math.random() * 360.0), radius, isMetric);
-        return [randomCoord[0].toFixed(4), randomCoord[1].toFixed(4)];
+      var lon2 = lon1 + Math.atan2(
+        Math.sin(bearing) * Math.sin(d/R) * Math.cos(lat1),
+        Math.cos(d/R) - Math.sin(lat1) * Math.sin(lat2));
+
+      // Keep longitude in range [-180, 180]
+      if (lon2 > degreesToRadians(180)) {
+        lon2 = lon2 - degreesToRadians(360);
+      } else if (lon2 < degreesToRadians(-180)) {
+        lon2 = lon2 + degreesToRadians(360);
+      }
+
+      return [radiansToDegrees(lat2), radiansToDegrees(lon2)];
+    }
+
+    // If there is no coordinate, the best we can do is return a random GPS coordinate.
+    if (coordinate === undefined) {
+      return [faker.address.latitude(), faker.address.longitude()]
     }
+    radius = radius || 10.0;
+    isMetric = isMetric || false;
+
+    // TODO: implement either a gaussian/uniform distribution of points in cicular region.
+    // Possibly include param to function that allows user to choose between distributions.
+
+    // This approach will likely result in a higher density of points near the center.
+    var randomCoord = coordinateWithOffset(coordinate, degreesToRadians(Math.random() * 360.0), radius, isMetric);
+    return [randomCoord[0].toFixed(4), randomCoord[1].toFixed(4)];
+  }
 
-    /**
+  /**
      * Return a random time zone
      * @method faker.address.timeZone
      */
-    this.timeZone = function() {
-      return faker.random.arrayElement(faker.definitions.address.time_zone);
-    }
+  this.timeZone = function() {
+    return faker.random.arrayElement(faker.definitions.address.time_zone);
+  }
 
   return this;
 }

package/lib/animal.js

@@ -0,0 +1,124 @@
+/**
+ *
+ * @namespace faker.animal
+ */
+var Animal = function (faker) {
+  var self = this;
+
+  /**
+   * dog
+   *
+   * @method faker.animal.dog
+   */
+  self.dog = function() {
+    return faker.random.arrayElement(faker.definitions.animal.dog);
+  };
+  /**
+   * cat
+   *
+   * @method faker.animal.cat
+   */
+  self.cat = function() {
+    return faker.random.arrayElement(faker.definitions.animal.cat);
+  };
+  /**
+   * snake  
+   *
+   * @method faker.animal.snake
+   */
+  self.snake = function() {
+    return faker.random.arrayElement(faker.definitions.animal.snake);
+  };
+  /**
+   * bear  
+   *
+   * @method faker.animal.bear
+   */
+  self.bear = function() {
+    return faker.random.arrayElement(faker.definitions.animal.bear);
+  };
+  /**
+   * lion  
+   *
+   * @method faker.animal.lion
+   */
+  self.lion = function() {
+    return faker.random.arrayElement(faker.definitions.animal.lion);
+  };
+  /**
+   * cetacean  
+   *
+   * @method faker.animal.cetacean
+   */
+  self.cetacean = function() {
+    return faker.random.arrayElement(faker.definitions.animal.cetacean);
+  };
+  /**
+   * horse 
+   *
+   * @method faker.animal.horse
+   */
+  self.horse = function() {
+    return faker.random.arrayElement(faker.definitions.animal.horse);
+  };
+  /**
+   * bird
+   *
+   * @method faker.animal.bird
+   */
+  self.bird = function() {
+    return faker.random.arrayElement(faker.definitions.animal.bird);
+  };
+  /**
+   * cow 
+   *
+   * @method faker.animal.cow
+   */
+  self.cow = function() {
+    return faker.random.arrayElement(faker.definitions.animal.cow);
+  };
+  /**
+   * fish
+   *
+   * @method faker.animal.fish
+   */
+  self.fish = function() {
+    return faker.random.arrayElement(faker.definitions.animal.fish);
+  };
+  /**
+   * crocodilia
+   *
+   * @method faker.animal.crocodilia
+   */
+  self.crocodilia = function() {
+    return faker.random.arrayElement(faker.definitions.animal.crocodilia);
+  };
+  /**
+   * insect  
+   *
+   * @method faker.animal.insect
+   */
+  self.insect = function() {
+    return faker.random.arrayElement(faker.definitions.animal.insect);
+  };
+  /**
+   * rabbit 
+   *
+   * @method faker.animal.rabbit
+   */
+  self.rabbit = function() {
+    return faker.random.arrayElement(faker.definitions.animal.rabbit);
+  };
+  /**
+   * type 
+   *
+   * @method faker.animal.type
+   */
+  self.type = function() {
+    return faker.random.arrayElement(faker.definitions.animal.type);
+  };
+
+  return self;
+};
+
+module['exports'] = Animal;

package/lib/commerce.js

@@ -11,7 +11,7 @@ var Commerce = function (faker) {
    * @method faker.commerce.color
    */
   self.color = function() {
-      return faker.random.arrayElement(faker.definitions.commerce.color);
+    return faker.random.arrayElement(faker.definitions.commerce.color);
   };
 
   /**
@@ -20,7 +20,7 @@ var Commerce = function (faker) {
    * @method faker.commerce.department
    */
   self.department = function() {
-      return faker.random.arrayElement(faker.definitions.commerce.department);
+    return faker.random.arrayElement(faker.definitions.commerce.department);
   };
 
   /**
@@ -29,7 +29,7 @@ var Commerce = function (faker) {
    * @method faker.commerce.productName
    */
   self.productName = function() {
-      return faker.commerce.productAdjective() + " " +
+    return faker.commerce.productAdjective() + " " +
               faker.commerce.productMaterial() + " " +
               faker.commerce.product();
   };
@@ -46,18 +46,18 @@ var Commerce = function (faker) {
    * @return {string}
    */
   self.price = function(min, max, dec, symbol) {
-      min = min || 1;
-      max = max || 1000;
-      dec = dec === undefined ? 2 : dec;
-      symbol = symbol || '';
+    min = min || 1;
+    max = max || 1000;
+    dec = dec === undefined ? 2 : dec;
+    symbol = symbol || '';
 
-      if (min < 0 || max < 0) {
-          return symbol + 0.00;
-      }
+    if (min < 0 || max < 0) {
+      return symbol + 0.00;
+    }
 
-      var randValue = faker.random.number({ max: max, min: min });
+    var randValue = faker.datatype.number({ max: max, min: min });
 
-      return symbol + (Math.round(randValue * Math.pow(10, dec)) / Math.pow(10, dec)).toFixed(dec);
+    return symbol + (Math.round(randValue * Math.pow(10, dec)) / Math.pow(10, dec)).toFixed(dec);
   };
 
   /*
@@ -92,7 +92,7 @@ var Commerce = function (faker) {
    * @method faker.commerce.productAdjective
    */
   self.productAdjective = function() {
-      return faker.random.arrayElement(faker.definitions.commerce.product_name.adjective);
+    return faker.random.arrayElement(faker.definitions.commerce.product_name.adjective);
   };
 
   /**
@@ -101,7 +101,7 @@ var Commerce = function (faker) {
    * @method faker.commerce.productMaterial
    */
   self.productMaterial = function() {
-      return faker.random.arrayElement(faker.definitions.commerce.product_name.material);
+    return faker.random.arrayElement(faker.definitions.commerce.product_name.material);
   };
 
   /**
@@ -110,7 +110,7 @@ var Commerce = function (faker) {
    * @method faker.commerce.product
    */
   self.product = function() {
-      return faker.random.arrayElement(faker.definitions.commerce.product_name.product);
+    return faker.random.arrayElement(faker.definitions.commerce.product_name.product);
   };
 
   /**
@@ -119,7 +119,7 @@ var Commerce = function (faker) {
    * @method faker.commerce.productDescription
    */
   self.productDescription = function() {
-      return faker.random.arrayElement(faker.definitions.commerce.product_description);
+    return faker.random.arrayElement(faker.definitions.commerce.product_description);
   };
 
   return self;

package/lib/company.js

@@ -32,7 +32,7 @@ var Company = function (faker) {
     ];
 
     if (typeof format !== "number") {
-      format = faker.random.number(formats.length - 1);
+      format = faker.datatype.number(formats.length - 1);
     }
 
     return f(formats[format]);
@@ -44,7 +44,7 @@ var Company = function (faker) {
    * @method faker.company.companySuffix
    */
   this.companySuffix = function () {
-      return faker.random.arrayElement(faker.company.suffixes());
+    return faker.random.arrayElement(faker.company.suffixes());
   }
 
   /**
@@ -71,7 +71,7 @@ var Company = function (faker) {
    * @method faker.company.catchPhraseAdjective
    */
   this.catchPhraseAdjective = function () {
-      return faker.random.arrayElement(faker.definitions.company.adjective);
+    return faker.random.arrayElement(faker.definitions.company.adjective);
   }
 
   /**
@@ -80,7 +80,7 @@ var Company = function (faker) {
    * @method faker.company.catchPhraseDescriptor
    */
   this.catchPhraseDescriptor = function () {
-      return faker.random.arrayElement(faker.definitions.company.descriptor);
+    return faker.random.arrayElement(faker.definitions.company.descriptor);
   }
 
   /**
@@ -89,7 +89,7 @@ var Company = function (faker) {
    * @method faker.company.catchPhraseNoun
    */
   this.catchPhraseNoun = function () {
-      return faker.random.arrayElement(faker.definitions.company.noun);
+    return faker.random.arrayElement(faker.definitions.company.noun);
   }
 
   /**
@@ -98,7 +98,7 @@ var Company = function (faker) {
    * @method faker.company.bsAdjective
    */
   this.bsAdjective = function () {
-      return faker.random.arrayElement(faker.definitions.company.bs_adjective);
+    return faker.random.arrayElement(faker.definitions.company.bs_adjective);
   }
 
   /**
@@ -107,7 +107,7 @@ var Company = function (faker) {
    * @method faker.company.bsBuzz
    */
   this.bsBuzz = function () {
-      return faker.random.arrayElement(faker.definitions.company.bs_verb);
+    return faker.random.arrayElement(faker.definitions.company.bs_verb);
   }
 
   /**
@@ -116,7 +116,7 @@ var Company = function (faker) {
    * @method faker.company.bsNoun
    */
   this.bsNoun = function () {
-      return faker.random.arrayElement(faker.definitions.company.bs_noun);
+    return faker.random.arrayElement(faker.definitions.company.bs_noun);
   }
   
 }

package/lib/database.js

@@ -10,7 +10,7 @@ var Database = function (faker) {
    * @method faker.database.column
    */
   self.column = function () {
-      return faker.random.arrayElement(faker.definitions.database.column);
+    return faker.random.arrayElement(faker.definitions.database.column);
   };
 
   self.column.schema = {
@@ -24,7 +24,7 @@ var Database = function (faker) {
    * @method faker.database.type
    */
   self.type = function () {
-      return faker.random.arrayElement(faker.definitions.database.type);
+    return faker.random.arrayElement(faker.definitions.database.type);
   };
 
   self.type.schema = {
@@ -38,7 +38,7 @@ var Database = function (faker) {
    * @method faker.database.collation
    */
   self.collation = function () {
-      return faker.random.arrayElement(faker.definitions.database.collation);
+    return faker.random.arrayElement(faker.definitions.database.collation);
   };
 
   self.collation.schema = {
@@ -52,7 +52,7 @@ var Database = function (faker) {
    * @method faker.database.engine
    */
   self.engine = function () {
-      return faker.random.arrayElement(faker.definitions.database.engine);
+    return faker.random.arrayElement(faker.definitions.database.engine);
   };
 
   self.engine.schema = {