feat: everything

Author: R-unic

README.md

@@ -1,3 +1,3 @@
 # Package template
 
-Package template for roblox-ts with rUnit tests and scripts already set up
+Package template for roblox-ts with rUnit testing and scripts already set up

package.json

@@ -1,8 +1,8 @@
 {
-  "name": "@rbxts/my-package",
-  "version": "1.0.0",
-  "description": "My package description",
-  "author": "me",
+  "name": "@rbxts/better-queue",
+  "version": "0.1.0",
+  "description": "Simple O(1) queue implementation for Roblox",
+  "author": "runicly",
   "main": "out/init.lua",
   "scripts": {
     "setup-rokit": "rokit trust lune-org/lune && rokit trust rojo-rbx/rojo && rokit install",
@@ -17,7 +17,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/me/my-repo.git"
+    "url": "git+https://github.com/R-unic/better-queue.git"
   },
   "license": "ISC",
   "types": "out/index.d.ts",

src/index.ts

@@ -1,3 +1,49 @@
-export function hello(name: string): string {
-  return `Hello, ${name}!`;
+export class Queue<T extends defined> {
+  private readonly cache: Map<number, T>; // cause roblox-ts doesnt let u set specific array elements
+  private first = 0;
+  private last: number;
+
+  public constructor(cache: T[] = []) {
+    this.cache = cache as never;
+    this.last = cache.size();
+  }
+
+  public enqueue(value: T): void {
+    const last = this.last++;
+    this.cache.set(last + 1, value);
+  }
+
+  public dequeue(): T | undefined {
+    if (this.isEmpty()) return;
+
+    const first = this.first++;
+    const value = this.cache.get(first + 1);
+    this.cache.delete(first);
+
+    return value;
+  }
+
+  public toArray(): T[] {
+    const result: T[] = [];
+    for (let i = this.first; i < this.last; i++) {
+      const value = this.cache.get(i + 1);
+      if (value === undefined) continue;
+      result.push(value);
+    }
+
+    return result;
+  }
+
+  public at(index: number): T | undefined {
+    if (index < 0 || index >= this.size()) return;
+    return this.cache.get(this.first + index + 1);
+  }
+
+  public isEmpty(): boolean {
+    return this.size() <= 0;
+  }
+
+  public size(): number {
+    return math.max(this.last - this.first, 0);
+  }
 }

tests/src/spec.ts

@@ -1,11 +1,70 @@
 import { Assert, Fact, Theory, InlineData } from "@rbxts/runit";
-import { hello } from "../../src";
+import { Queue } from "../../src";
+
+const iterator = <T extends defined>(arr: T[]) => {
+  let i = 0;
+  return () => arr[i++];
+}
+
+class QueueTest {
+  @Fact
+  public creationAndToArray(): void {
+    const q = new Queue([1, 2, 3, 4]);
+    const getNext = iterator(q.toArray());
+    Assert.equal(1, getNext());
+    Assert.equal(2, getNext());
+    Assert.equal(3, getNext());
+    Assert.equal(4, getNext());
+  }
+
+  @Theory
+  @InlineData([1, 2, 3], 3)
+  @InlineData([], 0)
+  public size(array: defined[], expectedSize: number): void {
+    const q = new Queue(array);
+    Assert.equal(expectedSize, array.size());
+    Assert.equal(expectedSize, q.size());
+  }
+
+  @Theory
+  @InlineData([1, 2, 3], false)
+  @InlineData([], true)
+  public isEmpty(array: defined[], expectedIsEmpty: boolean): void {
+    const q = new Queue(array);
+    Assert.equal(expectedIsEmpty, q.isEmpty());
+  }
+
+  @Fact
+  public enqueue(): void {
+    const q = new Queue;
+    q.enqueue(1);
+    q.enqueue(2);
+    const getNext = iterator(q.toArray());
+    Assert.equal(1, getNext());
+    Assert.equal(2, getNext());
+  }
+
+  @Fact
+  public dequeue(): void {
+    const q = new Queue([1, 2, 3]);
+    const n = q.dequeue();
+    Assert.equal(1, n);
+
+    const getNext = iterator(q.toArray());
+    Assert.equal(2, getNext());
+    Assert.equal(3, getNext());
+  }
 
-class MyPackageTest {
   @Fact
-  public hello(): void {
-    Assert.equal("Hello, Runic!", hello("Runic"));
+  public at(): void {
+    const q = new Queue([1, 2, 3, 4]);
+    Assert.undefined(q.at(-1));
+    Assert.equal(1, q.at(0));
+    Assert.equal(2, q.at(1));
+    Assert.equal(3, q.at(2));
+    Assert.equal(4, q.at(3));
+    Assert.undefined(q.at(4));
   }
 }
 
-export = MyPackageTest;
+export = QueueTest;