Socialify

Folder ..

Viewing name.spec.ts
333 lines (264 loc) • 9.2 KB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { faker } from '../dist/cjs';

function assertInArray<T>(value: T, array: readonly T[]): void {
  const idx = array.indexOf(value);
  expect(idx).not.toBe(-1);
}

describe('name', () => {
  describe('firstName()', () => {
    it('returns a random name', () => {
      const spy_name_firstName = vi
        .spyOn(faker.name, 'firstName')
        .mockReturnValue('foo');

      const first_name = faker.name.firstName();

      expect(first_name).toBe('foo');

      spy_name_firstName.mockRestore();
    });

    it('returns a gender-specific name when passed a number', () => {
      for (let q = 0; q < 30; q++) {
        const gender = Math.floor(Math.random() * 2);
        const 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', () => {
      for (let q = 0; q < 30; q++) {
        const gender = Math.floor(Math.random() * 2);
        const genderString = gender === 0 ? 'male' : 'female';
        const name = faker.name.firstName(genderString);
        assertInArray(
          name,
          faker.definitions.name[genderString + '_first_name']
        );
      }
    });
  });

  describe('lastName()', () => {
    it('returns a random name', () => {
      const spy_name_lastName = vi
        .spyOn(faker.name, 'lastName')
        .mockReturnValue('foo');

      const last_name = faker.name.lastName();

      expect(last_name).toBe('foo');

      spy_name_lastName.mockRestore();
    });
  });

  describe('middleName()', () => {
    it('returns a random middle name', () => {
      const spy_name_middleName = vi
        .spyOn(faker.name, 'middleName')
        .mockReturnValue('foo');

      const middle_name = faker.name.middleName();

      expect(middle_name).toBe('foo');

      spy_name_middleName.mockRestore();
    });

    describe('when using a locale with gender specific middle names', () => {
      let oldLocale: string;

      beforeEach(() => {
        oldLocale = faker.locale;
        faker.locale = 'TEST';

        // @ts-expect-error
        faker.locales.TEST = {
          name: {
            male_middle_name: ['Genaddiesvich'],
            female_middle_name: ['Genaddievna'],
          },
        };
      });

      afterEach(() => {
        faker.locale = oldLocale;
        // @ts-expect-error
        delete faker.locale.TEST;
      });

      it('returns male prefix', () => {
        const middle_name = faker.name.middleName(0);

        expect(middle_name).toBe('Genaddiesvich');
      });

      it('returns female prefix', () => {
        const middle_name = faker.name.middleName(1);

        expect(middle_name).toBe('Genaddievna');
      });
    });
  });

  describe('findName()', () => {
    it('usually returns a first name and last name', () => {
      const spy_datatype_number = vi
        .spyOn(faker.datatype, 'number')
        .mockReturnValue(5);

      const name = faker.name.findName();

      expect(name).toBeTruthy();

      const parts = name.split(' ');

      expect(parts).toHaveLength(2);

      spy_datatype_number.mockRestore();
    });

    it('occasionally returns a first name and last name with a prefix', () => {
      const spy_datatype_number = vi
        .spyOn(faker.datatype, 'number')
        .mockReturnValue(0);

      const name = faker.name.findName();
      const parts = name.split(' ');

      expect(parts.length).greaterThanOrEqual(3);

      spy_datatype_number.mockRestore();
    });

    it('occasionally returns a male full name with a prefix', () => {
      const spy_datatype_number = vi
        .spyOn(faker.datatype, 'number')
        .mockImplementation((opt) =>
          opt === 8
            ? 0 // with prefix
            : opt === 1
            ? 0 // gender male
            : undefined
        );

      const spy_name_prefix = vi
        .spyOn(faker.name, 'prefix')
        .mockImplementation((arg) => (arg === 0 ? 'X' : undefined));
      const spy_name_firstName = vi
        .spyOn(faker.name, 'firstName')
        .mockImplementation((arg) => (arg === 0 ? 'Y' : undefined));
      const spy_name_lastName = vi
        .spyOn(faker.name, 'lastName')
        .mockImplementation((arg) => (arg === 0 ? 'Z' : undefined));

      const name = faker.name.findName();

      expect(name).toBe('X Y Z');

      spy_datatype_number.mockRestore();
      spy_name_prefix.mockRestore();
      spy_name_firstName.mockRestore();
      spy_name_lastName.mockRestore();
    });

    it('occasionally returns a female full name with a prefix', () => {
      const spy_datatype_number = vi
        .spyOn(faker.datatype, 'number')
        .mockImplementation((opt) =>
          opt === 8
            ? 0 // with prefix
            : opt === 1
            ? 1 // gender female
            : undefined
        );

      const spy_name_prefix = vi
        .spyOn(faker.name, 'prefix')
        .mockImplementation((arg) => (arg === 1 ? 'J' : undefined));
      const spy_name_firstName = vi
        .spyOn(faker.name, 'firstName')
        .mockImplementation((arg) => (arg === 1 ? 'K' : undefined));
      const spy_name_lastName = vi
        .spyOn(faker.name, 'lastName')
        .mockImplementation((arg) => (arg === 1 ? 'L' : undefined));

      const name = faker.name.findName();

      expect(name).toBe('J K L');

      spy_datatype_number.mockRestore();
      spy_name_prefix.mockRestore();
      spy_name_firstName.mockRestore();
      spy_name_lastName.mockRestore();
    });

    it('occasionally returns a first name and last name with a suffix', () => {
      const spy_datatype_number = vi
        .spyOn(faker.datatype, 'number')
        .mockReturnValue(1);
      const spy_name_suffix = vi
        .spyOn(faker.name, 'suffix')
        .mockReturnValue('Jr.');

      const name = faker.name.findName();
      const parts = name.split(' ');

      expect(parts.length).greaterThanOrEqual(3);
      expect(parts[parts.length - 1]).toBe('Jr.');

      spy_name_suffix.mockRestore();
      spy_datatype_number.mockRestore();
    });

    it.todo(
      'needs to work with specific locales and respect the fallbacks',
      () => {
        faker.locale = 'en_US';
        // this will throw if this is broken
        const name = faker.name.findName();
        // TODO @Shinigami92 2022-01-20: This test doesn't check anything
      }
    );
  });

  describe('title()', () => {
    it('returns a random title', () => {
      const spy_name_title = vi
        .spyOn(faker.name, 'title')
        .mockReturnValue('Lead Solutions Supervisor');

      const title = faker.name.title();

      expect(title).toBe('Lead Solutions Supervisor');

      spy_name_title.mockRestore();
    });
  });

  describe('jobTitle()', () => {
    it('returns a job title consisting of a descriptor, area, and type', () => {
      const spy_random_arrayElement = vi.spyOn(faker.random, 'arrayElement');
      const spy_name_jobDescriptor = vi.spyOn(faker.name, 'jobDescriptor');
      const spy_name_jobArea = vi.spyOn(faker.name, 'jobArea');
      const spy_name_jobType = vi.spyOn(faker.name, 'jobType');

      const jobTitle = faker.name.jobTitle();

      expect(typeof jobTitle).toBe('string');
      expect(spy_random_arrayElement).toHaveBeenCalledTimes(3);
      expect(spy_name_jobDescriptor).toHaveBeenCalledOnce();
      expect(spy_name_jobArea).toHaveBeenCalledOnce();
      expect(spy_name_jobType).toHaveBeenCalledOnce();

      spy_random_arrayElement.mockRestore();
      spy_name_jobDescriptor.mockRestore();
      spy_name_jobArea.mockRestore();
      spy_name_jobType.mockRestore();
    });
  });

  describe('prefix()', () => {
    describe('when using a locale with gender specific name prefixes', () => {
      let oldLocale: string;

      beforeEach(() => {
        oldLocale = faker.locale;
        faker.locale = 'TEST';

        faker.locales.TEST = {
          title: 'Test',
          name: {
            male_prefix: ['Mp'],
            female_prefix: ['Fp'],
          },
        };
      });

      afterEach(() => {
        faker.locale = oldLocale;
        delete faker.locales.TEST;
      });

      it('returns male prefix', () => {
        const prefix = faker.name.prefix(0);
        expect(prefix).toBe('Mp');
      });

      it('returns female prefix', () => {
        const prefix = faker.name.prefix(1);
        expect(prefix).toBe('Fp');
      });

      it('returns either prefix', () => {
        const prefix = faker.name.prefix();
        expect(['Mp', 'Fp']).toContain(prefix);
      });
    });

    describe('when using a locale without gender specific name prefixes', () => {
      let oldLocale: string;

      beforeEach(() => {
        oldLocale = faker.locale;
        faker.locale = 'TEST';

        faker.locales.TEST = {
          title: 'Test',
          name: {
            prefix: ['P'],
          },
        };
      });

      afterEach(() => {
        faker.locale = oldLocale;
        delete faker.locales.TEST;
      });

      it('returns a prefix', () => {
        const prefix = faker.name.prefix();

        expect(prefix).toBe('P');
      });
    });
  });
});