Merge pull request #684 from blslade-neumont/dev-gender-string

Allowed gender passed to name.firstName(gender) to be a string
mrlynn · Aug 24, 2020 · 3bbac5d · 3bbac5d
2 parents a0a8850 + b3fcea2
commit 3bbac5d
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/lib/name.js b/lib/name.js
@@ -15,6 +15,16 @@ function Name (faker) {
     if (typeof faker.definitions.name.male_first_name !== "undefined" && typeof faker.definitions.name.female_first_name !== "undefined") {
       // some locale datasets ( like ru ) have first_name split by gender. since the name.first_name field does not exist in these datasets,
       // we must randomly pick a name from either gender array so faker.name.firstName will return the correct locale data ( and not fallback )
+
+      if(typeof gender === 'string') {
+        if(gender.toLowerCase() === 'male') {
+          gender = 0;
+        }
+        else if(gender.toLowerCase() === 'female') {
+          gender = 1;
+        }
+      }
+
       if (typeof gender !== 'number') {
         if(typeof faker.definitions.name.first_name === "undefined") {
           gender = faker.random.number(1);

diff --git a/test/name.unit.js b/test/name.unit.js
@@ -5,6 +5,11 @@ if (typeof module !== 'undefined') {
 
 }
 
+function assertInArray(value, array) {
+    var idx = array.indexOf(value);
+    assert.notEqual(idx, -1);
+}
+
 describe("name.js", function () {
     describe("firstName()", function () {
         it("returns a random name", function () {
@@ -15,6 +20,24 @@ describe("name.js", function () {
 
             faker.name.firstName.restore();
         });
+
+        it("returns a gender-specific name when passed a number", function () {
+            for (var q = 0; q < 30; q++) {
+                var gender = Math.floor(Math.random() * 2);
+                var name = faker.name.firstName(gender);
+                if (gender === 0) assertInArray(name, faker.definitions.name.male_first_name);
+                else assertInArray(name, faker.definitions.name.female_first_name);
+            }
+        });
+
+        it("returns a gender-specific name when passed a string", function () {
+            for (var q = 0; q < 30; q++) {
+                var gender = Math.floor(Math.random() * 2);
+                var genderString = (gender === 0 ? 'male' : 'female');
+                var name = faker.name.firstName(genderString);
+                assertInArray(name, faker.definitions.name[genderString + '_first_name']);
+            }
+        });
     });
 
     describe("lastName()", function () {