Add ability to set custom answers

README.md

@@ -13,25 +13,31 @@ npm install jsmp-infra-alina_lukianytsia-magic_ball
 #### ES6
 
 ```js
-import { getAnswer } from 'jsmp-infra-alina_lukianytsia-magic_ball';
 
-const answer = getAnswer(); // => answer = "It is decidedly so"
+import { MagicBall } from 'jsmp-infra-alina_lukianytsia-magic_ball';
+
+// with default values:
+const magicBall = new MagicBall();
+const answer = magicBall.getAnswer(); // => answer = "It is decidedly so"
+
+// with set values:
+const magicBall = new MagicBall(['yes', 'no']);
+const answer = magicBall.getAnswer(); // => answer = "yes"
 ```
 
 #### Node
 
 ```js
-const { getAnswer } = require('jsmp-infra-alina_lukianytsia-magic_ball');
+const { MagicBall } = require('jsmp-infra-alina_lukianytsia-magic_ball');
 
-const answer = getAnswer(); // => answer = "It is decidedly so"
-```
+// with default values:
+const magicBall = new MagicBall();
+const answer = magicBall.getAnswer(); // => answer = "It is decidedly so"
 
-#### Browser
+// with set values:
+const magicBall = new MagicBall(['yes', 'no']);
+const answer = magicBall.getAnswer(); // => answer = "yes"
 
-```html
-<script>
-    jsmp-infra-alina_lukianytsia-magic_ball.getAnswer();
-</script>
 ```
 
 ## Contributing

__tests__/test-answers.json

@@ -0,0 +1,8 @@
+{
+  "TEST_ANSWERS": [
+    "Yes",
+    "No",
+    "I'm not ready to give an answer",
+    "Try again later"
+  ]
+}

__tests__/test.ts

@@ -1,16 +1,31 @@
-import { getAnswer } from '../dist';
+import { MagicBall } from '../dist';
 import { DEFAULT_ANSWERS } from '../src/answers.json';
+import { TEST_ANSWERS } from './test-answers.json';
 
-describe('getAnswer method:', () => {
-  test('type of received value', () => {
-    const answer = getAnswer();
+describe('MagicBall instance with default values:', () => {
+  const magicBall = new MagicBall();
 
-    expect(typeof answer).toBe('string');
+  test('type of received value', () => {
+    expect(typeof magicBall.getAnswer()).toBe('string');
   });
 
   test('default answers contain received value', () => {
-    const answer = getAnswer();
+    expect(DEFAULT_ANSWERS.indexOf(magicBall.getAnswer())).toBeGreaterThanOrEqual(0);
+  });
+});
+
+describe('MagicBall instance with custom values:', () => {
+  const magicBall = new MagicBall(TEST_ANSWERS);
+
+  test('type of received value', () => {
+    expect(typeof magicBall.getAnswer()).toBe('string');
+  });
+
+  test('default answers does not contain received value', () => {
+    expect(DEFAULT_ANSWERS.indexOf(magicBall.getAnswer())).toBeLessThan(0);
+  });
 
-    expect(DEFAULT_ANSWERS.indexOf(answer)).toBeGreaterThanOrEqual(0);
+  test('custom answers contain received value', () => {
+    expect(TEST_ANSWERS.indexOf(magicBall.getAnswer())).toBeGreaterThanOrEqual(0);
   });
 });

dist/index.d.ts

@@ -1,6 +1,6 @@
-import getAnswer from './magic-ball';
-export { getAnswer };
+import MagicBall from './magic-ball';
+export { MagicBall };
 declare const _default: {
-    getAnswer: typeof getAnswer;
+    MagicBall: typeof MagicBall;
 };
 export default _default;

dist/magic-ball.d.ts

@@ -1,12 +1,31 @@
 /**
- * @description
- * Generates random answer.
+ * @classdesc
+ * Class creates random answers generator with custom or default answers
  *
- * @returns {string}
  *
  * @example
- * const answer = getAnswer();
- * // => answer='It is decidedly so'
- **/
-declare function getAnswer(): string;
-export default getAnswer;
+ * - with default values:
+ * const magicBall = new MagicBall();
+ * const answer = magicBall.getAnswer(); // => answer='It is decidedly so'
+ *
+ * - with custom values:
+ * const magicBall = new MagicBall(['yes', 'no']);
+ * const answer = magicBall.getAnswer(); // => answer='yes'
+ */
+declare class MagicBall {
+    #private;
+    /**
+     * Create a MagicBall
+     * @param { string[] | undefined } answers - Sets the answers array, not mandatory.
+     * If is not passed - will be used DEFAULT_ANSWERS array.
+     */
+    constructor(answers?: string[] | undefined);
+    /**
+     *@description
+     * Generates the random answer
+     *
+     * @return {string} Random answer.
+     */
+    getAnswer: () => string;
+}
+export default MagicBall;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsmp-infra-alina_lukianytsia-magic_ball",
-  "version": "1.0.6",
+  "version": "2.0.0",
   "description": "MagicBall - can give you an answer to any question except of alternative.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/index.ts

@@ -1,5 +1,5 @@
-import getAnswer from './magic-ball';
+import MagicBall from './magic-ball';
 
-export { getAnswer };
+export { MagicBall };
 
-export default { getAnswer };
+export default { MagicBall };

src/magic-ball.ts

@@ -2,18 +2,38 @@ import random from 'lodash.random/index.js';
 import { DEFAULT_ANSWERS } from './answers.json';
 
 /**
- * @description
- * Generates random answer.
+ * @classdesc
+ * Class creates random answers generator with custom or default answers
  *
- * @returns {string}
  *
  * @example
- * const answer = getAnswer();
- * // => answer='It is decidedly so'
- **/
-function getAnswer(): string {
-  return DEFAULT_ANSWERS[random(DEFAULT_ANSWERS.length - 1)];
-}
+ * - with default values:
+ * const magicBall = new MagicBall();
+ * const answer = magicBall.getAnswer(); // => answer='It is decidedly so'
+ *
+ * - with custom values:
+ * const magicBall = new MagicBall(['yes', 'no']);
+ * const answer = magicBall.getAnswer(); // => answer='yes'
+ */
+class MagicBall {
+  #answers: string[];
 
-export default getAnswer;
+  /**
+   * Create a MagicBall
+   * @param { string[] | undefined } answers - Sets the answers array, not mandatory.
+   * If is not passed - will be used DEFAULT_ANSWERS array.
+   */
+  constructor(answers?: string[] | undefined) {
+    this.#answers = answers || DEFAULT_ANSWERS;
+  }
+
+  /**
+   *@description
+   * Generates the random answer
+   *
+   * @return {string} Random answer.
+   */
+  getAnswer = ():string => this.#answers[random(this.#answers.length - 1)];
+}
 
+export default MagicBall;