@inglorious/engine 0.1.0 → 0.2.0

package/src/utils/data-structures/array.js

@@ -1,83 +1,83 @@
-/**
- * A default comparator function that compares two numbers.
- *
- * @param {number} a - The first number.
- * @param {number} b - The second number.
- * @returns {number} - A positive number if `a` is less than `b`, a negative number if `a` is greater than `b`, or 0 if they are equal.
- */
-const DEFAULT_COMPARATOR = (a, b) => b - a
-
-// Threshold constants for comparison results
-const LESS_THAN_ZERO = 0
-const GREATER_THAN_ZERO = 0
-
-/**
- * Checks if an array contains a specific item.
- *
- * @param {Array} arr - The array to search.
- * @param {*} item - The item to check for.
- * @returns {boolean} - `true` if the item is found, otherwise `false`.
- */
-export function contains(arr, item) {
-  return arr.includes(item)
-}
-
-/**
- * Finds the maximum item in an array based on a comparator function.
- *
- * @param {Array} arr - The array to search.
- * @param {Function} [comparator=DEFAULT_COMPARATOR] - The comparator function to determine the maximum item.
- * @returns {*} - The maximum item in the array.
- */
-export function max(arr, comparator = DEFAULT_COMPARATOR) {
-  return arr.reduce((acc, item) =>
-    comparator(item, acc) < LESS_THAN_ZERO ? item : acc,
-  )
-}
-
-/**
- * Finds the minimum item in an array based on a comparator function.
- *
- * @param {Array} arr - The array to search.
- * @param {Function} [comparator=DEFAULT_COMPARATOR] - The comparator function to determine the minimum item.
- * @returns {*} - The minimum item in the array.
- */
-export function min(arr, comparator = DEFAULT_COMPARATOR) {
-  return arr.reduce((acc, item) =>
-    comparator(item, acc) > GREATER_THAN_ZERO ? item : acc,
-  )
-}
-
-/**
- * Removes the smallest item from an array, based on a comparator function.
- *
- * @param {Array} arr - The array to remove the item from.
- * @param {Function} [comparator=DEFAULT_COMPARATOR] - The comparator function to determine the smallest item.
- * @returns {*} - A new array with the item removed.
- */
-export function pop(arr, comparator = DEFAULT_COMPARATOR) {
-  const item = min(arr, comparator)
-  return remove(arr, item)
-}
-
-/**
- * Adds an item to an array in an immutable way.
- *
- * @param {Array} arr - The array to add the item to.
- * @param {*} item - The item to add.
- * @returns {Array} - A new array with the item added.
- */
-export function push(arr, item) {
-  return [...arr, item]
-}
-
-/**
- * Removes a specific item from an array in an immutable way.
- *
- * @param {Array} arr - The array to remove the item from.
- * @param {*} item - The item to remove.
- * @returns {Array} - A new array with the item removed.
- */
-export function remove(arr, item) {
-  return arr.filter((el) => el !== item)
-}
+/**
+ * A default comparator function that compares two numbers.
+ *
+ * @param {number} a - The first number.
+ * @param {number} b - The second number.
+ * @returns {number} - A positive number if `a` is less than `b`, a negative number if `a` is greater than `b`, or 0 if they are equal.
+ */
+const DEFAULT_COMPARATOR = (a, b) => b - a
+
+// Threshold constants for comparison results
+const LESS_THAN_ZERO = 0
+const GREATER_THAN_ZERO = 0
+
+/**
+ * Checks if an array contains a specific item.
+ *
+ * @param {Array} arr - The array to search.
+ * @param {*} item - The item to check for.
+ * @returns {boolean} - `true` if the item is found, otherwise `false`.
+ */
+export function contains(arr, item) {
+  return arr.includes(item)
+}
+
+/**
+ * Finds the maximum item in an array based on a comparator function.
+ *
+ * @param {Array} arr - The array to search.
+ * @param {Function} [comparator=DEFAULT_COMPARATOR] - The comparator function to determine the maximum item.
+ * @returns {*} - The maximum item in the array.
+ */
+export function max(arr, comparator = DEFAULT_COMPARATOR) {
+  return arr.reduce((acc, item) =>
+    comparator(item, acc) < LESS_THAN_ZERO ? item : acc,
+  )
+}
+
+/**
+ * Finds the minimum item in an array based on a comparator function.
+ *
+ * @param {Array} arr - The array to search.
+ * @param {Function} [comparator=DEFAULT_COMPARATOR] - The comparator function to determine the minimum item.
+ * @returns {*} - The minimum item in the array.
+ */
+export function min(arr, comparator = DEFAULT_COMPARATOR) {
+  return arr.reduce((acc, item) =>
+    comparator(item, acc) > GREATER_THAN_ZERO ? item : acc,
+  )
+}
+
+/**
+ * Removes the smallest item from an array, based on a comparator function.
+ *
+ * @param {Array} arr - The array to remove the item from.
+ * @param {Function} [comparator=DEFAULT_COMPARATOR] - The comparator function to determine the smallest item.
+ * @returns {*} - A new array with the item removed.
+ */
+export function pop(arr, comparator = DEFAULT_COMPARATOR) {
+  const item = min(arr, comparator)
+  return remove(arr, item)
+}
+
+/**
+ * Adds an item to an array in an immutable way.
+ *
+ * @param {Array} arr - The array to add the item to.
+ * @param {*} item - The item to add.
+ * @returns {Array} - A new array with the item added.
+ */
+export function push(arr, item) {
+  return [...arr, item]
+}
+
+/**
+ * Removes a specific item from an array in an immutable way.
+ *
+ * @param {Array} arr - The array to remove the item from.
+ * @param {*} item - The item to remove.
+ * @returns {Array} - A new array with the item removed.
+ */
+export function remove(arr, item) {
+  return arr.filter((el) => el !== item)
+}

