diff options
| author | Marak <[email protected]> | 2015-07-08 23:56:22 -0700 |
|---|---|---|
| committer | Marak <[email protected]> | 2015-07-08 23:56:22 -0700 |
| commit | 4c1b454b8e3c8d87f2569a2ce0d7730dc31ee821 (patch) | |
| tree | 6fcbdb8eee0a7365c78043008c8dd5b6a51d39c5 /lib | |
| parent | edb7d482a40e98ce25cd6ba296818be14f291aa1 (diff) | |
| download | faker-4c1b454b8e3c8d87f2569a2ce0d7730dc31ee821.tar.xz faker-4c1b454b8e3c8d87f2569a2ce0d7730dc31ee821.zip | |
[api] [refactor] Rename `array_element` and `object_element` to camelCase. Set default max random number to 99999. Added default arguments to some methods.
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/address.js | 22 | ||||
| -rw-r--r-- | lib/commerce.js | 12 | ||||
| -rw-r--r-- | lib/company.js | 14 | ||||
| -rw-r--r-- | lib/finance.js | 6 | ||||
| -rw-r--r-- | lib/hacker.js | 12 | ||||
| -rw-r--r-- | lib/helpers.js | 12 | ||||
| -rw-r--r-- | lib/image.js | 2 | ||||
| -rw-r--r-- | lib/internet.js | 12 | ||||
| -rw-r--r-- | lib/name.js | 28 | ||||
| -rw-r--r-- | lib/phone_number.js | 2 | ||||
| -rw-r--r-- | lib/random.js | 70 |
11 files changed, 95 insertions, 97 deletions
diff --git a/lib/address.js b/lib/address.js index a921903f..c0a64f69 100644 --- a/lib/address.js +++ b/lib/address.js @@ -9,7 +9,7 @@ function Address (faker) { if (typeof localeFormat === 'string') { format = localeFormat; } else { - format = faker.random.array_element(localeFormat); + format = faker.random.arrayElement(localeFormat); } } return Helpers.replaceSymbols(format); @@ -32,11 +32,11 @@ function Address (faker) { } this.cityPrefix = function () { - return faker.random.array_element(faker.definitions.address.city_prefix); + return faker.random.arrayElement(faker.definitions.address.city_prefix); } this.citySuffix = function () { - return faker.random.array_element(faker.definitions.address.city_suffix); + return faker.random.arrayElement(faker.definitions.address.city_suffix); } this.streetName = function () { @@ -73,15 +73,15 @@ function Address (faker) { } this.streetSuffix = function () { - return faker.random.array_element(faker.definitions.address.street_suffix); + return faker.random.arrayElement(faker.definitions.address.street_suffix); } this.streetPrefix = function () { - return faker.random.array_element(faker.definitions.address.street_prefix); + return faker.random.arrayElement(faker.definitions.address.street_prefix); } this.secondaryAddress = function () { - return Helpers.replaceSymbolWithNumber(faker.random.array_element( + return Helpers.replaceSymbolWithNumber(faker.random.arrayElement( [ 'Apt. ###', 'Suite ###' @@ -90,23 +90,23 @@ function Address (faker) { } this.county = function () { - return faker.random.array_element(faker.definitions.address.county); + return faker.random.arrayElement(faker.definitions.address.county); } this.country = function () { - return faker.random.array_element(faker.definitions.address.country); + return faker.random.arrayElement(faker.definitions.address.country); } this.countryCode = function () { - return faker.random.array_element(faker.definitions.address.country_code); + return faker.random.arrayElement(faker.definitions.address.country_code); } this.state = function (useAbbr) { - return faker.random.array_element(faker.definitions.address.state); + return faker.random.arrayElement(faker.definitions.address.state); } this.stateAbbr = function () { - return faker.random.array_element(faker.definitions.address.state_abbr); + return faker.random.arrayElement(faker.definitions.address.state_abbr); } this.latitude = function () { diff --git a/lib/commerce.js b/lib/commerce.js index 276f1698..ec91edb1 100644 --- a/lib/commerce.js +++ b/lib/commerce.js @@ -2,12 +2,12 @@ var Commerce = function (faker) { var self = this; self.color = function() { - return faker.random.array_element(faker.definitions.commerce.color); + return faker.random.arrayElement(faker.definitions.commerce.color); }; self.department = function(max, fixedAmount) { - return faker.random.array_element(faker.definitions.commerce.department); + return faker.random.arrayElement(faker.definitions.commerce.department); /* max = max || 3; @@ -50,7 +50,7 @@ var Commerce = function (faker) { var categories = []; do { - var category = faker.random.array_element(faker.definitions.commerce.department); + var category = faker.random.arrayElement(faker.definitions.commerce.department); if(categories.indexOf(category) === -1) { categories.push(category); } @@ -72,15 +72,15 @@ var Commerce = function (faker) { */ self.productAdjective = function() { - return faker.random.array_element(faker.definitions.commerce.product_name.adjective); + return faker.random.arrayElement(faker.definitions.commerce.product_name.adjective); }; self.productMaterial = function() { - return faker.random.array_element(faker.definitions.commerce.product_name.material); + return faker.random.arrayElement(faker.definitions.commerce.product_name.material); }; self.product = function() { - return faker.random.array_element(faker.definitions.commerce.product_name.product); + return faker.random.arrayElement(faker.definitions.commerce.product_name.product); } return self; diff --git a/lib/company.js b/lib/company.js index d0f74357..f9fb0de3 100644 --- a/lib/company.js +++ b/lib/company.js @@ -24,7 +24,7 @@ var Company = function (faker) { } this.companySuffix = function () { - return faker.random.array_element(faker.company.suffixes()); + return faker.random.arrayElement(faker.company.suffixes()); } this.catchPhrase = function () { @@ -36,27 +36,27 @@ var Company = function (faker) { } this.catchPhraseAdjective = function () { - return faker.random.array_element(faker.definitions.company.adjective); + return faker.random.arrayElement(faker.definitions.company.adjective); } this.catchPhraseDescriptor = function () { - return faker.random.array_element(faker.definitions.company.descriptor); + return faker.random.arrayElement(faker.definitions.company.descriptor); } this.catchPhraseNoun = function () { - return faker.random.array_element(faker.definitions.company.noun); + return faker.random.arrayElement(faker.definitions.company.noun); } this.bsAdjective = function () { - return faker.random.array_element(faker.definitions.company.bs_adjective); + return faker.random.arrayElement(faker.definitions.company.bs_adjective); } this.bsBuzz = function () { - return faker.random.array_element(faker.definitions.company.bs_verb); + return faker.random.arrayElement(faker.definitions.company.bs_verb); } this.bsNoun = function () { - return faker.random.array_element(faker.definitions.company.bs_noun); + return faker.random.arrayElement(faker.definitions.company.bs_noun); } } diff --git a/lib/finance.js b/lib/finance.js index 89f5e285..0140cd19 100644 --- a/lib/finance.js +++ b/lib/finance.js @@ -66,18 +66,18 @@ var Finance = function (faker) { } self.currencyCode = function () { - return faker.random.object_element(faker.definitions.finance.currency)['code']; + return faker.random.objectElement(faker.definitions.finance.currency)['code']; } self.currencyName = function () { - return faker.random.object_element(faker.definitions.finance.currency, 'key'); + return faker.random.objectElement(faker.definitions.finance.currency, 'key'); } self.currencySymbol = function () { var symbol; while (!symbol) { - symbol = faker.random.object_element(faker.definitions.finance.currency)['symbol']; + symbol = faker.random.objectElement(faker.definitions.finance.currency)['symbol']; } return symbol; } diff --git a/lib/hacker.js b/lib/hacker.js index 7aba150e..463f8331 100644 --- a/lib/hacker.js +++ b/lib/hacker.js @@ -2,23 +2,23 @@ var Hacker = function (faker) { var self = this; self.abbreviation = function () { - return faker.random.array_element(faker.definitions.hacker.abbreviation); + return faker.random.arrayElement(faker.definitions.hacker.abbreviation); }; self.adjective = function () { - return faker.random.array_element(faker.definitions.hacker.adjective); + return faker.random.arrayElement(faker.definitions.hacker.adjective); }; self.noun = function () { - return faker.random.array_element(faker.definitions.hacker.noun); + return faker.random.arrayElement(faker.definitions.hacker.noun); }; self.verb = function () { - return faker.random.array_element(faker.definitions.hacker.verb); + return faker.random.arrayElement(faker.definitions.hacker.verb); }; self.ingverb = function () { - return faker.random.array_element(faker.definitions.hacker.ingverb); + return faker.random.arrayElement(faker.definitions.hacker.ingverb); }; self.phrase = function () { @@ -31,7 +31,7 @@ var Hacker = function (faker) { verb: self.verb() }; - var phrase = faker.random.array_element([ "If we {{verb}} the {{noun}}, we can get to the {{abbreviation}} {{noun}} through the {{adjective}} {{abbreviation}} {{noun}}!", + var phrase = faker.random.arrayElement([ "If we {{verb}} the {{noun}}, we can get to the {{abbreviation}} {{noun}} through the {{adjective}} {{abbreviation}} {{noun}}!", "We need to {{verb}} the {{adjective}} {{abbreviation}} {{noun}}!", "Try to {{verb}} the {{abbreviation}} {{noun}}, maybe it will {{verb}} the {{adjective}} {{noun}}!", "You can't {{verb}} the {{noun}} without {{ingverb}} the {{adjective}} {{abbreviation}} {{noun}}!", diff --git a/lib/helpers.js b/lib/helpers.js index d59cd241..ec8e1573 100644 --- a/lib/helpers.js +++ b/lib/helpers.js @@ -1,16 +1,11 @@ var Helpers = function (faker) { - + var self = this; - - // backword-compatibility - self.randomNumber = function (range) { - return faker.random.number(range); - }; // backword-compatibility self.randomize = function (array) { array = array || ["a", "b", "c"]; - return faker.random.array_element(array); + return faker.random.arrayElement(array); }; // slugifies string @@ -64,6 +59,9 @@ var Helpers = function (faker) { }; self.mustache = function (str, data) { + if (typeof str === 'undefined') { + return ''; + } for(var p in data) { var re = new RegExp('{{' + p + '}}', 'g') str = str.replace(re, data[p]); diff --git a/lib/image.js b/lib/image.js index e791ffea..01f7f5cb 100644 --- a/lib/image.js +++ b/lib/image.js @@ -4,7 +4,7 @@ var Image = function (faker) { self.image = function () { var categories = ["abstract", "animals", "business", "cats", "city", "food", "nightlife", "fashion", "people", "nature", "sports", "technics", "transport"]; - return self[faker.random.array_element(categories)](); + return self[faker.random.arrayElement(categories)](); }; self.avatar = function () { return faker.internet.avatar(); diff --git a/lib/internet.js b/lib/internet.js index fd9fd877..2663ce5c 100644 --- a/lib/internet.js +++ b/lib/internet.js @@ -4,11 +4,11 @@ var password_generator = require('../vendor/password-generator.js'), var Internet = function (faker) { var self = this; self.avatar = function () { - return faker.random.array_element(faker.definitions.internet.avatar_uri); + return faker.random.arrayElement(faker.definitions.internet.avatar_uri); }; self.email = function (firstName, lastName, provider) { - provider = provider || faker.random.array_element(faker.definitions.internet.free_email); + provider = provider || faker.random.arrayElement(faker.definitions.internet.free_email); return faker.helpers.slugify(faker.internet.userName(firstName, lastName)) + "@" + provider; }; @@ -21,10 +21,10 @@ var Internet = function (faker) { result = firstName + faker.random.number(99); break; case 1: - result = firstName + faker.random.array_element([".", "_"]) + lastName; + result = firstName + faker.random.arrayElement([".", "_"]) + lastName; break; case 2: - result = firstName + faker.random.array_element([".", "_"]) + lastName + faker.random.number(99); + result = firstName + faker.random.arrayElement([".", "_"]) + lastName + faker.random.number(99); break; } result = result.toString().replace(/'/g, ""); @@ -34,7 +34,7 @@ var Internet = function (faker) { self.protocol = function () { var protocols = ['http','https']; - return faker.random.array_element(protocols); + return faker.random.arrayElement(protocols); }; self.url = function () { @@ -46,7 +46,7 @@ var Internet = function (faker) { }; self.domainSuffix = function () { - return faker.random.array_element(faker.definitions.internet.domain_suffix); + return faker.random.arrayElement(faker.definitions.internet.domain_suffix); }; self.domainWord = function () { diff --git a/lib/name.js b/lib/name.js index 5f1c577f..ae1b05b9 100644 --- a/lib/name.js +++ b/lib/name.js @@ -8,12 +8,12 @@ function Name (faker) { gender = faker.random.number(1); } if (gender === 0) { - return faker.random.array_element(faker.locales[faker.locale].name.male_first_name) + return faker.random.arrayElement(faker.locales[faker.locale].name.male_first_name) } else { - return faker.random.array_element(faker.locales[faker.locale].name.female_first_name); + return faker.random.arrayElement(faker.locales[faker.locale].name.female_first_name); } } - return faker.random.array_element(faker.definitions.name.first_name); + return faker.random.arrayElement(faker.definitions.name.first_name); }; this.lastName = function (gender) { @@ -24,12 +24,12 @@ function Name (faker) { gender = faker.random.number(1); } if (gender === 0) { - return faker.random.array_element(faker.locales[faker.locale].name.male_last_name); + return faker.random.arrayElement(faker.locales[faker.locale].name.male_last_name); } else { - return faker.random.array_element(faker.locales[faker.locale].name.female_last_name); + return faker.random.arrayElement(faker.locales[faker.locale].name.female_last_name); } } - return faker.random.array_element(faker.definitions.name.last_name); + return faker.random.arrayElement(faker.definitions.name.last_name); }; this.findName = function (firstName, lastName, gender) { @@ -65,31 +65,31 @@ function Name (faker) { }; this.prefix = function () { - return faker.random.array_element(faker.definitions.name.prefix); + return faker.random.arrayElement(faker.definitions.name.prefix); }; this.suffix = function () { - return faker.random.array_element(faker.definitions.name.suffix); + return faker.random.arrayElement(faker.definitions.name.suffix); }; this.title = function() { - var descriptor = faker.random.array_element(faker.definitions.name.title.descriptor), - level = faker.random.array_element(faker.definitions.name.title.level), - job = faker.random.array_element(faker.definitions.name.title.job); + var descriptor = faker.random.arrayElement(faker.definitions.name.title.descriptor), + level = faker.random.arrayElement(faker.definitions.name.title.level), + job = faker.random.arrayElement(faker.definitions.name.title.job); return descriptor + " " + level + " " + job; }; this.jobDescriptor = function () { - return faker.random.array_element(faker.definitions.name.title.descriptor); + return faker.random.arrayElement(faker.definitions.name.title.descriptor); }; this.jobArea = function () { - return faker.random.array_element(faker.definitions.name.title.level); + return faker.random.arrayElement(faker.definitions.name.title.level); }; this.jobType = function () { - return faker.random.array_element(faker.definitions.name.title.job); + return faker.random.arrayElement(faker.definitions.name.title.job); }; } diff --git a/lib/phone_number.js b/lib/phone_number.js index f683832c..4489ea22 100644 --- a/lib/phone_number.js +++ b/lib/phone_number.js @@ -13,7 +13,7 @@ var Phone = function (faker) { }; self.phoneFormats = function () { - return faker.random.array_element(faker.definitions.phone_number.formats); + return faker.random.arrayElement(faker.definitions.phone_number.formats); }; return self; diff --git a/lib/random.js b/lib/random.js index 7d592849..2d37c551 100644 --- a/lib/random.js +++ b/lib/random.js @@ -5,50 +5,50 @@ function Random (faker) { // returns a single random number based on a max number or range 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 = 1; - } - 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 = options.precision * Math.floor( - mersenne.rand(max / options.precision, options.min / options.precision)); - - return randomNumber; + 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 = options.precision * Math.floor( + mersenne.rand(max / options.precision, options.min / options.precision)); + + return randomNumber; } - + // takes an array and returns a random element of the array - this.array_element = function (array) { + this.arrayElement = function (array) { array = array || ["a", "b", "c"]; var r = faker.random.number({ max: array.length - 1 }); return array[r]; } // takes an object and returns the randomly key or value - this.object_element = function (object, field) { - object = object || {}; + this.objectElement = function (object, field) { + object = object || { "foo": "bar", "too": "car" }; var array = Object.keys(object); - var key = faker.random.array_element(array); + var key = faker.random.arrayElement(array); return field === "key" ? key : object[key]; } @@ -68,7 +68,7 @@ function Random (faker) { } return this; - + } module['exports'] = Random; |
