diff --git a/lib/utils/text-utils.js b/lib/utils/text-utils.js index ef3c32cc8..342be4474 100644 --- a/lib/utils/text-utils.js +++ b/lib/utils/text-utils.js @@ -1,44 +1,44 @@ // @flow function pluralize( nouns: $ReadOnlyArray, maxNumberOfNouns: number = 3, ): string { - if (nouns.length === 0) { + if (nouns.length === 0 || maxNumberOfNouns <= 0) { return ''; } else if (nouns.length === 1) { return nouns[0]; } else if (maxNumberOfNouns === 1) { return `${nouns.length} users`; } const comma = maxNumberOfNouns > 2 && nouns.length > 2 ? ',' : ''; if (nouns.length <= maxNumberOfNouns) { const prefix = nouns.slice(0, -1).join(', '); return `${prefix}${comma} and ${nouns[nouns.length - 1]}`; } const prefix = nouns.slice(0, maxNumberOfNouns - 1).join(', '); return `${prefix}${comma} and ${nouns.length - maxNumberOfNouns + 1} others`; } function trimText(text: string, maxLength: number): string { if (text.length <= maxLength) { return text; } return text.substr(0, maxLength - 3) + '...'; } function pluralizeAndTrim( nouns: $ReadOnlyArray, maxLength: number, ): string { for (let maxNumberOfNouns = 3; maxNumberOfNouns >= 2; --maxNumberOfNouns) { const text = pluralize(nouns, maxNumberOfNouns); if (text.length <= maxLength) { return text; } } return pluralize(nouns, 1); } export { pluralize, trimText, pluralizeAndTrim }; diff --git a/lib/utils/text-utils.test.js b/lib/utils/text-utils.test.js new file mode 100644 index 000000000..04d951614 --- /dev/null +++ b/lib/utils/text-utils.test.js @@ -0,0 +1,51 @@ +// @flow + +import { pluralize } from './text-utils.js'; + +describe('pluralize(nouns, maxNumberOfNouns)', () => { + it('should return an empty string when no words are given', () => { + expect(pluralize([])).toBe(''); + }); + + it('should return a single word when a single word is given', () => { + expect(pluralize(['a'])).toBe('a'); + }); + + it('should return "X and Y" when two words are given', () => { + expect(pluralize(['a', 'b'])).toBe('a and b'); + }); + + it('should return "X, Y, and Z" when three words are given', () => { + expect(pluralize(['a', 'b', 'c'])).toBe('a, b, and c'); + }); + + it('should return "X, Y, and {N-2} others" when N (>=4) words are given', () => { + expect(pluralize(['a', 'b', 'c', 'd'])).toBe('a, b, and 2 others'); + expect(pluralize(['a', 'b', 'c', 'd', 'e'])).toBe('a, b, and 3 others'); + expect(pluralize(['a', 'b', 'c', 'd', 'e', 'f'])).toBe( + 'a, b, and 4 others', + ); + }); + + it('should return "X, Y, and Z" when three words are given and maxNumNouns = 3', () => { + expect(pluralize(['a', 'b', 'c'])).toBe('a, b, and c'); + }); + + it('should return "X and 2 others" when three words are given and maxNumNouns = 2', () => { + expect(pluralize(['cat', 'dog', 'sheep'], 2)).toBe('cat and 2 others'); + }); + + it('should return "3 users" when three words are given and maxNumNouns = 1', () => { + expect(pluralize(['cat', 'dog', 'sheep'], 1)).toBe('3 users'); + }); + + it('should return an empty string when three words are given and maxNumNouns = 0', () => { + expect(pluralize(['cat', 'dog', 'sheep'], 0)).toBe(''); + }); + + it('should return "A, B, C, and D" when four words are given and maxNumNouns = 5', () => { + expect(pluralize(['cat', 'dog', 'sheep', 'moose'], 5)).toBe( + 'cat, dog, sheep, and moose', + ); + }); +});