package/src/utils/data-structures/array.test.js

@@ -1,173 +1,173 @@
-import { expect, test } from "vitest"
-
-import { contains, max, min, pop, push, remove } from "./array.js"
-
-test("it should check if an array contains a value", () => {
-  const arr = [3, 2, 6, 1, 7, 4, 5]
-  const item = 1
-  const expectedResult = true
-
-  expect(contains(arr, item)).toBe(expectedResult)
-})
-
-test("it should check if an array contains an object", () => {
-  const arr = [
-    { value: 3 },
-    { value: 2 },
-    { value: 6 },
-    { value: 1 },
-    { value: 7 },
-    { value: 4 },
-    { value: 5 },
-  ]
-  const item = arr[3]
-  const expectedResult = true
-
-  expect(contains(arr, item)).toBe(expectedResult)
-})
-
-test("it should find the maximum value of an array", () => {
-  const arr = [3, 2, 6, 1, 7, 4, 5]
-  const expectedResult = 7
-
-  expect(max(arr)).toBe(expectedResult)
-})
-
-test("it should find the maximum value in an array of objects", () => {
-  const arr = [
-    { value: 3 },
-    { value: 2 },
-    { value: 6 },
-    { value: 1 },
-    { value: 7 },
-    { value: 4 },
-    { value: 5 },
-  ]
-  const comparator = (a, b) => b.value - a.value
-  const expectedResult = { value: 7 }
-
-  expect(max(arr, comparator)).toStrictEqual(expectedResult)
-})
-
-test("it should find the minimum value of an array", () => {
-  const arr = [3, 2, 6, 1, 7, 4, 5]
-  const expectedResult = 1
-
-  expect(min(arr)).toBe(expectedResult)
-})
-
-test("it should find the minimum value in an array of objects", () => {
-  const arr = [
-    { value: 3 },
-    { value: 2 },
-    { value: 6 },
-    { value: 1 },
-    { value: 7 },
-    { value: 4 },
-    { value: 5 },
-  ]
-  const comparator = (a, b) => b.value - a.value
-  const expectedResult = { value: 1 }
-
-  expect(min(arr, comparator)).toStrictEqual(expectedResult)
-})
-
-test("it should remove the minimum value from an array", () => {
-  const arr = [3, 2, 6, 1, 7, 4, 5]
-  const expectedResult = [3, 2, 6, 7, 4, 5]
-
-  expect(pop(arr)).toStrictEqual(expectedResult)
-})
-
-test("it should remove the minimum object from an array", () => {
-  const arr = [
-    { value: 3 },
-    { value: 2 },
-    { value: 6 },
-    { value: 1 },
-    { value: 7 },
-    { value: 4 },
-    { value: 5 },
-  ]
-  const comparator = (a, b) => b.value - a.value
-  const expectedResult = [
-    { value: 3 },
-    { value: 2 },
-    { value: 6 },
-    { value: 7 },
-    { value: 4 },
-    { value: 5 },
-  ]
-
-  expect(pop(arr, comparator)).toStrictEqual(expectedResult)
-})
-
-test("it should remove the maximum value from an array", () => {
-  const arr = [3, 2, 6, 1, 7, 4, 5]
-  const comparator = (a, b) => a - b
-  const expectedResult = [3, 2, 6, 1, 4, 5]
-
-  expect(pop(arr, comparator)).toStrictEqual(expectedResult)
-})
-
-test("it should remove the maximum object from an array", () => {
-  const arr = [
-    { value: 3 },
-    { value: 2 },
-    { value: 6 },
-    { value: 1 },
-    { value: 7 },
-    { value: 4 },
-    { value: 5 },
-  ]
-  const comparator = (a, b) => a.value - b.value
-  const expectedResult = [
-    { value: 3 },
-    { value: 2 },
-    { value: 6 },
-    { value: 1 },
-    { value: 4 },
-    { value: 5 },
-  ]
-
-  expect(pop(arr, comparator)).toStrictEqual(expectedResult)
-})
-
-test("it should add a value at the end of the array", () => {
-  const arr = [3, 2, 6, 1, 7, 4]
-  const item = 5
-  const expectedResult = [3, 2, 6, 1, 7, 4, 5]
-
-  expect(push(arr, item)).toStrictEqual(expectedResult)
-})
-
-test("it should remove a primitive value from an array", () => {
-  const arr = [3, 2, 6, 1, 7, 4, 5]
-  const item = 1
-  const expectedResult = [3, 2, 6, 7, 4, 5]
-
-  expect(remove(arr, item)).toStrictEqual(expectedResult)
-})
-
-test("it should remove an object from an array", () => {
-  const arr = [
-    { value: 3 },
-    { value: 2 },
-    { value: 6 },
-    { value: 1 },
-    { value: 7 },
-    { value: 4 },
-    { value: 5 },
-  ]
-  const item = arr[3]
-  const expectedResult = [
-    { value: 3 },
-    { value: 2 },
-    { value: 6 },
-    { value: 7 },
-    { value: 4 },
-    { value: 5 },
-  ]
-
-  expect(remove(arr, item)).toStrictEqual(expectedResult)
-})
+import { expect, test } from "vitest"
+
+import { contains, max, min, pop, push, remove } from "./array.js"
+
+test("it should check if an array contains a value", () => {
+  const arr = [3, 2, 6, 1, 7, 4, 5]
+  const item = 1
+  const expectedResult = true
+
+  expect(contains(arr, item)).toBe(expectedResult)
+})
+
+test("it should check if an array contains an object", () => {
+  const arr = [
+    { value: 3 },
+    { value: 2 },
+    { value: 6 },
+    { value: 1 },
+    { value: 7 },
+    { value: 4 },
+    { value: 5 },
+  ]
+  const item = arr[3]
+  const expectedResult = true
+
+  expect(contains(arr, item)).toBe(expectedResult)
+})
+
+test("it should find the maximum value of an array", () => {
+  const arr = [3, 2, 6, 1, 7, 4, 5]
+  const expectedResult = 7
+
+  expect(max(arr)).toBe(expectedResult)
+})
+
+test("it should find the maximum value in an array of objects", () => {
+  const arr = [
+    { value: 3 },
+    { value: 2 },
+    { value: 6 },
+    { value: 1 },
+    { value: 7 },
+    { value: 4 },
+    { value: 5 },
+  ]
+  const comparator = (a, b) => b.value - a.value
+  const expectedResult = { value: 7 }
+
+  expect(max(arr, comparator)).toStrictEqual(expectedResult)
+})
+
+test("it should find the minimum value of an array", () => {
+  const arr = [3, 2, 6, 1, 7, 4, 5]
+  const expectedResult = 1
+
+  expect(min(arr)).toBe(expectedResult)
+})
+
+test("it should find the minimum value in an array of objects", () => {
+  const arr = [
+    { value: 3 },
+    { value: 2 },
+    { value: 6 },
+    { value: 1 },
+    { value: 7 },
+    { value: 4 },
+    { value: 5 },
+  ]
+  const comparator = (a, b) => b.value - a.value
+  const expectedResult = { value: 1 }
+
+  expect(min(arr, comparator)).toStrictEqual(expectedResult)
+})
+
+test("it should remove the minimum value from an array", () => {
+  const arr = [3, 2, 6, 1, 7, 4, 5]
+  const expectedResult = [3, 2, 6, 7, 4, 5]
+
+  expect(pop(arr)).toStrictEqual(expectedResult)
+})
+
+test("it should remove the minimum object from an array", () => {
+  const arr = [
+    { value: 3 },
+    { value: 2 },
+    { value: 6 },
+    { value: 1 },
+    { value: 7 },
+    { value: 4 },
+    { value: 5 },
+  ]
+  const comparator = (a, b) => b.value - a.value
+  const expectedResult = [
+    { value: 3 },
+    { value: 2 },
+    { value: 6 },
+    { value: 7 },
+    { value: 4 },
+    { value: 5 },
+  ]
+
+  expect(pop(arr, comparator)).toStrictEqual(expectedResult)
+})
+
+test("it should remove the maximum value from an array", () => {
+  const arr = [3, 2, 6, 1, 7, 4, 5]
+  const comparator = (a, b) => a - b
+  const expectedResult = [3, 2, 6, 1, 4, 5]
+
+  expect(pop(arr, comparator)).toStrictEqual(expectedResult)
+})
+
+test("it should remove the maximum object from an array", () => {
+  const arr = [
+    { value: 3 },
+    { value: 2 },
+    { value: 6 },
+    { value: 1 },
+    { value: 7 },
+    { value: 4 },
+    { value: 5 },
+  ]
+  const comparator = (a, b) => a.value - b.value
+  const expectedResult = [
+    { value: 3 },
+    { value: 2 },
+    { value: 6 },
+    { value: 1 },
+    { value: 4 },
+    { value: 5 },
+  ]
+
+  expect(pop(arr, comparator)).toStrictEqual(expectedResult)
+})
+
+test("it should add a value at the end of the array", () => {
+  const arr = [3, 2, 6, 1, 7, 4]
+  const item = 5
+  const expectedResult = [3, 2, 6, 1, 7, 4, 5]
+
+  expect(push(arr, item)).toStrictEqual(expectedResult)
+})
+
+test("it should remove a primitive value from an array", () => {
+  const arr = [3, 2, 6, 1, 7, 4, 5]
+  const item = 1
+  const expectedResult = [3, 2, 6, 7, 4, 5]
+
+  expect(remove(arr, item)).toStrictEqual(expectedResult)
+})
+
+test("it should remove an object from an array", () => {
+  const arr = [
+    { value: 3 },
+    { value: 2 },
+    { value: 6 },
+    { value: 1 },
+    { value: 7 },
+    { value: 4 },
+    { value: 5 },
+  ]
+  const item = arr[3]
+  const expectedResult = [
+    { value: 3 },
+    { value: 2 },
+    { value: 6 },
+    { value: 7 },
+    { value: 4 },
+    { value: 5 },
+  ]
+
+  expect(remove(arr, item)).toStrictEqual(expectedResult)
+})