feat(animal): add petName method (#3196)

Author: suyashgulati

src/definitions/animal.ts

@@ -19,4 +19,5 @@ export type AnimalDefinition = LocaleEntry<{
   rodent: string[];
   snake: string[];
   type: string[];
+  pet_name: string[];
 }>;

src/locales/en/animal/index.ts

@@ -14,6 +14,7 @@ import fish from './fish';
 import horse from './horse';
 import insect from './insect';
 import lion from './lion';
+import pet_name from './pet_name';
 import rabbit from './rabbit';
 import rodent from './rodent';
 import snake from './snake';
@@ -31,6 +32,7 @@ const animal: AnimalDefinition = {
   horse,
   insect,
   lion,
+  pet_name,
   rabbit,
   rodent,
   snake,

src/locales/en/animal/pet_name.ts

@@ -0,0 +1,44 @@
+export default [
+  'Ace',
+  'Archie',
+  'Bailey',
+  'Bandit',
+  'Bella',
+  'Bentley',
+  'Bruno',
+  'Buddy',
+  'Charlie',
+  'Coco',
+  'Cookie',
+  'Cooper',
+  'Daisy',
+  'Dixie',
+  'Finn',
+  'Ginger',
+  'Gracie',
+  'Gus',
+  'Hank',
+  'Jack',
+  'Jax',
+  'Joey',
+  'Kobe',
+  'Leo',
+  'Lola',
+  'Louie',
+  'Lucy',
+  'Maggie',
+  'Max',
+  'Mia',
+  'Milo',
+  'Molly',
+  'Murphey',
+  'Nala',
+  'Nova',
+  'Ollie',
+  'Oreo',
+  'Rosie',
+  'Scout',
+  'Stella',
+  'Teddy',
+  'Tuffy',
+];

src/modules/animal/index.ts

@@ -201,4 +201,18 @@ export class AnimalModule extends ModuleBase {
   type(): string {
     return this.faker.helpers.arrayElement(this.faker.definitions.animal.type);
   }
+
+  /**
+   * Returns a random pet name.
+   *
+   * @example
+   * faker.animal.petName() // 'Coco'
+   *
+   * @since 9.2.0
+   */
+  petName(): string {
+    return this.faker.helpers.arrayElement(
+      this.faker.definitions.animal.pet_name
+    );
+  }
 }

test/modules/__snapshots__/animal.spec.ts.snap

@@ -22,6 +22,8 @@ exports[`animal > 42 > insect 1`] = `"Gouty oak gall"`;
 
 exports[`animal > 42 > lion 1`] = `"Cape lion"`;
 
+exports[`animal > 42 > petName 1`] = `"Ginger"`;
+
 exports[`animal > 42 > rabbit 1`] = `"English Spot"`;
 
 exports[`animal > 42 > rodent 1`] = `"Famatina chinchilla rat"`;
@@ -52,6 +54,8 @@ exports[`animal > 1211 > insect 1`] = `"Western paper wasp"`;
 
 exports[`animal > 1211 > lion 1`] = `"West African Lion"`;
 
+exports[`animal > 1211 > petName 1`] = `"Scout"`;
+
 exports[`animal > 1211 > rabbit 1`] = `"Silver Marten"`;
 
 exports[`animal > 1211 > rodent 1`] = `"Strong tuco-tuco"`;
@@ -82,6 +86,8 @@ exports[`animal > 1337 > insect 1`] = `"Erythrina gall wasp"`;
 
 exports[`animal > 1337 > lion 1`] = `"Barbary Lion"`;
 
+exports[`animal > 1337 > petName 1`] = `"Cooper"`;
+
 exports[`animal > 1337 > rabbit 1`] = `"Cinnamon"`;
 
 exports[`animal > 1337 > rodent 1`] = `"Crested porcupine"`;

test/modules/animal.spec.ts

@@ -22,7 +22,8 @@ describe('animal', () => {
       'rabbit',
       'rodent',
       'snake',
-      'type'
+      'type',
+      'petName'
     );
   });
 
@@ -133,6 +134,13 @@ describe('animal', () => {
           expect(faker.definitions.animal.type).toContain(actual);
         });
       });
+
+      describe('petName()', () => {
+        it('should return random value from pet name array', () => {
+          const actual = faker.animal.petName();
+          expect(faker.definitions.animal.pet_name).toContain(actual);
+        });
+      });
     }
   );
 });