Add files

Author: kazk

.github/workflows/publish_package.yml

@@ -0,0 +1,24 @@
+name: Publish Package
+on:
+  release:
+    types: [published]
+jobs:
+  publish:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "12.x"
+          registry-url: https://registry.npmjs.org
+      - run: yarn
+      - run: yarn publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "12.x"
+          registry-url: https://npm.pkg.github.com
+      - run: yarn publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+lib/

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Qualified, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,6 @@
+# @codewars/test-compat
+
+Provides functions from the deprecated custom test framework.
+
+The goal of this package is to ease the language version upgrade.
+Any new tests should use proper assertion library.

package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@codewars/test-compat",
+  "version": "1.0.0",
+  "description": "Provides functions from the deprecated custom test framework",
+  "main": "lib/index.js",
+  "files": [
+    "lib/"
+  ],
+  "repository": "https://github.com/codewars/javascript-test-compat",
+  "license": "MIT",
+  "scripts": {
+    "prepare": "tsc"
+  },
+  "peerDependencies": {
+    "chai": ">=4.x"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.2.11",
+    "chai": "^4.2.0",
+    "husky": "^4.2.5",
+    "prettier": "^2.0.5",
+    "pretty-quick": "^2.0.1",
+    "typescript": "^3.9.6"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "pretty-quick --staged"
+    }
+  }
+}

src/assertions.ts

@@ -0,0 +1,106 @@
+// Assertions aliased to names from the custom test framework.
+import chai from "chai";
+const assert = chai.assert;
+
+export const pass = () => {};
+export const fail = assert.fail;
+export const expect = assert;
+export const assertEquals = assert.strictEqual;
+export const assertNotEquals = assert.notStrictEqual;
+export const assertContains = assert.include;
+export const assertNotContains = assert.notInclude;
+
+export const assertSimilar = (actual: any, expected: any, msg?: any) => {
+  console.error(`assertSimilar is deprecated, use assert.deepEqual`);
+  assert.deepEqual(actual, expected, msg);
+};
+
+export const assertNotSimilar = (actual: any, expected: any, msg?: any) => {
+  console.error(`assertNotSimilar is deprecated, use assert.notDeepEqual`);
+  assert.notDeepEqual(actual, expected, msg);
+};
+
+// not using `assert.throws` because it can't test for fn to throw "anything"
+export const expectError = (msg: string | (() => void), fn?: () => void) => {
+  let message: string;
+  let fun: () => void;
+  if (typeof msg === "function") {
+    fun = msg;
+    message = "Expected an error to be thrown";
+  } else {
+    fun = fn!;
+    message = msg;
+  }
+
+  let passed = false;
+  try {
+    fun();
+  } catch {
+    passed = true;
+  }
+  assert(passed, message);
+};
+
+export const expectNoError = (msg: string | (() => void), fn?: () => void) => {
+  let message: string;
+  let fun: () => void;
+  if (typeof msg === "function") {
+    fun = msg;
+    message = "Unexpected error was thrown";
+  } else {
+    fun = fn!;
+    message = msg;
+  }
+
+  try {
+    fun();
+  } catch (ex) {
+    assert.fail(appendToMessage(message, ex.message));
+  }
+};
+
+// Compares two floating point values and checks whether they are approximately equal to each other
+export const assertApproxEquals = (
+  actual: number,
+  expected: number,
+  msg?: string
+) => {
+  // uses absolute error when |expected| <= 1, compatible with old version
+  if (Math.abs(expected) <= 1) {
+    assert.closeTo(actual, expected, 1e-9);
+  } else {
+    msg = appendToMessage(
+      msg,
+      "Expected actual value " +
+        actual +
+        " to approximately equal expected value " +
+        expected +
+        " (accepted relative error: 1e-9)"
+    );
+    assert(Math.abs((expected - actual) / expected) <= 1e-9, msg);
+  }
+};
+
+// Compares two floating point values and checks whether they are sufficiently different from each other
+export const assertNotApproxEquals = (
+  actual: number,
+  unexpected: number,
+  msg?: string
+) => {
+  msg = appendToMessage(
+    msg,
+    "Actual value " +
+      actual +
+      " should not approximately equal unexpected value " +
+      unexpected +
+      " (rejected relative error: 1e-9)"
+  );
+  if (Math.abs(unexpected) <= 1) {
+    assert(Math.abs(unexpected - actual) > 1e-9, msg);
+  } else {
+    assert(Math.abs((unexpected - actual) / unexpected) > 1e-9, msg);
+  }
+};
+
+const appendToMessage = (msg: string | undefined, s: string) =>
+  msg ? msg + " - " + s : s;

src/index.ts

@@ -0,0 +1,2 @@
+export * from "./assertions";
+export * from "./utils";

src/utils.ts

@@ -0,0 +1,26 @@
+export const randomNumber = () => Math.floor(Math.random() * 101);
+
+export const randomToken = () => Math.random().toString(36).substr(8);
+
+export const randomize = (array: any[]) => {
+  const arr = array.slice();
+  let i = arr.length;
+  let j, x;
+  while (i) {
+    j = (Math.random() * i) | 0;
+    x = arr[--i];
+    arr[i] = arr[j];
+    arr[j] = x;
+  }
+  return arr;
+};
+
+export const sample = (array: any[]) => array[~~(array.length * Math.random())];
+
+export const escapeHtml = (html: any) =>
+  String(html)
+    .replace(/&/g, "&")
+    .replace(/"/g, """)
+    .replace(/'/g, "'")
+    .replace(/</g, "&lt;")
+    .replace(/>/g, "&gt;");

tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "esModuleInterop": true,
+    "target": "ES2019",
+    "module": "commonjs",
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "declaration": true,
+    "sourceMap": true,
+    "removeComments": true
+  }
+}