faker 5.3.1 → 5.5.2

package/lib/datatype.js

@@ -0,0 +1,226 @@
+/**
+ *
+ * @namespace faker.datatype
+ */
+function Datatype (faker, seed) {
+  // Use a user provided seed if it is an array or number
+  if (Array.isArray(seed) && seed.length) {
+    faker.mersenne.seed_array(seed);
+  }
+  else if(!isNaN(seed)) {
+    faker.mersenne.seed(seed);
+  }
+
+  /**
+     * returns a single random number based on a max number or range
+     *
+     * @method faker.datatype.number
+     * @param {mixed} options {min, max, precision}
+     */
+  this.number = function (options) {
+
+    if (typeof options === "number") {
+      options = {
+        max: options
+      };
+    }
+
+    options = options || {};
+
+    if (typeof options.min === "undefined") {
+      options.min = 0;
+    }
+
+    if (typeof options.max === "undefined") {
+      options.max = 99999;
+    }
+    if (typeof options.precision === "undefined") {
+      options.precision = 1;
+    }
+
+    // Make the range inclusive of the max value
+    var max = options.max;
+    if (max >= 0) {
+      max += options.precision;
+    }
+
+    var randomNumber = Math.floor(
+      faker.mersenne.rand(max / options.precision, options.min / options.precision));
+    // Workaround problem in Float point arithmetics for e.g. 6681493 / 0.01
+    randomNumber = randomNumber / (1 / options.precision);
+
+    return randomNumber;
+
+  };
+
+  /**
+     * returns a single random floating-point number based on a max number or range
+     *
+     * @method faker.datatype.float
+     * @param {mixed} options
+     */
+  this.float = function (options) {
+    if (typeof options === "number") {
+      options = {
+        precision: options
+      };
+    }
+    options = options || {};
+    var opts = {};
+    for (var p in options) {
+      opts[p] = options[p];
+    }
+    if (typeof opts.precision === 'undefined') {
+      opts.precision = 0.01;
+    }
+    return faker.datatype.number(opts);
+  };
+
+  /**
+     * method returns a Date object using a random number of milliseconds since 1. Jan 1970 UTC
+     * Caveat: seeding is not working
+     *
+     * @method faker.datatype.datetime
+     * @param {mixed} options, pass min OR max as number of milliseconds since 1. Jan 1970 UTC
+     */
+  this.datetime = function (options) {
+    if (typeof options === "number") {
+      options = {
+        max: options
+      };
+    }
+
+    var minMax = 8640000000000000;
+
+    options = options || {};
+
+    if (typeof options.min === "undefined" || options.min < minMax*-1) {
+      options.min = new Date().setFullYear(1990, 1, 1);
+    }
+
+    if (typeof options.max === "undefined" || options.max > minMax) {
+      options.max = new Date().setFullYear(2100,1,1);
+    }
+
+    var random = faker.datatype.number(options);
+    return new Date(random);
+  };
+
+  /**
+     * Returns a string, containing UTF-16 chars between 33 and 125 ('!' to '}')
+     *
+     *
+     * @method faker.datatype.string
+     * @param { number } length: length of generated string, default = 10, max length = 2^20
+     */
+  this.string = function (length) {
+    if(length === undefined ){
+      length = 10;
+    }
+
+    var maxLength = Math.pow(2, 20);
+    if(length >= (maxLength)){
+      length = maxLength;
+    }
+
+    var charCodeOption = {
+      min: 33,
+      max: 125
+    };
+
+    var returnString = '';
+
+    for(var i = 0; i < length; i++){
+      returnString += String.fromCharCode(faker.datatype.number(charCodeOption));
+    }
+    return returnString;
+  };
+
+  /**
+     * uuid
+     *
+     * @method faker.datatype.uuid
+     */
+  this.uuid = function () {
+    var RFC4122_TEMPLATE = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx';
+    var replacePlaceholders = function (placeholder) {
+      var random = faker.datatype.number({ min: 0, max: 15 });
+      var value = placeholder == 'x' ? random : (random &0x3 | 0x8);
+      return value.toString(16);
+    };
+    return RFC4122_TEMPLATE.replace(/[xy]/g, replacePlaceholders);
+  };
+
+  /**
+     * boolean
+     *
+     * @method faker.datatype.boolean
+     */
+  this.boolean = function () {
+    return !!faker.datatype.number(1);
+  };
+
+
+  /**
+     * hexaDecimal
+     *
+     * @method faker.datatype.hexaDecimal
+     * @param {number} count defaults to 1
+     */
+  this.hexaDecimal = function hexaDecimal(count) {
+    if (typeof count === "undefined") {
+      count = 1;
+    }
+
+    var wholeString = "";
+    for(var i = 0; i < count; i++) {
+      wholeString += faker.random.arrayElement(["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "a", "b", "c", "d", "e", "f", "A", "B", "C", "D", "E", "F"]);
+    }
+
+    return "0x"+wholeString;
+  };
+
+  /**
+     * returns json object with 7 pre-defined properties
+     *
+     * @method faker.datatype.json
+     */
+  this.json = function json() {
+
+    var properties = ['foo', 'bar', 'bike', 'a', 'b', 'name', 'prop'];
+
+    var returnObject = {};
+    properties.forEach(function(prop){
+      returnObject[prop] = faker.datatype.boolean() ?
+        faker.datatype.string() : faker.datatype.number();
+    });
+
+    return JSON.stringify(returnObject);
+  };
+
+  /**
+     * returns an array with values generated by faker.datatype.number and faker.datatype.string
+     *
+     * @method faker.datatype.array
+     * @param { number } length of the returned array
+     */
+
+  this.array = function array(length) {
+
+
+    if(length === undefined){
+      length = 10;
+    }
+    var returnArray = new Array(length);
+    for(var i = 0; i < length; i++){
+      returnArray[i] = faker.datatype.boolean() ?
+        faker.datatype.string() : faker.datatype.number();
+    }
+    return returnArray;
+
+  };
+
+  return this;
+}
+
+module['exports'] = Datatype;

package/lib/date.js

@@ -12,21 +12,21 @@ var _Date = function (faker) {
    * @param {date} refDate
    */
   self.past = function (years, refDate) {
-      var date = new Date();
-      if (typeof refDate !== "undefined") {
-          date = new Date(Date.parse(refDate));
-      }
+    var date = new Date();
+    if (typeof refDate !== "undefined") {
+      date = new Date(Date.parse(refDate));
+    }
 
-      var range = {
-        min: 1000,
-        max: (years || 1) * 365 * 24 * 3600 * 1000
-      };
+    var range = {
+      min: 1000,
+      max: (years || 1) * 365 * 24 * 3600 * 1000
+    };
 
-      var past = date.getTime();
-      past -= faker.random.number(range); // some time from now to N years ago, in milliseconds
-      date.setTime(past);
+    var past = date.getTime();
+    past -= faker.datatype.number(range); // some time from now to N years ago, in milliseconds
+    date.setTime(past);
 
-      return date;
+    return date;
   };
 
   /**
@@ -37,21 +37,21 @@ var _Date = function (faker) {
    * @param {date} refDate
    */
   self.future = function (years, refDate) {
-      var date = new Date();
-      if (typeof refDate !== "undefined") {
-          date = new Date(Date.parse(refDate));
-      }
+    var date = new Date();
+    if (typeof refDate !== "undefined") {
+      date = new Date(Date.parse(refDate));
+    }
 
-      var range = {
-        min: 1000,
-        max: (years || 1) * 365 * 24 * 3600 * 1000
-      };
+    var range = {
+      min: 1000,
+      max: (years || 1) * 365 * 24 * 3600 * 1000
+    };
 
-      var future = date.getTime();
-      future += faker.random.number(range); // some time from now to N years later, in milliseconds
-      date.setTime(future);
+    var future = date.getTime();
+    future += faker.datatype.number(range); // some time from now to N years later, in milliseconds
+    date.setTime(future);
 
-      return date;
+    return date;
   };
 
   /**
@@ -62,14 +62,36 @@ var _Date = function (faker) {
    * @param {date} to
    */
   self.between = function (from, to) {
-      var fromMilli = Date.parse(from);
-      var dateOffset = faker.random.number(Date.parse(to) - fromMilli);
+    var fromMilli = Date.parse(from);
+    var dateOffset = faker.datatype.number(Date.parse(to) - fromMilli);
 
-      var newDate = new Date(fromMilli + dateOffset);
+    var newDate = new Date(fromMilli + dateOffset);
 
-      return newDate;
+    return newDate;
   };
 
+  /**
+   * betweens
+   *
+   * @method faker.date.between
+   * @param {date} from
+   * @param {date} to
+   */
+  self.betweens = function (from, to, num) {
+    if (typeof num == 'undefined') { num = 3; }
+    var newDates = [];
+    var fromMilli = Date.parse(from);
+    var dateOffset = (Date.parse(to) - fromMilli) / ( num + 1 );
+    var lastDate = from
+    for (var i = 0; i < num; i++) {
+      fromMilli = Date.parse(lastDate);
+      lastDate = new Date(fromMilli + dateOffset)
+      newDates.push(lastDate)
+    }
+    return newDates;
+  };
+
+
   /**
    * recent
    *
@@ -78,21 +100,21 @@ var _Date = function (faker) {
    * @param {date} refDate
    */
   self.recent = function (days, refDate) {
-      var date = new Date();
-      if (typeof refDate !== "undefined") {
-          date = new Date(Date.parse(refDate));
-      }
+    var date = new Date();
+    if (typeof refDate !== "undefined") {
+      date = new Date(Date.parse(refDate));
+    }
 
-      var range = {
-        min: 1000,
-        max: (days || 1) * 24 * 3600 * 1000
-      };
+    var range = {
+      min: 1000,
+      max: (days || 1) * 24 * 3600 * 1000
+    };
 
-      var future = date.getTime();
-      future -= faker.random.number(range); // some time from now to N days ago, in milliseconds
-      date.setTime(future);
+    var future = date.getTime();
+    future -= faker.datatype.number(range); // some time from now to N days ago, in milliseconds
+    date.setTime(future);
 
-      return date;
+    return date;
   };
 
   /**
@@ -103,21 +125,21 @@ var _Date = function (faker) {
    * @param {date} refDate
    */
   self.soon = function (days, refDate) {
-      var date = new Date();
-      if (typeof refDate !== "undefined") {
-          date = new Date(Date.parse(refDate));
-      }
+    var date = new Date();
+    if (typeof refDate !== "undefined") {
+      date = new Date(Date.parse(refDate));
+    }
 
-      var range = {
-        min: 1000,
-        max: (days || 1) * 24 * 3600 * 1000
-      };
+    var range = {
+      min: 1000,
+      max: (days || 1) * 24 * 3600 * 1000
+    };
 
-      var future = date.getTime();
-      future += faker.random.number(range); // some time from now to N days later, in milliseconds
-      date.setTime(future);
+    var future = date.getTime();
+    future += faker.datatype.number(range); // some time from now to N days later, in milliseconds
+    date.setTime(future);
 
-      return date;
+    return date;
   };
 
   /**
@@ -127,19 +149,19 @@ var _Date = function (faker) {
    * @param {object} options
    */
   self.month = function (options) {
-      options = options || {};
+    options = options || {};
 
-      var type = 'wide';
-      if (options.abbr) {
-          type = 'abbr';
-      }
-      if (options.context && typeof faker.definitions.date.month[type + '_context'] !== 'undefined') {
-          type += '_context';
-      }
+    var type = 'wide';
+    if (options.abbr) {
+      type = 'abbr';
+    }
+    if (options.context && typeof faker.definitions.date.month[type + '_context'] !== 'undefined') {
+      type += '_context';
+    }
 
-      var source = faker.definitions.date.month[type];
+    var source = faker.definitions.date.month[type];
 
-      return faker.random.arrayElement(source);
+    return faker.random.arrayElement(source);
   };
 
   /**
@@ -149,19 +171,19 @@ var _Date = function (faker) {
    * @method faker.date.weekday
    */
   self.weekday = function (options) {
-      options = options || {};
+    options = options || {};
 
-      var type = 'wide';
-      if (options.abbr) {
-          type = 'abbr';
-      }
-      if (options.context && typeof faker.definitions.date.weekday[type + '_context'] !== 'undefined') {
-          type += '_context';
-      }
+    var type = 'wide';
+    if (options.abbr) {
+      type = 'abbr';
+    }
+    if (options.context && typeof faker.definitions.date.weekday[type + '_context'] !== 'undefined') {
+      type += '_context';
+    }
 
-      var source = faker.definitions.date.weekday[type];
+    var source = faker.definitions.date.weekday[type];
 
-      return faker.random.arrayElement(source);
+    return faker.random.arrayElement(source);
   };
 
   return self;

package/lib/finance.js

@@ -103,16 +103,23 @@ var Finance = function (faker) {
    *
    * @return {string}
    */
-  self.amount = function (min, max, dec, symbol) {
+  self.amount = function (min, max, dec, symbol, autoFormat) {
 
       min = min || 0;
       max = max || 1000;
       dec = dec === undefined ? 2 : dec;
       symbol = symbol || '';
-      var randValue = faker.random.number({ max: max, min: min, precision: Math.pow(10, -dec) });
-      var stringNumber = symbol + randValue.toFixed(dec);
+      const randValue = faker.datatype.number({ max: max, min: min, precision: Math.pow(10, -dec) });
 
-      return symbol + randValue.toFixed(dec);
+      let formattedString;
+      if(autoFormat) {
+        formattedString = randValue.toLocaleString(undefined, {minimumFractionDigits: dec});
+      }
+      else {
+        formattedString = randValue.toFixed(dec);
+      }
+
+      return symbol + formattedString;
   };
 
   /**
@@ -162,7 +169,7 @@ var Finance = function (faker) {
    * @method  faker.finance.bitcoinAddress
    */
   self.bitcoinAddress = function () {
-    var addressLength = faker.random.number({ min: 25, max: 34 });
+    var addressLength = faker.datatype.number({ min: 25, max: 34 });
 
     var address = faker.random.arrayElement(['1', '3']);
 
@@ -178,7 +185,7 @@ var Finance = function (faker) {
  * @method  faker.finance.litecoinAddress
  */
 self.litecoinAddress = function () {
-  var addressLength = faker.random.number({ min: 26, max: 33 });
+  var addressLength = faker.datatype.number({ min: 26, max: 33 });
 
   var address = faker.random.arrayElement(['L', 'M', '3']);
 
@@ -229,7 +236,7 @@ self.litecoinAddress = function () {
   self.creditCardCVV = function() {
     var cvv = "";
     for (var i = 0; i < 3; i++) {
-      cvv += faker.random.number({max:9}).toString();
+      cvv += faker.datatype.number({max:9}).toString();
     }
     return cvv;
   };
@@ -240,18 +247,32 @@ self.litecoinAddress = function () {
    * @method  faker.finance.ethereumAddress
    */
   self.ethereumAddress = function () {
-    var address = faker.random.hexaDecimal(40).toLowerCase();
-
+    var address = faker.datatype.hexaDecimal(40).toLowerCase();
     return address;
   };
 
   /**
    * iban
    *
+   * @param {boolean} [formatted=false] - Return a formatted version of the generated IBAN.
+   * @param {string} [countryCode] - The country code from which you want to generate an IBAN, if none is provided a random country will be used.
+   * @throws Will throw an error if the passed country code is not supported.
+   *
    * @method  faker.finance.iban
    */
-  self.iban = function (formatted) {
-      var ibanFormat = faker.random.arrayElement(ibanLib.formats);
+  self.iban = function (formatted, countryCode) {
+      var ibanFormat;
+      if (countryCode) {
+          var findFormat = function(currentFormat) { return currentFormat.country === countryCode; };
+          ibanFormat = ibanLib.formats.find(findFormat);
+      } else {
+          ibanFormat = faker.random.arrayElement(ibanLib.formats);
+      }
+
+      if (!ibanFormat) {
+          throw new Error('Country code ' + countryCode + ' not supported.');
+      }
+
       var s = "";
       var count = 0;
       for (var b = 0; b < ibanFormat.bban.length; b++) {
@@ -262,14 +283,14 @@ self.litecoinAddress = function () {
               if (bban.type == "a") {
                   s += faker.random.arrayElement(ibanLib.alpha);
               } else if (bban.type == "c") {
-                  if (faker.random.number(100) < 80) {
-                      s += faker.random.number(9);
+                  if (faker.datatype.number(100) < 80) {
+                      s += faker.datatype.number(9);
                   } else {
                       s += faker.random.arrayElement(ibanLib.alpha);
                   }
               } else {
-                  if (c >= 3 && faker.random.number(100) < 30) {
-                      if (faker.random.boolean()) {
+                  if (c >= 3 && faker.datatype.number(100) < 30) {
+                      if (faker.datatype.boolean()) {
                           s += faker.random.arrayElement(ibanLib.pattern100);
                           c -= 2;
                       } else {
@@ -277,7 +298,7 @@ self.litecoinAddress = function () {
                           c--;
                       }
                   } else {
-                      s += faker.random.number(9);
+                      s += faker.datatype.number(9);
                   }
               }
               c--;
@@ -299,7 +320,7 @@ self.litecoinAddress = function () {
    */
   self.bic = function () {
       var vowels = ["A", "E", "I", "O", "U"];
-      var prob = faker.random.number(100);
+      var prob = faker.datatype.number(100);
       return Helpers.replaceSymbols("???") +
           faker.random.arrayElement(vowels) +
           faker.random.arrayElement(ibanLib.iso3166) +
@@ -316,14 +337,15 @@ self.litecoinAddress = function () {
    * @method  faker.finance.transactionDescription
    */
   self.transactionDescription = function() {
-    var account = Helpers.createTransaction().account
+    var transaction = Helpers.createTransaction();
+    var account = transaction.account;
+    var amount = transaction.amount;
+    var transactionType = transaction.type;
+    var company = transaction.business;
     var card = faker.finance.mask();
     var currency = faker.finance.currencyCode();
-    var amount = Helpers.createTransaction().amount
-    var transactionType = Helpers.createTransaction().type
-    var company = Helpers.createTransaction().business
     return transactionType + " transaction at " + company + " using card ending with ***" + card + " for " + currency + " " + amount + " in account ***" + account
-  }
+  };
 
 };
 

package/lib/git.js

@@ -30,7 +30,7 @@ var Git = function(faker) {
 
     var entry = 'commit {{git.commitSha}}\r\n';
 
-    if (options.merge || (faker.random.number({ min: 0, max: 4 }) === 0)) {
+    if (options.merge || (faker.datatype.number({ min: 0, max: 4 }) === 0)) {
       entry += 'Merge: {{git.shortSha}} {{git.shortSha}}\r\n';
     }
 

package/lib/helpers.js

@@ -25,7 +25,7 @@ var Helpers = function (faker) {
    */
   self.slugify = function (string) {
       string = string || "";
-      return string.replace(/ /g, '-').replace(/[^\w\.\-]+/g, '');
+      return string.replace(/ /g, '-').replace(/[^\一-龠\ぁ-ゔ\ァ-ヴー\w\.\-]+/g, '');
   };
 
   /**
@@ -45,9 +45,9 @@ var Helpers = function (faker) {
       var str = '';
       for (var i = 0; i < string.length; i++) {
           if (string.charAt(i) == symbol) {
-              str += faker.random.number(9);
+              str += faker.datatype.number(9);
           } else if (string.charAt(i) == "!"){
-              str += faker.random.number({min: 2, max: 9});
+              str += faker.datatype.number({min: 2, max: 9});
           } else {
               str += string.charAt(i);
           }
@@ -69,11 +69,11 @@ var Helpers = function (faker) {
 
       for (var i = 0; i < string.length; i++) {
           if (string.charAt(i) == "#") {
-              str += faker.random.number(9);
+              str += faker.datatype.number(9);
           } else if (string.charAt(i) == "?") {
               str += faker.random.arrayElement(alpha);
           } else if (string.charAt(i) == "*") {
-            str += faker.random.boolean() ? faker.random.arrayElement(alpha) : faker.random.number(9);
+            str += faker.datatype.boolean() ? faker.random.arrayElement(alpha) : faker.datatype.number(9);
           } else {
               str += string.charAt(i);
           }
@@ -161,7 +161,7 @@ var Helpers = function (faker) {
          max = min;
          min = tmp;
        }
-       repetitions = faker.random.number({min:min,max:max});
+       repetitions = faker.datatype.number({min:min,max:max});
        string = string.slice(0,token.index) + faker.helpers.repeatString(token[1], repetitions) + string.slice(token.index+token[0].length);
        token = string.match(RANGE_REP_REG);
      }
@@ -186,7 +186,7 @@ var Helpers = function (faker) {
          min = tmp;
        }
         string = string.slice(0,token.index) +
-          faker.random.number({min:min, max:max}).toString() +
+          faker.datatype.number({min:min, max:max}).toString() +
           string.slice(token.index+token[0].length);
         token = string.match(RANGE_REG);
      }
@@ -207,7 +207,7 @@ var Helpers = function (faker) {
       }
       o = o || ["a", "b", "c"];
       for (var x, j, i = o.length - 1; i > 0; --i) {
-        j = faker.random.number(i);
+        j = faker.datatype.number(i);
         x = o[i];
         o[i] = o[j];
         o[j] = x;