feat(lorem): add character length parameter to lorem.text

src/modules/lorem/index.ts

@@ -310,6 +310,9 @@ export class LoremModule {
   /**
    * Generates a random text based on a random lorem method.
    *
+   * @param options The options for the text to generate or options.length as quick primitive argument.
+   * @param options.length The length of text to generate as number or range.
+   *
    * @example
    * faker.lorem.text() // 'Doloribus autem non quis vero quia.'
    * faker.lorem.text()
@@ -318,10 +321,33 @@ export class LoremModule {
    * // Quis ut dolor dolores facilis possimus tempore voluptates.
    * // Iure nam officia optio cumque.
    * // Dolor tempora iusto.'
+   * faker.lorem.text(14) // 'Doloribus aut.'
+   * faker.lorem.text({length: 14}) // 'Doloribus aut.'
+   * faker.lorem.text({length: {min: 10, max: 15}}) // 'autem non quis.'
    *
    * @since 3.1.0
    */
-  text(): string {
+  text(
+    options:
+      | number
+      | {
+          /**
+           * The length (range) of text to generate.
+           */
+          length?:
+            | number
+            | {
+                /**
+                 * The minimum length of text to generate.
+                 */
+                min: number;
+                /**
+                 * The maximum length of text to generate.
+                 */
+                max: number;
+              };
+        } = {}
+  ): string {
     const methods: Array<keyof LoremModule> = [
       'sentence',
       'sentences',
@@ -332,7 +358,26 @@ export class LoremModule {
 
     const method = this.faker.helpers.arrayElement(methods);
 
-    return `${this[method]()}`;
+    if (typeof options === 'number') {
+      options = { length: options };
+    }
+
+    if (options.length == null) {
+      return `${this[method]()}`;
+    }
+
+    const length = this.faker.helpers.rangeToNumber(options.length);
+
+    if (length <= 0) {
+      return '';
+    }
+
+    let text = '';
+    do {
+      text = `${text}${this[method]()} `;
+    } while (text.length < length);
+
+    return `${text.substring(0, length).replace(/.$/, '.')}`;
   }
 
   /**

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

@@ -97,7 +97,7 @@ exports[`lorem > 42 > slug > with length range 1`] = `"theca-virga-auctus-synago
 
 exports[`lorem > 42 > text > noArgs 1`] = `"Auctus synagoga tergum patruus patria armarium decumbo armarium alveus adsum. Usitas concido paulatim aranea suggero soleo. Adstringo volubilis suppono. Vigilo benevolentia a attonbitus vulgivagus auctus provident cognomen perspiciatis. Absens custodia acervus clamo esse perspiciatis cubo."`;
 
-exports[`lorem > 42 > text > with length 1`] = `"Auctus synagoga tergum patruus patria armarium decumbo armarium alveus adsum. Usitas concido paulatim aranea suggero soleo. Adstringo volubilis suppono. Vigilo benevolentia a attonbitus vulgivagus auctus provident cognomen perspiciatis. Absens custodia acervus clamo esse perspiciatis cubo."`;
+exports[`lorem > 42 > text > with length 1`] = `"Auctus sy."`;
 
 exports[`lorem > 42 > text > with length range 1`] = `"Auctus synagoga tergum patruus patria armarium decumbo armarium alveus adsum. Usitas concido paulatim aranea suggero soleo. Adstringo volubilis suppono. Vigilo benevolentia a attonbitus vulgivagus auctus provident cognomen perspiciatis. Absens custodia acervus clamo esse perspiciatis cubo."`;
 
@@ -233,11 +233,7 @@ Considero ascit suasoria tamisium tonsor accendo.
 Sophismata sollers sursum tripudio vester dapifer coaegresco usque vorax."
 `;
 
-exports[`lorem > 1211 > text > with length 1`] = `
-"Tergo caelum aperio vulpes adficio spectaculum articulus stillicidium bene tendo.
-Considero ascit suasoria tamisium tonsor accendo.
-Sophismata sollers sursum tripudio vester dapifer coaegresco usque vorax."
-`;
+exports[`lorem > 1211 > text > with length 1`] = `"Tergo cae."`;
 
 exports[`lorem > 1211 > text > with length range 1`] = `
 "Tergo caelum aperio vulpes adficio spectaculum articulus stillicidium bene tendo.
@@ -354,7 +350,7 @@ exports[`lorem > 1337 > slug > with length range 1`] = `"laborum-articulus-benev
 
 exports[`lorem > 1337 > text > noArgs 1`] = `"Benevolentia chirographum illo degenero. Commemoro canto eaque. Cedo conculco voluptatibus cerno tabella cohors ancilla. Creptio allatus quisquam conventus ante talio vorago artificiose decipio."`;
 
-exports[`lorem > 1337 > text > with length 1`] = `"Benevolentia chirographum illo degenero. Commemoro canto eaque. Cedo conculco voluptatibus cerno tabella cohors ancilla. Creptio allatus quisquam conventus ante talio vorago artificiose decipio."`;
+exports[`lorem > 1337 > text > with length 1`] = `"Benevolen."`;
 
 exports[`lorem > 1337 > text > with length range 1`] = `"Benevolentia chirographum illo degenero. Commemoro canto eaque. Cedo conculco voluptatibus cerno tabella cohors ancilla. Creptio allatus quisquam conventus ante talio vorago artificiose decipio."`;
 

test/modules/lorem.spec.ts

@@ -325,6 +325,53 @@ describe('lorem', () => {
           expect(actual).toBeTruthy();
           expect(actual).toBeTypeOf('string');
         });
+
+        it('should return text of length 15 for the options object', () => {
+          const actual = faker.lorem.text({ length: 15 });
+
+          expect(actual).toBeTruthy();
+          expect(actual).toBeTypeOf('string');
+          expect(actual).toHaveLength(15);
+          expect(actual.trim()).toHaveLength(15);
+        });
+
+        it('should return text of length 15 for the quick primitive argument', () => {
+          const actual = faker.lorem.text(15);
+
+          expect(actual).toBeTruthy();
+          expect(actual).toBeTypeOf('string');
+          expect(actual).toHaveLength(15);
+          expect(actual.trim()).toHaveLength(15);
+        });
+
+        it('should return text with a length in range [25, 40]', () => {
+          const actual = faker.lorem.text({ length: { min: 25, max: 40 } });
+
+          expect(actual).toBeTruthy();
+          expect(actual).toBeTypeOf('string');
+          expect(actual.length).toBeGreaterThanOrEqual(25);
+          expect(actual.length).toBeLessThanOrEqual(40);
+        });
+
+        it('should throw an error if min is greater than max', () => {
+          expect(() =>
+            faker.lorem.text({ length: { min: 3, max: 1 } })
+          ).toThrowError(/^Max 1 should be greater than min 3.$/);
+        });
+
+        it('should return an empty string for length zero', () => {
+          const actual = faker.lorem.text({ length: 0 });
+
+          expect(actual).toBeTypeOf('string');
+          expect(actual).toBe('');
+        });
+
+        it('should return a dot for length one', () => {
+          const actual = faker.lorem.text({ length: 1 });
+
+          expect(actual).toBeTypeOf('string');
+          expect(actual).toBe('.');
+        });
       });
 
       describe('lines()', () => {