From 4a81a461584c45c256c4d0f4df426e14b23e631b Mon Sep 17 00:00:00 2001
From: AndySakov <andysakov1958@gmail.com>
Date: Sun, 27 Jun 2021 01:07:55 +0100
Subject: [PATCH] added siwo funtion to array_helpers

---
 package-lock.json                             | 43 +++++++++++++------
 src/helperise/array_helpers/siwo.js           | 12 ++++++
 src/helperise/registeredHelperIse.js          |  1 +
 .../helperise/array_helpers/siwo.test.js      | 13 ++++++
 4 files changed, 57 insertions(+), 12 deletions(-)
 create mode 100644 src/helperise/array_helpers/siwo.js
 create mode 100644 src/tests/helperise/array_helpers/siwo.test.js

diff --git a/package-lock.json b/package-lock.json
index 6ed5531..39325ca 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,6 +1,6 @@
 {
   "name": "yorlang",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -2300,7 +2300,8 @@
         "ansi-regex": {
           "version": "2.1.1",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "aproba": {
           "version": "1.2.0",
@@ -2321,12 +2322,14 @@
         "balanced-match": {
           "version": "1.0.0",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "brace-expansion": {
           "version": "1.1.11",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "balanced-match": "^1.0.0",
             "concat-map": "0.0.1"
@@ -2341,17 +2344,20 @@
         "code-point-at": {
           "version": "1.1.0",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "concat-map": {
           "version": "0.0.1",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "console-control-strings": {
           "version": "1.1.0",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "core-util-is": {
           "version": "1.0.2",
@@ -2468,7 +2474,8 @@
         "inherits": {
           "version": "2.0.3",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "ini": {
           "version": "1.3.5",
@@ -2480,6 +2487,7 @@
           "version": "1.0.0",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "number-is-nan": "^1.0.0"
           }
@@ -2494,6 +2502,7 @@
           "version": "3.0.4",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "brace-expansion": "^1.1.7"
           }
@@ -2501,12 +2510,14 @@
         "minimist": {
           "version": "0.0.8",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "minipass": {
           "version": "2.2.4",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "safe-buffer": "^5.1.1",
             "yallist": "^3.0.0"
@@ -2525,6 +2536,7 @@
           "version": "0.5.1",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "minimist": "0.0.8"
           }
@@ -2605,7 +2617,8 @@
         "number-is-nan": {
           "version": "1.0.1",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "object-assign": {
           "version": "4.1.1",
@@ -2617,6 +2630,7 @@
           "version": "1.4.0",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "wrappy": "1"
           }
@@ -2702,7 +2716,8 @@
         "safe-buffer": {
           "version": "5.1.1",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "safer-buffer": {
           "version": "2.1.2",
@@ -2738,6 +2753,7 @@
           "version": "1.0.2",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "code-point-at": "^1.0.0",
             "is-fullwidth-code-point": "^1.0.0",
@@ -2757,6 +2773,7 @@
           "version": "3.0.1",
           "bundled": true,
           "dev": true,
+          "optional": true,
           "requires": {
             "ansi-regex": "^2.0.0"
           }
@@ -2800,12 +2817,14 @@
         "wrappy": {
           "version": "1.0.2",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         },
         "yallist": {
           "version": "3.0.2",
           "bundled": true,
-          "dev": true
+          "dev": true,
+          "optional": true
         }
       }
     },
diff --git a/src/helperise/array_helpers/siwo.js b/src/helperise/array_helpers/siwo.js
new file mode 100644
index 0000000..7847b32
--- /dev/null
+++ b/src/helperise/array_helpers/siwo.js
@@ -0,0 +1,12 @@
+// const msg = require("../../feedbackMessages");
+
+// Check if an array contains an element
+function siwo (arr, elem) {
+    if (Array.isArray(arr) && typeof (elem) !== "undefined") {
+        return arr.includes(elem);
+    } else {
+        throw new Error(`Expected ${typeof ([])} recieved ${typeof (arr)}`);
+    }
+}
+
+module.exports = siwo;
diff --git a/src/helperise/registeredHelperIse.js b/src/helperise/registeredHelperIse.js
index abf5d92..f81ec4f 100644
--- a/src/helperise/registeredHelperIse.js
+++ b/src/helperise/registeredHelperIse.js
@@ -1,5 +1,6 @@
 const helperIseDeclarations = {};
 helperIseDeclarations["ka"] = require("./array_helpers/ka.js");
+helperIseDeclarations["siwo"] = require("./array_helpers/siwo.js");
 helperIseDeclarations["siLetaNla"] = require("./string_helpers/si_leta_nla.js");
 helperIseDeclarations["siLetaKekere"] = require("./string_helpers/si_leta_kekere.js");
 helperIseDeclarations["waNinu"] = require("./string_helpers/wa_ni_nu.js");
diff --git a/src/tests/helperise/array_helpers/siwo.test.js b/src/tests/helperise/array_helpers/siwo.test.js
new file mode 100644
index 0000000..bf93c09
--- /dev/null
+++ b/src/tests/helperise/array_helpers/siwo.test.js
@@ -0,0 +1,13 @@
+const siwo = require("../../../helperise/array_helpers/siwo.js");
+
+describe("Siwo Test suite", () => {
+    test("It should return true", () => {
+        const array = [1, 2, 3, ];
+        expect(siwo(array, 2)).toBe(true);
+    });
+
+    test("It should fail because siwo expects an array and elem as arguments", () => {
+        const array = 2;
+        expect(() => siwo(array)).toThrow();
+    });
+});