BREAKING(v2): remove test runner; introduce test doubles

.github/workflows/master.yml

@@ -9,23 +9,57 @@ on:
       - main
 
 jobs:
-  tests:
+  tests_deno:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v2
+
+      - name: Install Deno
+        uses: denoland/setup-deno@v1
+
+      - name: Unit Tests
+        run: deno test tests/deno
+
+  tests_node:
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        # We only support until EOL
+        # See https://nodejs.org/en/about/releases/
+        node: ['14', '15', '16', '17']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
 
+      # We need deno because the "Build CJS and ESM" step runs `deno run`
       - name: Install Deno
-        uses: denolib/setup-deno@master
+        uses: denoland/setup-deno@v1
+
+      - name: Install Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Install deps
+        run: yarn install
+
+      - name: Build CJS and ESM (*nix)
+        if: matrix.os != 'windows-latest'
+        run: |
+          yarn build
 
-      - name: Unit
-        run: deno test --allow-env tests/unit
+      - name: Build CJS and ESM (windows)
+        if: matrix.os == 'windows-latest'
+        run: |
+          yarn build:windows
 
-      - name: Integration
-        run: deno test --allow-run --allow-env tests/integration
+      - name: Unit Test
+        run: yarn test
 
   linter:
     # Only one OS is required since fmt is cross platform
@@ -35,10 +69,10 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Install Deno
-        uses: denolib/setup-deno@master
+        uses: denoland/setup-deno@v1
 
-      # - name: Lint
-      #   run: deno lint --unstable
+      - name: Lint
+        run: deno lint
 
       - name: Formatter
         run: deno fmt --check

.github/workflows/release.yml

@@ -2,7 +2,67 @@ name: Release
 on:
   release:
     types: [published]
+
 jobs:
+
+  npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.CI_USER_PAT }}
+
+      # We need deno because the "Build CJS and ESM" step runs `deno run`
+      - name: Install Deno
+        uses: denoland/setup-deno@v1
+
+      # Setup .npmrc file to publish to npm
+      - name: Install Node
+        uses: actions/setup-node@v2
+        with:
+          registry-url: 'https://registry.npmjs.org'
+          scope: '@drashland'
+
+      - name: Install deps
+        run: yarn install
+
+      - name: Build CJS and ESM
+        run: yarn build
+
+      - name: Publish
+        run: yarn publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTOMATION_TOKEN }}
+
+  github:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.CI_USER_PAT }}
+
+      # We need deno because the "Build CJS and ESM" step runs `deno run`
+      - name: Install Deno
+        uses: denoland/setup-deno@v1
+
+      # Setup .npmrc file to publish to github
+      - name: Install Node
+        uses: actions/setup-node@v2
+        with:
+          registry-url: 'https://npm.pkg.github.com'
+          scope: '@drashland'
+
+      - name: Install deps
+        run: yarn install
+
+      - name: Build CJS and ESM
+        run: yarn build
+
+      - name: Publish
+        run: yarn publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
   publish-egg:
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -2,12 +2,15 @@
 .DS_Store
 
 # directories
-tmp*/*
-tmp/*
 .idea
+.vscode
+lib/
+node_modules/
+tmp*/
+tmp/
 
 # exceptions
 !.gitkeep
 
-.vscode
-
+# locks
+yarn.lock

README.md

@@ -1,71 +1,17 @@
-<p align="center">
-  <img src="./logo.svg" height="250" alt="Rhum - A lightweight testing framework for Deno.">
-  <h1 align="center">Rhum</h1>
-</p>
-<p align="center">A lightweight testing framework for Deno.</p>
-<p align="center">
-  <a href="https://github.com/drashland/rhum/releases">
-    <img src="https://img.shields.io/github/release/drashland/rhum.svg?color=bright_green&label=latest">
-  </a>
-  <a href="https://github.com/drashland/rhum/actions">
-    <img src="https://img.shields.io/github/workflow/status/drashland/rhum/master?label=ci">
-  </a>
-  <a href="https://discord.gg/SgejNXq">
-    <img src="https://img.shields.io/badge/chat-on%20discord-blue">
-  </a>
-  <a href="https://twitter.com/drash_land">
-    <img src="https://img.shields.io/twitter/url?label=%40drash_land&style=social&url=https%3A%2F%2Ftwitter.com%2Fdrash_land">
-  </a>
-  <a href="https://www.youtube.com/watch?v=WhG5hLrcaVQ&list=PLlFUbR9MhiNU9VlCi97JkahXyDYcL_vUz&ab_channel=drashland">
-    <img src="https://img.shields.io/badge/Tutorials-YouTube-red">
-  </a>
-</p>
+# Rhum
 
