Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(helpers)!: rewrite shuffle #1521

Merged
merged 6 commits into from
Nov 7, 2022
Merged

refactor(helpers)!: rewrite shuffle #1521

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b2c4467
refactor(helpers)!: rewrite shuffle
Shinigami92 Nov 4, 2022
6c25f1b
test: update tests
Shinigami92 Nov 4, 2022
41a4ab9
chore: apply review suggestion
Shinigami92 Nov 4, 2022
e1ebc67
Merge branch 'next' into rewrite-helpers-shuffle
Shinigami92 Nov 7, 2022
e728e6d
chore: change since tag
Shinigami92 Nov 7, 2022
f881745
Merge branch 'next' into rewrite-helpers-shuffle
Shinigami92 Nov 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 43 additions & 11 deletions src/modules/helpers/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,29 +240,61 @@ export class HelpersModule {
/**
* Takes an array and randomizes it in place then returns it.
*
* Uses the modern version of the Fisher–Yates algorithm.
* @template T The type of the entries to shuffle.
* @param list The array to shuffle.
* @param options The options to use when shuffling.
* @param options.inplace Whether to shuffle the array in place or return a new array. Defaults to `false`.
*
* @example
* faker.helpers.shuffle(['a', 'b', 'c'], { inplace: true }) // [ 'b', 'c', 'a' ]
*
* @since 2.0.1
*/
shuffle<T>(list: T[], options: { inplace: true }): T[];
/**
* Returns a randomized version of the array.
*
* @template T The type of the entries to shuffle.
* @param list The array to shuffle.
* @param options The options to use when shuffling.
* @param options.inplace Whether to shuffle the array in place or return a new array. Defaults to `false`.
*
* @example
* faker.helpers.shuffle(['a', 'b', 'c']) // [ 'b', 'c', 'a' ]
* faker.helpers.shuffle(['a', 'b', 'c'], { inplace: false }) // [ 'b', 'c', 'a' ]
*
* @since 2.0.1
*/
shuffle<T>(list: readonly T[], options?: { inplace?: false }): T[];
/**
* Returns a randomized version of the array.
*
* @template T The type of the entries to shuffle.
* @param o The array to shuffle. Defaults to `[]`.
* @param list The array to shuffle.
* @param options The options to use when shuffling.
* @param options.inplace Whether to shuffle the array in place or return a new array. Defaults to `false`.
*
* @example
* faker.helpers.shuffle() // []
* faker.helpers.shuffle(['a', 'b', 'c']) // [ 'b', 'c', 'a' ]
* faker.helpers.shuffle(['a', 'b', 'c'], { inplace: true }) // [ 'b', 'c', 'a' ]
* faker.helpers.shuffle(['a', 'b', 'c'], { inplace: false }) // [ 'b', 'c', 'a' ]
*
* @since 2.0.1
*/
shuffle<T>(o?: T[]): T[] {
if (o == null || o.length === 0) {
return o || [];
shuffle<T>(list: T[], options?: { inplace?: boolean }): T[];
shuffle<T>(list: T[], options?: { inplace?: boolean }): T[] {
const { inplace = false } = options || {};

if (!inplace) {
list = [...list];
}

for (let i = o.length - 1; i > 0; --i) {
for (let i = list.length - 1; i > 0; --i) {
const j = this.faker.datatype.number(i);
const x = o[i];
o[i] = o[j];
o[j] = x;
[list[i], list[j]] = [list[j], list[i]];
}
return o;

return list;
}

/**
Expand Down
108 changes: 102 additions & 6 deletions test/__snapshots__/helpers.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,6 @@ exports[`helpers > 42 > replaceSymbols > only symbols 1`] = `"3U17U5"`;

exports[`helpers > 42 > replaceSymbols > some string 1`] = `"^1234567890ß´°!\\"§$%&/()=J\`+71,..-;:_"`;

exports[`helpers > 42 > shuffle > noArgs 1`] = `[]`;

exports[`helpers > 42 > shuffle > with array 1`] = `
[
"!",
Expand All @@ -88,6 +86,40 @@ exports[`helpers > 42 > shuffle > with array 1`] = `
]
`;

exports[`helpers > 42 > shuffle > with array and inplace false 1`] = `
[
"!",
"W",
"d",
"H",
"l",
"l",
"o",
" ",
"e",
"l",
"r",
"o",
]
`;

exports[`helpers > 42 > shuffle > with array and inplace true 1`] = `
[
"!",
"W",
"d",
"H",
"l",
"l",
"o",
" ",
"e",
"l",
"r",
"o",
]
`;

exports[`helpers > 42 > slugify > noArgs 1`] = `""`;

exports[`helpers > 42 > slugify > some string 1`] = `"hello-world"`;
Expand Down Expand Up @@ -185,8 +217,6 @@ exports[`helpers > 1211 > replaceSymbols > only symbols 1`] = `"9L72D0"`;

exports[`helpers > 1211 > replaceSymbols > some string 1`] = `"^1234567890ß´°!\\"§$%&/()=Y\`+47,..-;:_"`;

exports[`helpers > 1211 > shuffle > noArgs 1`] = `[]`;

exports[`helpers > 1211 > shuffle > with array 1`] = `
[
"l",
Expand All @@ -204,6 +234,40 @@ exports[`helpers > 1211 > shuffle > with array 1`] = `
]
`;

exports[`helpers > 1211 > shuffle > with array and inplace false 1`] = `
[
"l",
"l",
"o",
"l",
"W",
"d",
"H",
"e",
"o",
"r",
" ",
"!",
]
`;

exports[`helpers > 1211 > shuffle > with array and inplace true 1`] = `
[
"l",
"l",
"o",
"l",
"W",
"d",
"H",
"e",
"o",
"r",
" ",
"!",
]
`;

exports[`helpers > 1211 > slugify > noArgs 1`] = `""`;

exports[`helpers > 1211 > slugify > some string 1`] = `"hello-world"`;
Expand Down Expand Up @@ -291,8 +355,6 @@ exports[`helpers > 1337 > replaceSymbols > only symbols 1`] = `"2OF2OA"`;

exports[`helpers > 1337 > replaceSymbols > some string 1`] = `"^1234567890ß´°!\\"§$%&/()=G\`+5F,..-;:_"`;

exports[`helpers > 1337 > shuffle > noArgs 1`] = `[]`;

exports[`helpers > 1337 > shuffle > with array 1`] = `
[
" ",
Expand All @@ -310,6 +372,40 @@ exports[`helpers > 1337 > shuffle > with array 1`] = `
]
`;

exports[`helpers > 1337 > shuffle > with array and inplace false 1`] = `
[
" ",
"d",
"o",
"r",
"H",
"o",
"!",
"l",
"l",
"e",
"W",
"l",
]
`;

exports[`helpers > 1337 > shuffle > with array and inplace true 1`] = `
[
" ",
"d",
"o",
"r",
"H",
"o",
"!",
"l",
"l",
"e",
"W",
"l",
]
`;

exports[`helpers > 1337 > slugify > noArgs 1`] = `""`;

exports[`helpers > 1337 > slugify > some string 1`] = `"hello-world"`;
Expand Down
61 changes: 51 additions & 10 deletions test/helpers.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,13 @@ describe('helpers', () => {
});

t.describe('shuffle', (t) => {
t.it('noArgs').it('with array', 'Hello World!'.split(''));
t.it('with array', 'Hello World!'.split(''))
.it('with array and inplace true', 'Hello World!'.split(''), {
inplace: true,
})
.it('with array and inplace false', 'Hello World!'.split(''), {
inplace: false,
});
});

t.describe('uniqueArray', (t) => {
Expand Down Expand Up @@ -306,26 +312,61 @@ describe('helpers', () => {

it('mutates the input array in place', () => {
const input = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j'];
const shuffled = faker.helpers.shuffle(input);
const shuffled = faker.helpers.shuffle(input, { inplace: true });
expect(shuffled).deep.eq(input);
});

it('all items shuffled as expected when seeded', () => {
const input = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j'];
faker.seed(100);
const shuffled = faker.helpers.shuffle(input);
expect(shuffled).deep.eq([
it('does not mutate the input array by default', () => {
const input = Object.freeze([
'a',
'b',
'c',
'd',
'e',
'f',
'g',
'h',
'i',
'j',
]);
expect(() => faker.helpers.shuffle(input)).not.to.throw();
});

it('does not mutate the input array when inplace is false', () => {
const input = Object.freeze([
'a',
'b',
'c',
'd',
'j',
'i',
'e',
'f',
'g',
'h',
'i',
'j',
]);
expect(() =>
faker.helpers.shuffle(input, { inplace: false })
).not.to.throw();
});

it('throws an error when the input array is readonly and inplace is true', () => {
const input = Object.freeze([
'a',
'b',
'c',
'g',
'd',
'e',
'f',
'g',
'h',
'i',
'j',
]);
expect(() =>
// @ts-expect-error: we want to test that it throws
faker.helpers.shuffle(input, { inplace: true })
).to.throw();
});
});

Expand Down