@gabrielrufino/cube 1.0.1

package/src/Stack/index.spec.ts

@@ -0,0 +1,108 @@
+import {describe, expect, it} from '@jest/globals';
+import faker from 'faker';
+
+import Stack from './';
+
+describe('Stack', () => {
+	it('Should create an empty stack with no problems', () => {
+		const stack = new Stack();
+
+		expect(stack.data).toEqual([]);
+		expect(stack.size).toBe(0);
+	});
+
+	it('Should create a filled stack with no problems', () => {
+		const stack = new Stack(1, 2, 3, 4, 5);
+
+		expect(stack.data).toEqual([1, 2, 3, 4, 5]);
+		expect(stack.size).toBe(5);
+	});
+
+	describe('.push()', () => {
+		it('Should return the correct size of the stack', () => {
+			const size = faker.datatype.number(200);
+			const params = [];
+
+			for (let i = 0; i < size; i++) {
+				params.push(faker.datatype.number());
+			}
+
+			const stack = new Stack(...params);
+
+			expect(stack.size).toBe(size);
+		});
+
+		it('Should push a new element in the stack top', () => {
+			const stack = new Stack(1, 2, 3);
+			stack.push(4);
+
+			expect(stack.data).toEqual([1, 2, 3, 4]);
+		});
+	});
+
+	describe('.pop()', () => {
+		it('Should pop the top element from the stack', () => {
+			const stack = new Stack(1, 2, 3, 4);
+			const element = stack.pop();
+
+			expect(stack.data).toEqual([1, 2, 3]);
+			expect(element).toBe(4);
+		});
+	});
+
+	describe('.peek()', () => {
+		it('Should peek the top element of the stack', () => {
+			const stack = new Stack(1, 2, 3, 4);
+			const element = stack.peek();
+
+			expect(element).toBe(4);
+			expect(stack.data).toEqual([1, 2, 3, 4]);
+		});
+
+		it('Should peek undefined when the stack has no elements', () => {
+			const stack = new Stack();
+			const element = stack.peek();
+
+			expect(element).toBe(undefined);
+		});
+	});
+
+	describe('.clear()', () => {
+		it('Should clear a stack', () => {
+			const stack = new Stack(1, 2, 3, 4);
+			stack.clear();
+
+			expect(stack.data).toEqual([]);
+		});
+	});
+
+	describe('.isEmpty', () => {
+		it('Should return true when the stack has no elements', () => {
+			const stack = new Stack();
+
+			expect(stack.isEmpty).toBe(true);
+		});
+
+		it('Should return false when the stack at least one element', () => {
+			const stack = new Stack(1);
+
+			expect(stack.isEmpty).toBe(false);
+		});
+	});
+
+	describe('Conversion to primitive', () => {
+		it('Should return comma-separated elements in string conversion', () => {
+			const stack = new Stack(1, 2, 3, 4);
+			const string = String(stack);
+
+			expect(string).toBe('1, 2, 3, 4 [Top]');
+		});
+
+		it('Should return the stack size in number conversion', () => {
+			const stack = new Stack(1, 2, 3, 4);
+			const number = Number(stack);
+
+			expect(number).toBe(4);
+		});
+	});
+});

package/src/Stack/index.ts

@@ -0,0 +1,43 @@
+import DataStructure from '../DataStructure';
+import IStack from './IStack';
+
+export default class Stack<T = number> extends DataStructure<T> implements IStack<T> {
+	constructor(...inputs: T[]) {
+		super(inputs);
+	}
+
+	public push(element: T) {
+		this._data.push(element);
+		return element;
+	}
+
+	public pop(): T | undefined {
+		const element = this._data.pop();
+		return element;
+	}
+
+	public peek(): T | undefined {
+		const topPosition = this.data.length - 1;
+		return this.data[topPosition];
+	}
+
+	public clear(): void {
+		this._data = [];
+	}
+
+	public get isEmpty(): boolean {
+		return this.data.length === 0;
+	}
+
+	private [Symbol.toPrimitive](type: string): string | number | null {
+		if (type === 'string') {
+			return `${this.data.join(', ')} [Top]`;
+		}
+
+		if (type === 'number') {
+			return this.size;
+		}
+
+		return null;
+	}
+}

package/src/index.ts

@@ -0,0 +1,17 @@
+export {default as Algorithms} from './Algorithms';
+export {default as Array} from './Array';
+export {default as BinarySearchTree} from './BinarySearchTree';
+export {default as Deck} from './Deck';
+export {default as Dictionary} from './Dictionary';
+export {default as DoublyLinkedList} from './DoublyLinkedList';
+export {default as Graph} from './Graph';
+export {default as HashTable} from './HashTable';
+export {default as HashTableLinearProbing} from './HashTableLinearProbing';
+export {default as HashTableSeparateChaining} from './HashTableSeparateChaining';
+export {default as LinkedList} from './LinkedList';
+export {default as List} from './List';
+export {default as MaxHeap} from './MaxHeap';
+export {default as MinHeap} from './MinHeap';
+export {default as Queue} from './Queue';
+export {default as Set} from './Set';
+export {default as Stack} from './Stack';

package/tsconfig.json

@@ -0,0 +1,104 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Enable incremental compilation */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es5",                                     /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    "rootDir": "./src",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files */
+    // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+    /* Emit */
+    "declaration": true,                                 /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./build",                                 /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "exclude": [
+    "node_modules",
+    "**/*.spec.ts"
+  ]
+}