Merge branch 'release/1.9.0' into main

MilosPaunovic · MilosPaunovic · commit 6aa1e035de40 · 2021-05-03T16:26:51.000+02:00
diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@ randomer.NUMBER.INTEGER(min, max); // Defaults to 1, 100
 #### String
 
 ```js
-// Parameter number of characters as string
+// Parameter number of characters, could be used as a random password generator
 randomer.STRING.GIBBERISH(length); // Defaults to 10
 
 // Array of full name strings between 1 and 1000 results
@@ -95,6 +95,16 @@ randomer.EMAIL.SINGLE(host); // Defaults to randomer
 randomer.EMAIL.LIST(howMany); // Defaults to 10
 ```
 
+#### Users
+
+```js
+// Random user object, { firstName: '...', lastName: '...', email: '...', password: '...', dob: '...' }
+randomer.USER.SINGLE();
+
+// Array of user objects between 1 and 1000 results
+randomer.USER.LIST(howMany); // Defaults to 10
+```
+
 ## Contributing
 
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
diff --git a/index.js b/index.js
@@ -5,7 +5,8 @@ const COLOR = require('./modules/color');
 const DATE = require('./modules/date');
 const QUOTES = require('./modules/quote');
 const EMAIL = require('./modules/email');
+const USER = require('./modules/user');
 
 module.exports = {
-  NUMBER, STRING, BOOLEAN, COLOR, DATE, QUOTES, EMAIL,
+  NUMBER, STRING, BOOLEAN, COLOR, DATE, QUOTES, EMAIL, USER,
 };
diff --git a/modules/email.js b/modules/email.js
@@ -1,8 +1,6 @@
 // Importing dependecies
 const { ARGUMENTS } = require('../utils/arguments');
