Skip to content

Feature/array includes #796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Perryvw merged 3 commits into from
Jan 12, 2020
Merged

Feature/array includes #796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e3e3270
Added tests
Perryvw Jan 10, 2020
0439bf9
Implemented array.includes
Perryvw Jan 10, 2020
91e5df2
PR feedback
Perryvw Jan 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/LuaLib.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ export enum LuaLibFeature {
ArrayForEach = "ArrayForEach",
ArrayFind = "ArrayFind",
ArrayFindIndex = "ArrayFindIndex",
ArrayIncludes = "ArrayIncludes",
ArrayIndexOf = "ArrayIndexOf",
ArrayMap = "ArrayMap",
ArrayPush = "ArrayPush",
Expand Down
21 changes: 21 additions & 0 deletions src/lualib/ArrayIncludes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
}
2 changes: 2 additions & 0 deletions src/transformation/builtins/array.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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":
Expand Down
31 changes: 31 additions & 0 deletions test/unit/builtins/array.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"] },
Expand Down