----
+[![Latest Release](https://img.shields.io/github/release/drashland/rhum.svg?color=bright_green&label=latest)](#)
+[![CI master](https://img.shields.io/github/workflow/status/drashland/rhum/master?label=ci%20-%20master)](#)
+[![YouTube](https://img.shields.io/badge/tutorials-youtube-red)](https://rb.gy/vxmeed)
 
-### Features
+<img align="right" height="100" src="./logo.svg" alt="Rhum logo">
 
-- Descriptive naming for your tests
-- Lightweight
-- Zero 3rd party dependencies
-- Simple and easy to use
-- Asynchronous support
-- Still uses `Deno.test` under the hood
-- Skip functionality
-- Mock requests
-- Hooks
+Rhum is a test double library that follows
+[test double definitions](https://martinfowler.com/bliki/TestDouble.html) from
+Gerard Meszaros.
 
-### Getting Started
+View the full documentation at https://drash.land/rhum.
 
-To add Rhum to your project, follow the quick start guide
-[here](https://drash.land/rhum/#/#quickstart).
-
-### Why Use Rhum?
-
-Rhum allows you to write tests in a very descriptive way -- from a code
-perspective or output perspective.
-
-Rhum is designed to aid your testing efforts -- providing many utilities as
-wrappers around Deno's existing `Deno.test`. Rhum is meant to improve the user
-experience when it comes to writing tests, such as:
-
-- Readability for test cases
-- Features that aren't available in Deno yet (hooks)
-
-Rhum takes concepts from the following:
-
-- <a href="https://mochajs.org/" target="_BLANK">Mocha</a> &mdash; For how you
-  write tests in Rhum, and the use of
-  <a href="https://mochajs.org/#hooks" target="_BLANK">hooks</a>
-- <a href="https://volument.com/baretest" target="_BLANK">Baretest</a> &mdash;
-  Being minimalistic
-
-Rhum can be added directly into any project. All you need to do is import Rhum
-and you are ready to start writing tests or bring your existing tests under
-Rhum.
-
----
-
-Want to contribute? Follow the Contributing Guidelines
-[here](https://github.com/drashland/.github/blob/master/CONTRIBUTING.md). All
-code is released under the [MIT License](./LICENSE).
+In the event the documentation pages are not accessible, please view the raw
+version of the documentation at
+https://github.com/drashland/website-v2/tree/main/docs.

babel.config.js

@@ -0,0 +1 @@
+module.exports = { presets: ["@babel/preset-env"] };

console/build_esm_lib

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+(
+  rm -r tmp/conversion_workspace/
+  mkdir -p tmp/conversion_workspace/
+  cp -r src/ tmp/conversion_workspace/src/
+  cp mod.ts tmp/conversion_workspace/mod.ts
+  deno run --allow-read --allow-run --allow-write ./console/build_esm_lib.ts
+)

console/build_esm_lib.ts

@@ -0,0 +1,48 @@
+const decoder = new TextDecoder();
+const encoder = new TextEncoder();
+
+const filesToRewrite = [
+  "tmp/conversion_workspace/src/fake/fake_builder.ts",
+  "tmp/conversion_workspace/src/fake/fake_mixin.ts",
+  "tmp/conversion_workspace/src/mock/mock_builder.ts",
+  "tmp/conversion_workspace/src/mock/mock_mixin.ts",
+  "tmp/conversion_workspace/src/interfaces.ts",
+  "tmp/conversion_workspace/src/pre_programmed_method.ts",
+  "tmp/conversion_workspace/src/types.ts",
+  "tmp/conversion_workspace/mod.ts",
+];
+
+for (const index in filesToRewrite) {
+  const file = filesToRewrite[index];
+
+  // Step 1: Read contents
+  let contents = decoder.decode(Deno.readFileSync(file));
+
+  // Step 2: Create an array of import/export statements from the contents
+  const importStatements = contents.match(/import.*";/g);
+  const exportStatements = contents.match(/export.*";/g);
+
+  // Step 3: Remove all .ts extensions from the import/export statements
+  const newImportStatements = importStatements?.map((statement: string) => {
+    return statement.replace(/\.ts";/, `";`);
+  });
+
+  const newExportStatements = exportStatements?.map((statement: string) => {
+    return statement.replace(/\.ts";/, `";`);
+  });
+
+  // Step 4: Replace the original contents with the new contents
+  if (newImportStatements) {
+    importStatements?.forEach((statement: string, index: number) => {
+      contents = contents.replace(statement, newImportStatements[index]);
+    });
+  }
+  if (newExportStatements) {
+    exportStatements?.forEach((statement: string, index: number) => {
+      contents = contents.replace(statement, newExportStatements[index]);
+    });
+  }
+
+  // Step 5: Rewrite the original file without .ts extensions
+  Deno.writeFileSync(file, encoder.encode(contents));
+}

egg.json

@@ -1,13 +1,11 @@
 {
   "name": "rhum",
-  "description": "A lightweight testing framework for Deno.",
+  "description": "A test double module to stub and mock your code.",
   "version": "1.1.14",
   "stable": true,
   "repository": "https://github.com/drashland/rhum",
   "files": [
     "./mod.ts",
-    "./deps.ts",
-    "./src/**/*",
     "./README.md",
     "./logo.svg",
     "LICENSE"