-
-const { names } = require('../data/names');
-const { INTEGER } = require('./number');
+const { name: fullName } = require('../utils/helpers');
 
 /**
  * Returns random generated email address
@@ -16,7 +14,7 @@ exports.SINGLE = function (host = 'randomer') {
   ARGUMENTS(arguments, 0, 1, 'string', undefined);
 
   // Creating value
-  const name = names[INTEGER(0, names.length - 1)].replace(/\s/g, '.').toLowerCase();
+  const name = fullName().replace(/\s/g, '.').toLowerCase();
   const value = `${name}@${host}.com`;
 
   // Making sure value is casted to proper type
@@ -43,5 +41,6 @@ exports.LIST = function (howMany = 10) {
     value.push(email);
   }
 
+  // Returning value
   return value;
 };
diff --git a/modules/string.js b/modules/string.js
@@ -27,8 +27,7 @@ exports.GIBBERISH = function (length = 10) {
 };
 
 // Importing dependecies
-const { names } = require('../data/names');
-const { INTEGER } = require('./number');
+const { name } = require('../utils/helpers');
 
 /**
  * Returns array of random full names, default length is one, can
@@ -46,9 +45,9 @@ exports.NAMES = function (howMany = 10) {
   const value = [];
 
   for (let i = 0; i < howMany; i += 1) {
-    const index = INTEGER(0, names.length - 1);
-    value.push(names[index]);
+    value.push(name());
   }
 
+  // Returning value
   return value;
 };
diff --git a/modules/user.js b/modules/user.js
@@ -0,0 +1,54 @@
+// Importing dependecies
+const { ARGUMENTS } = require('../utils/arguments');
+const { name } = require('../utils/helpers');
+const { GIBBERISH } = require('./string');
+const { PAST } = require('./date');
+
+/**
+ * Returns random generated user object
+ *
+ * @return {Object} Resulting user object containtng parameters first
+ * name, last name, email, password & date of birth
+ */
+exports.SINGLE = function () {
+  // Arguments checking
+  ARGUMENTS(arguments, 0, 0, undefined, undefined);
+
+  // Creating value
+  const user = name().split(' ');
+
+  const value = {
+    firstName: user[0],
+    lastName: user[1],
+    email: `${user[0]}.${user[1]}@randomer.com`.toLowerCase(),
+    password: GIBBERISH(10),
+    dob: PAST(),
+  };
+
+  // Returning value
+  return value;
+};
+
+/**
+ * Returns array of random user objects, default length is 10, can
+ * be overridden using parameter
+ *
+ * @param {Number} [howMany=10] Number of emails you need
+ *
+ * @return {Array} Resulting array of user objects
+ */
+exports.LIST = function (howMany = 10) {
+  // Arguments checking
+  ARGUMENTS(arguments, 0, 1, 'number', howMany);
+
+  // Creating value
+  const value = [];
+
+  for (let i = 0; i < howMany; i += 1) {
+    const user = exports.SINGLE();
+    value.push(user);
+  }
+
+  // Returning value
+  return value;
+};
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "complete-randomer",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "A simple NPM helper package for generating random values.",
   "author": "Miloš Paunović <paun992@hotmail.com>",
   "repository": {
diff --git a/test/number/integer.js b/test/number/integer.js
@@ -3,7 +3,7 @@ const { INTEGER } = require('../../modules/number');
 
 describe('INTEGER()', () => {
   it('Should throw TypeError if more than 2 parameter are sent', () => {
-    assert.throw(() => { INTEGER(1, 2, 3); }, TypeError, '2 parameter(s) allowed');
+    assert.throw(() => { INTEGER(true, true, true); }, TypeError, '2 parameter(s) allowed');
   });
 
   it('Should throw TypeError if at least one parameter is not Number', () => {
diff --git a/test/string/gibberish.js b/test/string/gibberish.js
@@ -3,7 +3,7 @@ const { GIBBERISH } = require('../../modules/string');
 
 describe('GIBBERISH()', () => {
   it('Should throw TypeError if more than 2 parameter are sent', () => {
-    assert.throw(() => { GIBBERISH(1, 2); }, TypeError, '1 parameter(s) allowed');
+    assert.throw(() => { GIBBERISH(true, true); }, TypeError, '1 parameter(s) allowed');
   });
 
   it('Should throw TypeError if parameter is not Number', () => {
diff --git a/test/string/names.js b/test/string/names.js
@@ -3,7 +3,7 @@ const { NAMES } = require('../../modules/string');
 
 describe('NAMES()', () => {
   it('Should throw TypeError if more than 1 parameter is sent', () => {
-    assert.throw(() => { NAMES(1, 2); }, TypeError, '1 parameter(s) allowed');
+    assert.throw(() => { NAMES(true, true); }, TypeError, '1 parameter(s) allowed');
   });
 
   it('Should throw TypeError if parameter is not Number', () => {
diff --git a/test/user/list.js b/test/user/list.js
@@ -0,0 +1,35 @@
+const { assert } = require('chai');
+const { LIST } = require('../../modules/user');
+
+describe('LIST()', () => {
+  it('Should throw TypeError if more than 1 parameter is sent', () => {
+    assert.throw(() => { LIST(true, true); }, TypeError, '1 parameter(s) allowed');
+  });
+
+  it('Should throw TypeError if parameter is not Number', () => {
+    assert.throw(() => { LIST(true); }, TypeError, 'Parameter(s) must be of -number- type');
+  });
+
+  it('Should throw Error if parameter is smaller than 1', () => {
+    assert.throw(() => { LIST(0); }, Error, 'Number must be between 1 and 1000');
+  });
+
+  it('Should throw Error if parameter is larger than 1000', () => {
+    assert.throw(() => { LIST(1001); }, Error, 'Number must be between 1 and 1000');
+  });
+
+  it('Should return 10 user objects if there are no parameter sent', () => {
+    const result = LIST();
+    assert.lengthOf(result, 10);
+  });
+
+  it('Should return 30 user objects when parameter is sent', () => {
+    const result = LIST(30);
+    assert.lengthOf(result, 30);
+  });
+
+  it('Should test if returned value is Array', () => {
+    const result = LIST();
+    assert.isArray(result);
+  });
+});
diff --git a/test/user/single.js b/test/user/single.js
@@ -0,0 +1,22 @@
+const { assert, expect } = require('chai');
+const { SINGLE } = require('../../modules/user');
+
+describe('SINGLE()', () => {
+  it('Should throw TypeError for containing parameters', () => {
+    assert.throw(() => { SINGLE(true); }, TypeError, '0 parameter(s) allowed');
+  });
+
+  it('Should test if returned value is Object', () => {
+    const result = SINGLE();
+    assert.isObject(result);
+  });
+
+  it('Should test if all required properties exist', () => {
+    const result = SINGLE();
+    expect(result).to.have.property('firstName');
+    expect(result).to.have.property('lastName');
+    expect(result).to.have.property('email');
+    expect(result).to.have.property('password');
+    expect(result).to.have.property('dob');
+  });
+});
diff --git a/utils/helpers.js b/utils/helpers.js
@@ -0,0 +1,18 @@
+// Importing dependecies
+const { names } = require('../data/names');
+const { INTEGER } = require('../modules/number');
+
+/**
+ * Helper function for returning single random name as
+ * string from data array
+ *
+ * @return {String} Random name
+ */
+exports.name = function () {
+  // Creating value
+  const index = INTEGER(0, names.length - 1);
+  const value = names[index];
+
+  // Making sure value is casted to proper type
+  return String(value);
+};

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "complete-randomer",`
`3`		`- "version": "1.8.0",`
	`3`	`+ "version": "1.9.0",`
`4`	`4`	`"description": "A simple NPM helper package for generating random values.",`
`5`	`5`	`"author": "Miloš Paunović <paun992@hotmail.com>",`
`6`	`6`	`"repository": {`