Merge pull request #28 from udibo/dev

Hide internal TestSuite object

Author: KyleJune

README.md

@@ -1,7 +1,7 @@
 # Test Suite
 
-[![version](https://img.shields.io/badge/release-0.10.2-success)](https://deno.land/x/test_suite@0.10.1)
-[![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/test_suite@0.10.2/mod.ts)
+[![version](https://img.shields.io/badge/release-0.11.0-success)](https://deno.land/x/test_suite@0.11.0)
+[![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/test_suite@0.11.0/mod.ts)
 [![CI](https://github.com/udibo/test_suite/workflows/CI/badge.svg)](https://github.com/udibo/test_suite/actions?query=workflow%3ACI)
 [![codecov](https://codecov.io/gh/udibo/test_suite/branch/main/graph/badge.svg?token=EFKGY72AAV)](https://codecov.io/gh/udibo/test_suite)
 [![license](https://img.shields.io/github/license/udibo/test_suite)](https://github.com/udibo/test_suite/blob/master/LICENSE)
@@ -26,12 +26,12 @@ also be imported directly from GitHub using raw content URLs.
 
 ```ts
 // Import from Deno's third party module registry
-import { describe, it } from "https://deno.land/x/test_suite@0.10.2/mod.ts";
+import { describe, it } from "https://deno.land/x/test_suite@0.11.0/mod.ts";
 // Import from GitHub
 import {
   describe,
   it,
-} from "https://raw.githubusercontent.com/udibo/test_suite/0.10.2/mod.ts";
+} from "https://raw.githubusercontent.com/udibo/test_suite/0.11.0/mod.ts";
 ```
 
 ## Usage
@@ -52,7 +52,7 @@ except they are called before and after each individual test.
 Below are some examples of how to use `describe` and `it` in tests.
 
 See
-[deno docs](https://doc.deno.land/https/deno.land/x/test_suite@0.10.2/mod.ts)
+[deno docs](https://doc.deno.land/https/deno.land/x/test_suite@0.11.0/mod.ts)
 for more information.
 
 ### Nested test grouping
@@ -65,13 +65,13 @@ import {
   beforeEach,
   describe,
   it,
-} from "https://deno.land/x/test_suite@0.10.2/mod.ts";
-import { assertEquals } from "https://deno.land/std@0.127.0/testing/asserts.ts";
+} from "https://deno.land/x/test_suite@0.11.0/mod.ts";
+import { assertEquals } from "https://deno.land/std@0.128.0/testing/asserts.ts";
 import {
   getUser,
   resetUsers,
   User,
-} from "https://deno.land/x/test_suite@0.10.2/examples/user.ts";
+} from "https://deno.land/x/test_suite@0.11.0/examples/user.ts";
 
 describe("user describe", () => {
   let user: User;
@@ -129,13 +129,13 @@ test result: ok. 1 passed (5 steps); 0 failed; 0 ignored; 0 measured; 0 filtered
 The example below can be found [here](examples/user_flat_test.ts).
 
 ```ts
-import { describe, it } from "https://deno.land/x/test_suite@0.10.2/mod.ts";
-import { assertEquals } from "https://deno.land/std@0.127.0/testing/asserts.ts";
+import { describe, it } from "https://deno.land/x/test_suite@0.11.0/mod.ts";
+import { assertEquals } from "https://deno.land/std@0.128.0/testing/asserts.ts";
 import {
   getUser,
   resetUsers,
   User,
-} from "https://deno.land/x/test_suite@0.10.2/examples/user.ts";
+} from "https://deno.land/x/test_suite@0.11.0/examples/user.ts";
 
 interface UserContext {
   user: User;
@@ -156,11 +156,7 @@ it(userSuite, "create", () => {
   assertEquals(user.name, "John Doe");
 });
 
-interface GetUserContext extends UserContext {
-  value?: number;
-}
-
-const getUserSuite = describe<GetUserContext>({
+const getUserSuite = describe({
   name: "getUser",
   suite: userSuite,
 });

describe.ts

@@ -4,7 +4,7 @@ import {
   ItDefinition,
   TestSuite,
 } from "./test_suite.ts";
-export type { DescribeDefinition, ItDefinition, TestSuite };
+export type { DescribeDefinition, ItDefinition };
 
 /** The arguments for an ItFunction. */
 type ItArgs<T> =
@@ -32,32 +32,32 @@ type ItArgs<T> =
     fn: (context: T) => void | Promise<void>,
   ]
   | [
-    suite: TestSuite<T>,
+    suite: symbol,
     name: string,
     options: Omit<ItDefinition<T>, "name" | "suite">,
   ]
   | [
-    suite: TestSuite<T>,
+    suite: symbol,
     name: string,
     fn: (context: T) => void | Promise<void>,
   ]
   | [
-    suite: TestSuite<T>,
+    suite: symbol,
     fn: (context: T) => void | Promise<void>,
   ]
   | [
-    suite: TestSuite<T>,
+    suite: symbol,
     name: string,
     options: Omit<ItDefinition<T>, "fn" | "name" | "suite">,
     fn: (context: T) => void | Promise<void>,
   ]
   | [
-    suite: TestSuite<T>,
+    suite: symbol,
     options: Omit<ItDefinition<T>, "fn" | "suite">,
     fn: (context: T) => void | Promise<void>,
   ]
   | [
-    suite: TestSuite<T>,
+    suite: symbol,
     options: Omit<ItDefinition<T>, "fn" | "name" | "suite">,
     fn: (context: T) => void | Promise<void>,
   ];
@@ -70,14 +70,14 @@ function itDefinition<T>(...args: ItArgs<T>): ItDefinition<T> {
     optionsOrFn,
     fn,
   ] = args;
-  let suite: TestSuite<T> | undefined = undefined;
+  let suite: symbol | undefined = undefined;
   let name: string;
   let options:
     | ItDefinition<T>
     | Omit<ItDefinition<T>, "fn">
     | Omit<ItDefinition<T>, "name">
     | Omit<ItDefinition<T>, "fn" | "name">;
-  if (suiteOptionsOrNameOrFn instanceof TestSuite) {
+  if (typeof suiteOptionsOrNameOrFn === "symbol") {
     suite = suiteOptionsOrNameOrFn;
   } else {
     fn = optionsOrFn as typeof fn;
@@ -134,13 +134,12 @@ export function it<T>(...args: ItArgs<T>): void {
     );
   }
   const options = itDefinition(...args);
-  let { suite } = options;
-
-  suite ??= TestSuite.current as TestSuite<T>;
+  const { suite } = options;
+  const testSuite = suite ? TestSuite.suites.get(suite) : TestSuite.current;
 
   if (!TestSuite.started) TestSuite.started = true;
-  if (suite) {
-    TestSuite.addStep(suite, options);
+  if (testSuite) {
+    TestSuite.addStep(testSuite, options);
   } else {
     const {
       name,
@@ -255,36 +254,36 @@ type DescribeArgs<T> =
     fn: () => void,
   ]
   | [
-    suite: TestSuite<T>,
+    suite: symbol,
     name: string,
   ]
   | [
-    suite: TestSuite<T>,
+    suite: symbol,
     name: string,
     options: Omit<DescribeDefinition<T>, "name" | "suite">,
   ]
   | [
-    suite: TestSuite<T>,
+    suite: symbol,
     name: string,
     fn: () => void,
   ]
   | [
-    suite: TestSuite<T>,
+    suite: symbol,
     fn: () => void,
   ]
   | [
-    suite: TestSuite<T>,
+    suite: symbol,
     name: string,
     options: Omit<DescribeDefinition<T>, "fn" | "name" | "suite">,
     fn: () => void,
   ]
   | [
-    suite: TestSuite<T>,
+    suite: symbol,
     options: Omit<DescribeDefinition<T>, "fn" | "suite">,
     fn: () => void,
   ]
   | [
-    suite: TestSuite<T>,
+    suite: symbol,
     options: Omit<DescribeDefinition<T>, "fn" | "name" | "suite">,
     fn: () => void,
   ];
@@ -299,14 +298,14 @@ function describeDefinition<T>(
     optionsOrFn,
     fn,
   ] = args;
-  let suite: TestSuite<T> | undefined = undefined;
+  let suite: symbol | undefined = undefined;
   let name: string;
   let options:
     | DescribeDefinition<T>
     | Omit<DescribeDefinition<T>, "fn">
     | Omit<DescribeDefinition<T>, "name">
     | Omit<DescribeDefinition<T>, "fn" | "name">;
-  if (suiteOptionsOrNameOrFn instanceof TestSuite) {
+  if (typeof suiteOptionsOrNameOrFn === "symbol") {
     suite = suiteOptionsOrNameOrFn;
   } else {
     fn = optionsOrFn as typeof fn;
@@ -337,7 +336,7 @@ function describeDefinition<T>(
   }
 
   if (!suite) {
-    suite = options.suite ?? TestSuite.current as TestSuite<T>;
+    suite = options.suite ?? TestSuite.current?.symbol;
   }
 
   return {
@@ -350,32 +349,32 @@ function describeDefinition<T>(
 
 /** Registers a test suite. */
 export interface describe {
-  <T>(...args: DescribeArgs<T>): TestSuite<T>;
+  <T>(...args: DescribeArgs<T>): symbol;
 
   /** Registers a test suite with only set to true. */
-  only<T>(...args: DescribeArgs<T>): TestSuite<T>;
+  only<T>(...args: DescribeArgs<T>): symbol;
 
   /** Registers a test suite with ignore set to true. */
-  ignore<T>(...args: DescribeArgs<T>): TestSuite<T>;
+  ignore<T>(...args: DescribeArgs<T>): symbol;
 }
 
 /** Registers a test suite. */
 export function describe<T>(
   ...args: DescribeArgs<T>
-): TestSuite<T> {
+): symbol {
   if (TestSuite.running) {
     throw new Error(
       "cannot register new test suites after already registered test cases start running",
     );
   }
   const options = describeDefinition(...args);
   if (!TestSuite.started) TestSuite.started = true;
-  return new TestSuite(options);
+  return (new TestSuite(options)).symbol;
 }
 
 describe.only = function describeOnly<T>(
   ...args: DescribeArgs<T>
-): TestSuite<T> {
+): symbol {
   const options = describeDefinition(...args);
   return describe({
     ...options,
@@ -385,7 +384,7 @@ describe.only = function describeOnly<T>(
 
 describe.ignore = function describeIgnore<T>(
   ...args: DescribeArgs<T>
-): TestSuite<T> {
+): symbol {
   const options = describeDefinition(...args);
   return describe({
     ...options,