@vitest/expect 1.4.0 → 1.5.0

package/dist/index.d.ts

@@ -237,6 +237,11 @@ declare function arrayBufferEquality(a: unknown, b: unknown): boolean | undefine
 declare function sparseArrayEquality(a: unknown, b: unknown, customTesters?: Array<Tester>): boolean | undefined;
 declare function generateToBeMessage(deepEqualityName: string, expected?: string, actual?: string): string;
 declare function pluralize(word: string, count: number): string;
+declare function getObjectKeys(object: object): Array<string | symbol>;
+declare function getObjectSubset(object: any, subset: any, customTesters?: Array<Tester>): {
+    subset: any;
+    stripped: number;
+};
 
 declare const MATCHERS_OBJECT: unique symbol;
 declare const JEST_MATCHERS_OBJECT: unique symbol;
@@ -250,4 +255,4 @@ declare const JestChaiExpect: ChaiPlugin;
 
 declare const JestExtend: ChaiPlugin;
 
-export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, type Assertion, AsymmetricMatcher, type AsymmetricMatcherInterface, type AsymmetricMatchersContaining, type AsyncExpectationResult, type ChaiPlugin, type ExpectStatic, type ExpectationResult, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, type JestAssertion, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, type MatcherHintOptions, type MatcherState, type MatchersObject, ObjectContaining, type RawMatcherFn, StringContaining, StringMatching, type SyncExpectationResult, type Tester, type TesterContext, addCustomEqualityTesters, arrayBufferEquality, equals, fnNameFor, generateToBeMessage, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };
+export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, type Assertion, AsymmetricMatcher, type AsymmetricMatcherInterface, type AsymmetricMatchersContaining, type AsyncExpectationResult, type ChaiPlugin, type ExpectStatic, type ExpectationResult, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, type JestAssertion, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, type MatcherHintOptions, type MatcherState, type MatchersObject, ObjectContaining, type RawMatcherFn, StringContaining, StringMatching, type SyncExpectationResult, type Tester, type TesterContext, addCustomEqualityTesters, arrayBufferEquality, equals, fnNameFor, generateToBeMessage, getObjectKeys, getObjectSubset, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };

package/dist/index.js

@@ -446,6 +446,57 @@ Received: serializes to the same string
 function pluralize(word, count) {
   return `${count} ${word}${count === 1 ? "" : "s"}`;
 }
