Feature/array includes (#796)

Perryvw · web-flow · commit ea07f801b5a0 · 2020-01-12T22:14:57.000+01:00
* Added tests

* Implemented array.includes

* PR feedback
diff --git a/src/LuaLib.ts b/src/LuaLib.ts
@@ -8,6 +8,7 @@ export enum LuaLibFeature {
     ArrayForEach = "ArrayForEach",
     ArrayFind = "ArrayFind",
     ArrayFindIndex = "ArrayFindIndex",
+    ArrayIncludes = "ArrayIncludes",
     ArrayIndexOf = "ArrayIndexOf",
     ArrayMap = "ArrayMap",
     ArrayPush = "ArrayPush",
diff --git a/src/lualib/ArrayIncludes.ts b/src/lualib/ArrayIncludes.ts
@@ -0,0 +1,21 @@
+// https://www.ecma-international.org/ecma-262/9.0/index.html#sec-array.prototype.includes
+function __TS__ArrayIncludes<T>(this: T[], searchElement: T, fromIndex = 0): boolean {
+    const len = this.length;
+    let k = fromIndex;
+
+    if (fromIndex < 0) {
+        k = len + fromIndex;
+    }
+
+    if (k < 0) {
+        k = 0;
+    }
+
+    for (const i of forRange(k, len)) {
+        if (this[i] === searchElement) {
+            return true;
+        }
+    }
+
+    return false;
+}
diff --git a/src/transformation/builtins/array.ts b/src/transformation/builtins/array.ts
@@ -40,6 +40,8 @@ export function transformArrayPrototypeCall(
             return transformLuaLibFunction(context, LuaLibFeature.ArrayFind, node, caller, ...params);
         case "findIndex":
             return transformLuaLibFunction(context, LuaLibFeature.ArrayFindIndex, node, caller, ...params);
+        case "includes":
+            return transformLuaLibFunction(context, LuaLibFeature.ArrayIncludes, node, caller, ...params);
         case "indexOf":
             return transformLuaLibFunction(context, LuaLibFeature.ArrayIndexOf, node, caller, ...params);
         case "map":
diff --git a/test/unit/builtins/array.spec.ts b/test/unit/builtins/array.spec.ts
@@ -389,6 +389,37 @@ test.each([
     `.expectToMatchJsResult();
 });
 
+test.each([
+    { array: [1, 2, 3], includes: 2 },
+    { array: [1, 2, 3, 2, 2], includes: 2 },
+    { array: [1, 2, 3], includes: 4 },
+    { array: ["a", "b", "c"], includes: "d" },
+    { array: [[1], [2], [3]], includes: [2] },
+    { array: [1, [2], 3], includes: 2 },
+])("array.includes (%p)", ({ array, includes }) => {
+    util.testExpressionTemplate`${array}.includes(${includes})`.expectToMatchJsResult();
+});
+
+test("array.includes reference", () => {
+    util.testFunction`
+        const inst = [2];
+        return [[1], [3], inst].includes(inst);
+    `.expectToMatchJsResult();
+});
+
+test.each([
+    { array: [1, 2, 3], includes: 2, fromIndex: 0 },
+    { array: [1, 2, 3], includes: 2, fromIndex: 1 },
+    { array: [1, 2, 3], includes: 2, fromIndex: 2 },
+    { array: [1, 2, 3], includes: 2, fromIndex: 3 },
+    { array: [1, 2, 3], includes: 2, fromIndex: -1 },
+    { array: [1, 2, 3], includes: 2, fromIndex: -2 },
+    { array: [1, 2, 3], includes: 2, fromIndex: -3 },
+    { array: [1, 2, 3], includes: 2, fromIndex: -4 },
+])("array.includes with fromIndex (%p)", ({ array, includes, fromIndex }) => {
+    util.testExpressionTemplate`${array}.includes(${includes}, ${fromIndex})`.expectToMatchJsResult();
+});
+
 test.each([
     { array: [] },
     { array: ["test1"] },
