Merge pull request #3 from tzellman/chore/random-helper

chore: add random helper

Author: tzellman

README.md

@@ -27,16 +27,13 @@ ember install ember-fakerjs
 
 ### Helpers
 
-The list of helpers available are:
-- `faker-fake` use this to generate content by directly using the `faker` API
-- `random` utility that provides parameterized access to the `random` subsection of the `faker` API
-- `faker-text`, `faker-sentence`, `faker-sentences` - generate lorem content
+The main helper is `faker-fake`. You can use this to generate content using the entire faker API.
+
+The addon ships with the following helpers: `faker-fake`, `faker-sentence`, `faker-sentences`, `faker-text`.
 
 Example usage:
 
 ```hbs
-{{random "number" max=100}}
-{{random "arrayelement" array("Link" "Ganon" "Zelda")}}
 {{faker-sentence 10}} {{!-- create a 10-word sentence --}}
 {{faker-sentences 5}} {{!-- create a 5-sentence string --}}
 <img src={{faker-fake "{{image.avatar}}"}} alt="avatar">

addon/helpers/random.js

@@ -0,0 +1,38 @@
+import { helper } from '@ember/component/helper';
+import faker from 'faker';
+
+export default helper(function random(params, hash) {
+    const method = params.length > 0 ? params[0].toLowerCase() : undefined;
+    const options = { ...(hash ?? {}) };
+    switch (method) {
+        case 'number':
+            return faker.datatype.number(options);
+        case 'float':
+            return faker.datatype.float(options);
+        case 'arrayelement':
+            return faker.random.arrayElement(params.length > 1 ? params[1] : undefined);
+        case 'arrayelements':
+            return faker.random.arrayElements(params.length > 1 ? params[1] : undefined, options?.count);
+        case 'objectelement':
+            return faker.random.objectElement(params.length > 1 ? params[1] : undefined, options?.field);
+        case 'uuid':
+            return faker.datatype.uuid();
+        case 'boolean':
+            return faker.datatype.boolean();
+        case 'word':
+            return faker.random.word(options?.type);
+        case 'words':
+            return faker.random.words(options?.count);
+        case 'image':
+            return faker.random.image();
+        case 'locale':
+            return faker.random.locale();
+        case 'alpha':
+            return faker.random.alpha(options);
+        case 'alphanumeric':
+            return faker.random.alphaNumeric(options?.count, { bannedChars: options?.bannedChars });
+        case 'hexadecimal':
+            return faker.datatype.hexaDecimal(options);
+    }
+    return undefined;
+});

app/helpers/random.js

@@ -0,0 +1 @@
+export { default } from 'ember-fakerjs/helpers/random';

tests/integration/helpers/random-test.js

@@ -0,0 +1,39 @@
+import { module, test } from 'qunit';
+import { setupRenderingTest } from 'ember-qunit';
+import { render } from '@ember/test-helpers';
+import { hbs } from 'ember-cli-htmlbars';
+
+module('Integration | Helper | random', function (hooks) {
+    setupRenderingTest(hooks);
+
+    test('all options render with defaults', async function (assert) {
+        const methods = [
+            'number',
+            'float',
+            'arrayElement',
+            'arrayElements',
+            'objectElement',
+            'uuid',
+            'boolean',
+            'word',
+            'words',
+            'image',
+            'locale',
+            'alpha',
+            'alphaNumeric',
+            'hexaDecimal'
+        ];
+        for (const method of methods) {
+            this.set('method', method);
+            await render(hbs`{{random method}}`);
+            assert.ok(this.element.textContent.trim(), 'renders content');
+        }
+    });
+
+    test('it renders specific values', async function (assert) {
+        await render(hbs`{{random "arrayelement" (array 1 2 3)}}`);
+        assert.ok(/[1-3]/.test(this.element.textContent.trim()), 'arrayelement');
+        await render(hbs`{{random "notsupported"}}`);
+        assert.notOk(this.element.textContent.trim(), 'should be empty');
+    });
+});