+function getObjectKeys(object) {
+  return [
+    ...Object.keys(object),
+    ...Object.getOwnPropertySymbols(object).filter(
+      (s) => {
+        var _a;
+        return (_a = Object.getOwnPropertyDescriptor(object, s)) == null ? void 0 : _a.enumerable;
+      }
+    )
+  ];
+}
+function getObjectSubset(object, subset, customTesters = []) {
+  let stripped = 0;
+  const getObjectSubsetWithContext = (seenReferences = /* @__PURE__ */ new WeakMap()) => (object2, subset2) => {
+    if (Array.isArray(object2)) {
+      if (Array.isArray(subset2) && subset2.length === object2.length) {
+        return subset2.map(
+          (sub, i) => getObjectSubsetWithContext(seenReferences)(object2[i], sub)
+        );
+      }
+    } else if (object2 instanceof Date) {
+      return object2;
+    } else if (isObject(object2) && isObject(subset2)) {
+      if (equals(object2, subset2, [
+        ...customTesters,
+        iterableEquality,
+        subsetEquality
+      ])) {
+        return subset2;
+      }
+      const trimmed = {};
+      seenReferences.set(object2, trimmed);
+      for (const key of getObjectKeys(object2)) {
+        if (hasPropertyInObject(subset2, key)) {
+          trimmed[key] = seenReferences.has(object2[key]) ? seenReferences.get(object2[key]) : getObjectSubsetWithContext(seenReferences)(object2[key], subset2[key]);
+        } else {
+          if (!seenReferences.has(object2[key])) {
+            stripped += 1;
+            if (isObject(object2[key]))
+              stripped += getObjectKeys(object2[key]).length;
+            getObjectSubsetWithContext(seenReferences)(object2[key], subset2[key]);
+          }
+        }
+      }
+      if (getObjectKeys(trimmed).length > 0)
+        return trimmed;
+    }
+    return object2;
+  };
+  return { subset: getObjectSubsetWithContext()(object, subset), stripped };
+}
 
 class AsymmetricMatcher {
   constructor(sample, inverse = false) {
@@ -876,16 +927,29 @@ const JestChaiExpect = (chai, utils) => {
   });
   def("toMatchObject", function(expected) {
     const actual = this._obj;
-    return this.assert(
-      equals(actual, expected, [...customTesters, iterableEquality, subsetEquality]),
-      "expected #{this} to match object #{exp}",
-      "expected #{this} to not match object #{exp}",
-      expected,
-      actual
+    const pass = equals(actual, expected, [...customTesters, iterableEquality, subsetEquality]);
+    const isNot = utils.flag(this, "negate");
+    const { subset: actualSubset, stripped } = getObjectSubset(actual, expected);
+    const msg = utils.getMessage(
+      this,
+      [
+        pass,
+        "expected #{this} to match object #{exp}",
+        "expected #{this} to not match object #{exp}",
+        expected,
+        actualSubset
+      ]
     );
+    if (pass && isNot || !pass && !isNot) {
+      const message = stripped === 0 ? msg : `${msg}
+(${stripped} matching ${stripped === 1 ? "property" : "properties"} omitted from actual)`;
+      throw new AssertionError(message, { showDiff: true, expected, actual: actualSubset });
+    }
   });
   def("toMatch", function(expected) {
     const actual = this._obj;
+    if (typeof actual !== "string")
+      throw new TypeError(`.toMatch() expects to receive a string, but got ${typeof actual}`);
     return this.assert(
       typeof expected === "string" ? actual.includes(expected) : actual.match(expected),
       `expected #{this} to match #{exp}`,
@@ -1227,12 +1291,15 @@ Number of calls: ${c().bold(spy.mock.calls.length)}
     const spy = getSpy(this);
     const spyName = spy.getMockName();
     const nthCall = spy.mock.calls[times - 1];
+    const callCount = spy.mock.calls.length;
+    const isCalled = times <= callCount;
     this.assert(
       equals(nthCall, args, [...customTesters, iterableEquality]),
-      `expected ${ordinalOf(times)} "${spyName}" call to have been called with #{exp}`,
+      `expected ${ordinalOf(times)} "${spyName}" call to have been called with #{exp}${isCalled ? `` : `, but called only ${callCount} times`}`,
       `expected ${ordinalOf(times)} "${spyName}" call to not have been called with #{exp}`,
       args,
-      nthCall
+      nthCall,
+      isCalled
     );
   });
   def(["toHaveBeenLastCalledWith", "lastCalledWith"], function(...args) {
@@ -1564,4 +1631,4 @@ const JestExtend = (chai, utils) => {
   });
 };
 
-export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, AsymmetricMatcher, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, ObjectContaining, StringContaining, StringMatching, addCustomEqualityTesters, arrayBufferEquality, equals, fnNameFor, generateToBeMessage, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };
+export { ASYMMETRIC_MATCHERS_OBJECT, Any, Anything, ArrayContaining, AsymmetricMatcher, GLOBAL_EXPECT, JEST_MATCHERS_OBJECT, JestAsymmetricMatchers, JestChaiExpect, JestExtend, MATCHERS_OBJECT, ObjectContaining, StringContaining, StringMatching, addCustomEqualityTesters, arrayBufferEquality, equals, fnNameFor, generateToBeMessage, getObjectKeys, getObjectSubset, getState, hasAsymmetric, hasProperty, isA, isAsymmetric, isImmutableUnorderedKeyed, isImmutableUnorderedSet, iterableEquality, pluralize, setState, sparseArrayEquality, subsetEquality, typeEquality };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/expect",
   "type": "module",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Jest's expect matchers as a Chai plugin",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -31,14 +31,14 @@
   ],
   "dependencies": {
     "chai": "^4.3.10",
-    "@vitest/spy": "1.4.0",
-    "@vitest/utils": "1.4.0"
+    "@vitest/utils": "1.5.0",
+    "@vitest/spy": "1.5.0"
   },
   "devDependencies": {
     "@types/chai": "4.3.6",
     "picocolors": "^1.0.0",
     "rollup-plugin-copy": "^3.5.0",
-    "@vitest/runner": "1.4.0"
+    "@vitest/runner": "1.5.0"
   },
   "scripts": {
     "build": "rimraf dist && rollup -c",