Merge pull request #37 from BryanDonovan/main

Refactored with 100% test coverage

1 files changed, 323 insertions, 266 deletions

diff --git a/examples/js/Faker.js b/examples/js/Faker.js
index 0b6ddd86..c19abf89 100644
--- a/examples/js/Faker.js
+++ b/examples/js/Faker.js
@@ -17,7 +17,7 @@ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
-/*************** AUTOGENERATED @ 1357629912809 ***************
+/*************** AUTOGENERATED @ 1357666154263 ***************
     WARNING: THIS FILE WAS AUTOGENERATED BY THE FAKER BUILD SCRIPT
     MODIFYING THIS FILE IS FINE, BUT YOU REALLY SHOULD BE MODIFYING
     THE LIBRARY DIRECTLY AND REGENERATING THIS FILE USING BUILD.js!!!!
@@ -42,346 +42,403 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 var Faker = {};
 Faker.version = "0.5.5";
 Faker.Name = {};
-Faker.Name.findName = function () {
-	var r = Helpers.randomNumber(8);
-	switch (r) {
-		case 0:
-			return Helpers.randomize(definitions.name_prefix()) + " " + Helpers.randomize(definitions.first_name()) + " " + Helpers.randomize(definitions.last_name());
-			break;
-		case 1:
-			return Helpers.randomize(definitions.first_name()) + " " + Helpers.randomize(definitions.last_name()) +" " + Helpers.randomize(definitions.name_suffix);
-			break;
-	}
-
-	return Helpers.randomize(definitions.first_name()) + " " + Helpers.randomize(definitions.last_name());
-
-};
-
 Faker.Name.firstName = function () {
-	return Helpers.randomize(definitions.first_name());
-};
+        return Faker.random.first_name();
+    };
 
 Faker.Name.lastName = function () {
-	return Helpers.randomize(definitions.last_name());
-};
+        return Faker.random.last_name();
+    };
+
+Faker.Name.findName = function () {
+        var r = Faker.random.number(8);
+        switch (r) {
+        case 0:
+            return Faker.random.name_prefix() + " " + this.firstName() + " " + this.lastName();
+        case 1:
+            return this.firstName() + " " + this.lastName() + " " + Faker.random.name_suffix();
+        }
+
+        return this.firstName() + " " + this.lastName();
+    };
 
 Faker.Address = {};
 Faker.Address.zipCode = function () {
-	return Helpers.replaceSymbolWithNumber(Helpers.randomize(["#####", '#####-####']));
-};
+        return Helpers.replaceSymbolWithNumber(Faker.random.array_element(["#####", '#####-####']));
+    };
 
 Faker.Address.zipCodeFormat = function (format) {
-	return Helpers.replaceSymbolWithNumber(["#####", '#####-####'][format]);
-};
+        return Helpers.replaceSymbolWithNumber(["#####", '#####-####'][format]);
+    };
 
 Faker.Address.city = function () {
-	var ret;
-	switch (Helpers.randomNumber(3)) {
-		case 0:
-			ret = Helpers.randomize(definitions.city_prefix()) + " " + Helpers.randomize(definitions.first_name()) + Helpers.randomize(definitions.city_suffix());
-			break;
-		case 1:
-			ret = Helpers.randomize(definitions.city_prefix()) + " " + Helpers.randomize(definitions.first_name());
-			break;
-		case 2:
-			ret = Helpers.randomize(definitions.first_name()) + Helpers.randomize(definitions.city_suffix());
-			break;
-		case 3:
-			ret = Helpers.randomize(definitions.last_name()) + Helpers.randomize(definitions.city_suffix());
-			break;
-	}
-	return ret;
-};
+        switch (Faker.random.number(3)) {
+        case 0:
+            return Faker.random.city_prefix() + " " + Faker.random.first_name() + Faker.random.city_suffix();
+        case 1:
+            return Faker.random.city_prefix() + " " + Faker.random.first_name();
+        case 2:
+            return Faker.random.first_name() + Faker.random.city_suffix();
+        case 3:
+            return Faker.random.last_name() + Faker.random.city_suffix();
+        }
+    };
 
 Faker.Address.streetName = function () {
-	var ret;
-  switch(Helpers.randomNumber(1)) {
-  case 0:
-   ret = Helpers.randomize(definitions.last_name()) + " " + Helpers.randomize(definitions.street_suffix());
-   break;
-  case 1:
-   ret = Helpers.randomize(definitions.first_name()) + " " + Helpers.randomize(definitions.street_suffix());
-   break;
-  }
-  return ret;
-};
-
-Faker.Address.streetAddress = function (i) {
-  if( typeof i == 'undefined'){ var i = false;}
-  var address = "";
-  switch(Helpers.randomNumber(2))
-    {
-    case 0:
-     address =  Helpers.replaceSymbolWithNumber("#####") + " " + this.streetName();
-     break;
-    case 1:
-     address = Helpers.replaceSymbolWithNumber("####") +  " " + this.streetName();
-     break;
-    case 2:
-     address = Helpers.replaceSymbolWithNumber("###") + " " + this.streetName();
-     break;
-    }
-  var full_address = i ?  address + " " + this.secondaryAddress() : address;
-  return full_address;
-};
+        switch (Faker.random.number(1)) {
+        case 0:
+            return Faker.random.last_name() + " " + Faker.random.street_suffix();
+        case 1:
+            return Faker.random.first_name() + " " + Faker.random.street_suffix();
+        }
+    };
+
+Faker.Address.streetAddress = function (useFullAddress) {
+        if (useFullAddress === undefined) { useFullAddress = false; }
+        var address = "";
+        switch (Faker.random.number(2)) {
+        case 0:
+            address = Helpers.replaceSymbolWithNumber("#####") + " " + this.streetName();
+            break;
+        case 1:
+            address = Helpers.replaceSymbolWithNumber("####") +  " " + this.streetName();
+            break;
+        case 2:
+            address = Helpers.replaceSymbolWithNumber("###") + " " + this.streetName();
+            break;
+        }
+        return useFullAddress ? (address + " " + this.secondaryAddress()) : address;
+    };
 
 Faker.Address.secondaryAddress = function () {
-	return Helpers.replaceSymbolWithNumber(Helpers.randomize(
-		[
-			'Apt. ###',
-			'Suite ###'
-		]
-	)
-	);
-};
-
-Faker.Address.brState = function (abbr) {
-	return Helpers.randomize(definitions[ abbr ? 'br_state_abbr' : 'br_state']());
-};
+        return Helpers.replaceSymbolWithNumber(Faker.random.array_element(
+            [
+                'Apt. ###',
+                'Suite ###'
+            ]
+        ));
+    };
+
+Faker.Address.brState = function (useAbbr) {
+        return useAbbr ? Faker.random.br_state_abbr() : Faker.random.br_state();
+    };
 
 Faker.Address.ukCounty = function () {
-	return Helpers.randomize(definitions.uk_county());
-};
+        return Faker.random.uk_county();
+    };
 
 Faker.Address.ukCountry = function () {
-	return Helpers.randomize(definitions.uk_country());
-};
+        return Faker.random.uk_country();
+    };
 
-Faker.Address.usState = function (abbr) {
-	return Helpers.randomize(definitions[ abbr ? 'us_state_abbr' : 'us_state']());
-};
+Faker.Address.usState = function (useAbbr) {
+        return useAbbr ? Faker.random.us_state_abbr() : Faker.random.us_state();
+    };
 
 Faker.PhoneNumber = {};
 Faker.PhoneNumber.phoneNumber = function () {
+        return Helpers.replaceSymbolWithNumber(Faker.random.phone_formats());
+    };
 
-	return Helpers.replaceSymbolWithNumber(Helpers.randomize(definitions.phone_formats()));
-
-};
-
-Faker.PhoneNumber.phoneNumberFormat = function (format) {
-	return Helpers.replaceSymbolWithNumber(definitions.phone_formats()[format]);
-};
+Faker.PhoneNumber.phoneNumberFormat = function (phoneFormatsArrayIndex) {
+        return Helpers.replaceSymbolWithNumber(definitions.phone_formats()[phoneFormatsArrayIndex]);
+    };
 
 Faker.Internet = {};
 Faker.Internet.email = function () {
-	return this.userName() + "@" + this.domainName();
-};
+        return this.userName() + "@" + this.domainName();
+    };
 
 Faker.Internet.userName = function () {
-	var ret;
-	switch (Helpers.randomNumber(2)) {
-		case 0:
-			ret = Helpers.randomize(definitions.first_name());
-			break;
-		case 1:
-			ret = Helpers.randomize(definitions.first_name()) + Helpers.randomize([".", "_"]) + Helpers.randomize(definitions.last_name());
-			break;
-	}
-	return ret;
-};
+        switch (Faker.random.number(2)) {
+        case 0:
+            return Faker.random.first_name();
+        case 1:
+            return Faker.random.first_name() + Faker.random.array_element([".", "_"]) + Faker.random.last_name();
+        }
+    };
 
 Faker.Internet.domainName = function () {
-	return this.domainWord() + "." + Helpers.randomize(definitions.domain_suffix());
-};
+        return this.domainWord() + "." + Faker.random.domain_suffix();
+    };
 
 Faker.Internet.domainWord = function () {
-	return Helpers.randomize(definitions.first_name()).toLowerCase();
-};
+        return Faker.random.first_name().toLowerCase();
+    };
 
 Faker.Internet.ip = function () {
-	var randNum = function() {
-		return (Math.random() * 254 + 1).toFixed(0);
-	};
+        var randNum = function () {
+            return (Math.random() * 254 + 1).toFixed(0);
+        };
 
-	var result = [];
-	for (var i = 0; i < 4; i++) {
-		result[i] = randNum();
-	}
+        var result = [];
+        for (var i = 0; i < 4; i++) {
+            result[i] = randNum();
+        }
 
-	return result.join(".");
-};
+        return result.join(".");
+    };
 
 Faker.Company = {};
+Faker.Company.suffixes = function () {
+        return ["Inc", "and Sons", "LLC", "Group", "and Daughters"];
+    };
+
 Faker.Company.companyName = function (format) {
-	switch (( format ? format : Helpers.randomNumber(3) )) {
-		case 0:
-			return Helpers.randomize(definitions.last_name()) + " " + this.companySuffix();
-			break;
-		case 1:
-			return Helpers.randomize(definitions.last_name()) + "-" + Helpers.randomize(definitions.last_name());
-			break;
-		case 2:
-			return Helpers.randomize(definitions.last_name()) + "," + Helpers.randomize(definitions.last_name()) + " and " + Helpers.randomize(definitions.last_name());
-			break;
-	}
-};
+        switch ((format ? format : Faker.random.number(3))) {
+        case 0:
+            return Faker.Name.lastName() + " " + this.companySuffix();
+        case 1:
+            return Faker.Name.lastName() + "-" + Faker.Name.lastName();
+        case 2:
+            return Faker.Name.lastName() + ", " + Faker.Name.lastName() + " and " + Faker.Name.lastName();
+        }
+    };
 
 Faker.Company.companySuffix = function () {
-	return Helpers.randomize(["Inc", "and Sons", "LLC", "Group", "and Daughters"]);
-};
+        return Faker.random.array_element(this.suffixes());
+    };
 
 Faker.Company.catchPhrase = function () {
-	return Helpers.randomize(definitions.catch_phrase_adjective()) + " " + Helpers.randomize(definitions.catch_phrase_descriptor()) + " " + Helpers.randomize(definitions.catch_phrase_noun());
-};
+        return Faker.random.catch_phrase_adjective() + " " +
+            Faker.random.catch_phrase_descriptor() + " " +
+            Faker.random.catch_phrase_noun();
+    };
 
 Faker.Company.bs = function () {
-	return Helpers.randomize(definitions.bs_adjective()) + " " + Helpers.randomize(definitions.bs_buzz()) + " " + Helpers.randomize(definitions.bs_noun());
-};
+        return Faker.random.bs_adjective() + " " +
+            Faker.random.bs_buzz() + " " +
+            Faker.random.bs_noun();
+    };
 
 Faker.Lorem = {};
 Faker.Lorem.words = function (num) {
-	if (typeof num == 'undefined') {
-		num = 3;
-	}
-	return Helpers.shuffle(definitions.lorem()).slice(0, num);
-	//Words.shuffle[0, num]
-};
+        if (typeof num == 'undefined') { num = 3; }
+        return Helpers.shuffle(definitions.lorem()).slice(0, num);
+    };
 
 Faker.Lorem.sentence = function (wordCount) {
-	if (typeof wordCount == 'undefined') {
-		wordCount = 3;
-	}
+        if (typeof wordCount == 'undefined') { wordCount = 3; }
 
-	// strange issue with the node_min_test failing for captialize, please fix and add this back
-	//return  this.words(wordCount + Helpers.randomNumber(7)).join(' ').capitalize();
+        // strange issue with the node_min_test failing for captialize, please fix and add this back
+        //return  this.words(wordCount + Helpers.randomNumber(7)).join(' ').capitalize();
 
-	return  this.words(wordCount + Helpers.randomNumber(7)).join(' ');
-};
+        return  this.words(wordCount + Faker.random.number(7)).join(' ');
+    };
 
 Faker.Lorem.sentences = function (sentenceCount) {
-	if (typeof sentenceCount == 'undefined') {
-		sentenceCount = 3;
-	}
-	var sentences = [];
-	for (sentenceCount; sentenceCount >= 0; sentenceCount--) {
-		sentences.push(this.sentence());
-	}
-	return sentences.join("\n");
-};
+        if (typeof sentenceCount == 'undefined') { sentenceCount = 3; }
+        var sentences = [];
+        for (sentenceCount; sentenceCount > 0; sentenceCount--) {
+            sentences.push(this.sentence());
+        }
+        return sentences.join("\n");
+    };
 
 Faker.Lorem.paragraph = function (sentenceCount) {
-	if (typeof sentenceCount == 'undefined') {
-		sentenceCount = 3;
-	}
-	return this.sentences(sentenceCount + Helpers.randomNumber(3));
-};
+        if (typeof sentenceCount == 'undefined') { sentenceCount = 3; }
+        return this.sentences(sentenceCount + Faker.random.number(3));
+    };
 
 Faker.Lorem.paragraphs = function (paragraphCount) {
-	if (typeof paragraphCount == 'undefined') {
-		paragraphCount = 3;
-	}
-	var paragraphs = [];
-	for (paragraphCount; paragraphCount >= 0; paragraphCount--) {
-		paragraphs.push(this.paragraph());
-	}
-	return paragraphs.join("\n \r\t");
-};
+        if (typeof paragraphCount == 'undefined') { paragraphCount = 3; }
+        var paragraphs = [];
+        for (paragraphCount; paragraphCount > 0; paragraphCount--) {
+            paragraphs.push(this.paragraph());
+        }
+        return paragraphs.join("\n \r\t");
+    };
 
 Faker.Helpers = {};
 Faker.Helpers.randomNumber = function (range) {
-	return Math.floor(Math.random() * range);
+    return Faker.random.number(range);
 };
 
 Faker.Helpers.randomize = function (array) {
-	var r = Math.floor(Math.random() * array.length);
-	return array[r];
+    return Faker.random.array_element(array);
 };
 
 Faker.Helpers.replaceSymbolWithNumber = function (string, symbol) {
+    // default symbol is '#'
+    if (symbol === undefined) {
+        symbol = '#';
+    }
 
-	// default symbol is '#'
-	if (typeof symbol == 'undefined') {
-		symbol = '#';
-	}
-
-	var str = '';
-	for (var i = 0; i < string.length; i++) {
-		if (string[i] == symbol) {
-			str += Math.floor(Math.random() * 10);
-		}
-		else {
-			str += string[i];
-		}
-	}
-	return str;
+    var str = '';
+    for (var i = 0; i < string.length; i++) {
+        if (string[i] == symbol) {
+            str += Math.floor(Math.random() * 10);
+        } else {
+            str += string[i];
+        }
+    }
+    return str;
 };
 
 Faker.Helpers.shuffle = function (o) {
-	for (var j, x, i = o.length; i; j = parseInt(Math.random() * i), x = o[--i], o[i] = o[j], o[j] = x);
-	return o;
-};
-
-Faker.Helpers.generateDataSet = function (size) {
-
+    for (var j, x, i = o.length; i; j = parseInt(Math.random() * i, 10), x = o[--i], o[i] = o[j], o[j] = x);
+    return o;
 };
 
 Faker.Helpers.createCard = function () {
-
-	return {
-		"name": Faker.Name.findName(),
-		"username": Faker.Internet.userName(),
-		"email": Faker.Internet.email(),
-		"address": {
-			"streetA": Faker.Address.streetName(),
-			"streetB": Faker.Address.streetAddress(),
-			"streetC": Faker.Address.streetAddress(true),
-			"streetD": Faker.Address.secondaryAddress(),
-			"city": Faker.Address.city(),
-			"ukCounty": Faker.Address.ukCounty(),
-			"ukCountry": Faker.Address.ukCountry(),
-			"zipcode": Faker.Address.zipCode()
-		},
-		"phone": Faker.PhoneNumber.phoneNumber(),
-		"website": Faker.Internet.domainName(),
-		"company": {
-			"name": Faker.Company.companyName(),
-			"catchPhrase": Faker.Company.catchPhrase(),
-			"bs": Faker.Company.bs()
-		},
-		"posts": [
-			{
-				"words": Faker.Lorem.words(),
-				"sentence": Faker.Lorem.sentence(),
-				"sentences": Faker.Lorem.sentences(),
-				"paragraph": Faker.Lorem.paragraph()
-			},
-			{
-				"words": Faker.Lorem.words(),
-				"sentence": Faker.Lorem.sentence(),
-				"sentences": Faker.Lorem.sentences(),
-				"paragraph": Faker.Lorem.paragraph()
-			},
-			{
-				"words": Faker.Lorem.words(),
-				"sentence": Faker.Lorem.sentence(),
-				"sentences": Faker.Lorem.sentences(),
-				"paragraph": Faker.Lorem.paragraph()
-			}
-		]
-	};
+    return {
+        "name": Faker.Name.findName(),
+        "username": Faker.Internet.userName(),
+        "email": Faker.Internet.email(),
+        "address": {
+            "streetA": Faker.Address.streetName(),
+            "streetB": Faker.Address.streetAddress(),
+            "streetC": Faker.Address.streetAddress(true),
+            "streetD": Faker.Address.secondaryAddress(),
+            "city": Faker.Address.city(),
+            "ukCounty": Faker.Address.ukCounty(),
+            "ukCountry": Faker.Address.ukCountry(),
+            "zipcode": Faker.Address.zipCode()
+        },
+        "phone": Faker.PhoneNumber.phoneNumber(),
+        "website": Faker.Internet.domainName(),
+        "company": {
+            "name": Faker.Company.companyName(),
+            "catchPhrase": Faker.Company.catchPhrase(),
+            "bs": Faker.Company.bs()
+        },
+        "posts": [
+            {
+                "words": Faker.Lorem.words(),
+                "sentence": Faker.Lorem.sentence(),
+                "sentences": Faker.Lorem.sentences(),
+                "paragraph": Faker.Lorem.paragraph()
+            },
+            {
+                "words": Faker.Lorem.words(),
+                "sentence": Faker.Lorem.sentence(),
+                "sentences": Faker.Lorem.sentences(),
+                "paragraph": Faker.Lorem.paragraph()
+            },
+            {
+                "words": Faker.Lorem.words(),
+                "sentence": Faker.Lorem.sentence(),
+                "sentences": Faker.Lorem.sentences(),
+                "paragraph": Faker.Lorem.paragraph()
+            }
+        ]
+    };
 };
 
 Faker.Helpers.userCard = function () {
-
-	return {
-		"name": Faker.Name.findName(),
-		"username": Faker.Internet.userName(),
-		"email": Faker.Internet.email(),
-		"address": {
-			"street": Faker.Address.streetName(true),
-			"suite": Faker.Address.secondaryAddress(),
-			"city": Faker.Address.city(),
-			"zipcode": Faker.Address.zipCode()
-		},
-		"phone": Faker.PhoneNumber.phoneNumber(),
-		"website": Faker.Internet.domainName(),
-		"company": {
-			"name": Faker.Company.companyName(),
-			"catchPhrase": Faker.Company.catchPhrase(),
-			"bs": Faker.Company.bs()
-		}
-	};
-};
+    return {
+        "name": Faker.Name.findName(),
+        "username": Faker.Internet.userName(),
+        "email": Faker.Internet.email(),
+        "address": {
+            "street": Faker.Address.streetName(true),
+            "suite": Faker.Address.secondaryAddress(),
+            "city": Faker.Address.city(),
+            "zipcode": Faker.Address.zipCode()
+        },
+        "phone": Faker.PhoneNumber.phoneNumber(),
+        "website": Faker.Internet.domainName(),
+        "company": {
+            "name": Faker.Company.companyName(),
+            "catchPhrase": Faker.Company.catchPhrase(),
+            "bs": Faker.Company.bs()
+        }
+    };
+};
+
+Faker.random = {};
+Faker.random.number = function (range) {
+        return Math.floor(Math.random() * range);
+    };
+
+Faker.random.array_element = function (array) {
+        var r = Math.floor(Math.random() * array.length);
+        return array[r];
+    };
+
+Faker.random.city_prefix = function () {
+        return this.array_element(definitions.city_prefix());
+    };
+
+Faker.random.city_suffix = function () {
+        return this.array_element(definitions.city_suffix());
+    };
+
+Faker.random.street_suffix = function () {
+        return this.array_element(definitions.street_suffix());
+    };
+
+Faker.random.br_state = function () {
+        return this.array_element(definitions.br_state());
+    };
+
+Faker.random.br_state_abbr = function () {
+        return this.array_element(definitions.br_state_abbr());
+    };
+
+Faker.random.us_state = function () {
+        return this.array_element(definitions.us_state());
+    };
+
+Faker.random.us_state_abbr = function () {
+        return this.array_element(definitions.us_state_abbr());
+    };
+
+Faker.random.uk_county = function () {
+        return this.array_element(definitions.uk_county());
+    };
+
+Faker.random.uk_country = function () {
+        return this.array_element(definitions.uk_country());
+    };
+
+Faker.random.first_name = function () {
+        return this.array_element(definitions.first_name());
+    };
+
+Faker.random.last_name = function () {
+        return this.array_element(definitions.last_name());
+    };
+
+Faker.random.name_prefix = function () {
+        return this.array_element(definitions.name_prefix());
+    };
+
+Faker.random.name_suffix = function () {
+        return this.array_element(definitions.name_suffix());
+    };
+
+Faker.random.catch_phrase_adjective = function () {
+        return this.array_element(definitions.catch_phrase_adjective());
+    };
+
+Faker.random.catch_phrase_descriptor = function () {
+        return this.array_element(definitions.catch_phrase_descriptor());
+    };
+
+Faker.random.catch_phrase_noun = function () {
+        return this.array_element(definitions.catch_phrase_noun());
+    };
+
+Faker.random.bs_adjective = function () {
+        return this.array_element(definitions.bs_adjective());
+    };
+
+Faker.random.bs_buzz = function () {
+        return this.array_element(definitions.bs_buzz());
+    };
+
+Faker.random.bs_noun = function () {
+        return this.array_element(definitions.bs_noun());
+    };
+
+Faker.random.phone_formats = function () {
+        return this.array_element(definitions.phone_formats());
+    };
+
+Faker.random.domain_suffix = function () {
+        return this.array_element(definitions.domain_suffix());
+    };
 
 Faker.definitions = {};
 Faker.definitions.first_name = function () {
@@ -548,8 +605,8 @@ Faker.definitions.phone_formats = function () {
 		'###.###.#### x#####'
 	];
 };
-var definitions = Faker.definitions; 
-var Helpers = Faker.Helpers; 
+var definitions = Faker.definitions;
+var Helpers = Faker.Helpers;
 
 if (typeof define == 'function'){
    define(function(){