Merge pull request #4 from ValeriaVG/fix/expect-match-object

fix: expect toMatchObject should properly handle arrays

dist/Test.d.ts

@@ -6,7 +6,7 @@ export declare type TestResult = {
 };
 export declare type FixtureFn = () => Promise<void> | void;
 export default class Test {
-    title?: string;
+    title: string;
     suite: {
         title: string;
         fn?: Function;

dist/Test.js

@@ -57,7 +57,7 @@ class Test {
         this.after = (fn) => {
             this._after.push(fn);
         };
-        this.title = title;
+        this.title = title !== null && title !== void 0 ? title : "";
     }
 }
 exports.default = Test;

dist/expect.js

@@ -26,9 +26,13 @@ const matchers = {
         return actual ? `Expected ${JSON.stringify(actual)} to be falsy` : false;
     },
     toMatchObject: (actual, expected) => {
+        const error = `${JSON.stringify(actual)} does not match ${JSON.stringify(expected)}`;
+        if (typeof actual !== typeof expected ||
+            Array.isArray(actual) !== Array.isArray(expected))
+            return error;
         for (let key in expected) {
             if (typeof actual[key] !== typeof expected[key])
-                return `Types mismatch for ${key}: ${typeof actual[key]} != ${typeof expected[key]}`;
+                return `${error}:\nTypes mismatch for ${key}: ${typeof actual[key]} != ${typeof expected[key]}`;
             if (typeof expected[key] !== "object") {
                 const res = matchers.toBe(actual[key], expected[key]);
                 if (res)

dist/mod.ts

@@ -1,3 +1,76 @@
+export type TestResult = {
+  title: string;
+  skipped?: boolean;
+  passed?: boolean;
+  error?: Error;
+};
+
+export type FixtureFn = () => Promise<void> | void;
+export class Test {
+  title: string;
+  suite: { title: string; fn?: Function }[] = [];
+  // Stores last results
+  results: TestResult[] = [];
+  private _before: FixtureFn[] = [];
+  private _after: FixtureFn[] = [];
+  constructor(title?: string) {
+    this.title = title ?? "";
+  }
+  it = (title: string, fn?: Function) => {
+    this.suite.push({ title, fn });
+  };
+  xit = (title: string, _fn?: Function) => {
+    this.suite.push({ title });
+  };
+  run = async () => {
+    this.results = [];
+    try {
+      await Promise.all(this._before.map((fn) => fn()));
+    } catch (error) {
+      return [{ title: this.title, error, passed: false }];
+    }
+    for (let test of this.suite) {
+      if (!test.fn) {
+        this.results.push({ title: test.title, skipped: true });
+        continue;
+      }
+      try {
+        await test.fn();
+        this.results.push({ title: test.title, passed: true });
+      } catch (error) {
+        this.results.push({ title: test.title, error, passed: false });
+      }
+    }
+    try {
+      await Promise.all(this._after.map((fn) => fn()));
+    } catch (error) {
+      console.error(error);
+    }
+    return this.results;
+  };
+  before = (fn: FixtureFn) => {
+    this._before.push(fn);
+  };
+  after = (fn: FixtureFn) => {
+    this._after.push(fn);
+  };
+}
+
+export function prettify(testResults: TestResult[]) {
+  testResults.forEach(({ title, passed, skipped, error }) => {
+    if (passed) return console.info("\x1b[32m", `✓ ${title}`);
+    if (skipped) return console.info("\x1b[33m", `□ ${title}`);
+    if (!passed)
+      return console.error(
+        "\x1b[31m",
+        `𐄂 ${title}`,
+        "\n  Failed:",
+        error!.message
+      );
+  });
+  console.log("\x1b[0m");
+}
+
 export class ExpectationError extends Error {
   extensions: { matcher: string; expected: any; actual: any };
   constructor(matcher: string, expected: any, actual: any, diff: string) {
@@ -39,9 +112,17 @@ const matchers: Record<keyof Expectations, Matcher> = {
     return actual ? `Expected ${JSON.stringify(actual)} to be falsy` : false;
   },
   toMatchObject: (actual: any, expected: any): string | false => {
+    const error = `${JSON.stringify(actual)} does not match ${JSON.stringify(
+      expected
+    )}`;
+    if (
+      typeof actual !== typeof expected ||
+      Array.isArray(actual) !== Array.isArray(expected)
+    )
+      return error;
     for (let key in expected) {
       if (typeof actual[key] !== typeof expected[key])
-        return `Types mismatch for ${key}: ${typeof actual[
+        return `${error}:\nTypes mismatch for ${key}: ${typeof actual[
           key
         ]} != ${typeof expected[key]}`;
       if (typeof expected[key] !== "object") {
@@ -102,75 +183,3 @@ export function expect(actual: any): Expectations & { not: Expectations } {
   });
   return expectation;
 }
-
-export function prettify(testResults: TestResult[]) {
-  testResults.forEach(({ title, passed, skipped, error }) => {
-    if (passed) return console.info("\x1b[32m", `✓ ${title}`);
-    if (skipped) return console.info("\x1b[33m", `□ ${title}`);
-    if (!passed)
-      return console.error(
-        "\x1b[31m",
-        `𐄂 ${title}`,
-        "\n  Failed:",
-        error!.message
-      );
-  });
-  console.log("\x1b[0m");
-}
-
-export type TestResult = {
-  title: string;
-  skipped?: boolean;
-  passed?: boolean;
-  error?: Error;
-};
-export type FixtureFn = () => Promise<void> | void;
-export class Test {
-  title: string;
-  suite: { title: string; fn?: Function }[] = [];
-  // Stores last results
-  results: TestResult[] = [];
-  private _before: FixtureFn[] = [];
-  private _after: FixtureFn[] = [];
-  constructor(title?: string) {
-    this.title = title ?? "";
-  }
-  it = (title: string, fn?: Function) => {
-    this.suite.push({ title, fn });
-  };
-  xit = (title: string, _fn?: Function) => {
-    this.suite.push({ title });
-  };
-  run = async () => {
-    this.results = [];
-    try {
-      await Promise.all(this._before.map((fn) => fn()));
-    } catch (error) {
-      return [{ title: this.title, error, passed: false }];
-    }
-    for (let test of this.suite) {
-      if (!test.fn) {
-        this.results.push({ title: test.title, skipped: true });
-        continue;
-      }
-      try {
-        await test.fn();
-        this.results.push({ title: test.title, passed: true });
-      } catch (error) {
-        this.results.push({ title: test.title, error, passed: false });
-      }
-    }
-    try {
-      await Promise.all(this._after.map((fn) => fn()));
-    } catch (error) {
-      console.error(error);
-    }
-    return this.results;
-  };
-  before = (fn: FixtureFn) => {
-    this._before.push(fn);
-  };
-  after = (fn: FixtureFn) => {
-    this._after.push(fn);
-  };
-}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tiny-jest",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Minimalistic zero dependency Jest-like test library to run tests in browser, nodejs or deno.",
   "keywords": [
     "jest",

src/Test.ts

@@ -7,14 +7,14 @@ export type TestResult = {
 
 export type FixtureFn = () => Promise<void> | void;
 export default class Test {
-  title?: string;
+  title: string;
   suite: { title: string; fn?: Function }[] = [];
   // Stores last results
   results: TestResult[] = [];
   private _before: FixtureFn[] = [];
   private _after: FixtureFn[] = [];
   constructor(title?: string) {
-    this.title = title;
+    this.title = title ?? "";
   }
   it = (title: string, fn?: Function) => {
     this.suite.push({ title, fn });

src/expect.ts

@@ -39,9 +39,17 @@ const matchers: Record<keyof Expectations, Matcher> = {
     return actual ? `Expected ${JSON.stringify(actual)} to be falsy` : false;
   },
   toMatchObject: (actual: any, expected: any): string | false => {
+    const error = `${JSON.stringify(actual)} does not match ${JSON.stringify(
+      expected
+    )}`;
+    if (
+      typeof actual !== typeof expected ||
+      Array.isArray(actual) !== Array.isArray(expected)
+    )
+      return error;
     for (let key in expected) {
       if (typeof actual[key] !== typeof expected[key])
-        return `Types mismatch for ${key}: ${typeof actual[
+        return `${error}:\nTypes mismatch for ${key}: ${typeof actual[
           key
         ]} != ${typeof expected[key]}`;
       if (typeof expected[key] !== "object") {

tests/expect.spec.js

@@ -50,4 +50,31 @@ it("expect.not", async () => {
     expect(error.message).toBe("Expected 2 not to be truthy");
   }
 });
+
+it("toMatchObject", () => {
+  const more = { a: 1, b: 2, c: 3 };
+  const less = { a: 1, b: 2 };
+  expect(more).toMatchObject(more);
+  expect(less).toMatchObject(less);
+
+  expect(more).toMatchObject(less);
+  expect(less).not.toMatchObject(more);
+});
+
+it("toMatchObject/arrays", () => {
+  expect([]).toMatchObject([]);
+  expect([]).not.toMatchObject({});
+  expect([1, 2, 3]).toMatchObject([1, 2]);
+  expect([2, 3]).not.toMatchObject([1, 2, 3]);
+  expect([{ id: 1, name: "1" }, { id: 2, name: "2" }, { id: 3 }]).toMatchObject(
+    [{ id: 1 }, { id: 2 }, { id: 3 }]
+  );
+  expect([{ id: 1 }, { id: 2 }, { id: 3 }]).not.toMatchObject([
+    { id: 1, name: "1" },
+    { id: 2, name: "2" },
+    { id: 3 },
+  ]);
+  expect({ a: [1, 2, 3] }).toMatchObject({ a: [1, 2, 3] });
+  expect({ a: [1, 2] }).not.toMatchObject({ a: [1, 2, 3] });
+});
 module.exports = test;