@tryghost/jest-snapshot 0.3.13 → 0.4.1

package/lib/snapshot-manager.js

@@ -1,9 +1,11 @@
 const {SnapshotState, toMatchSnapshot} = require('jest-snapshot');
 const errors = require('@tryghost/errors');
 const utils = require('@jest/expect-utils');
+const assert = require('assert');
 const path = require('path');
+const {makeMessageFromMatchMessage} = require('./utils');
 
-class SnapshotManageer {
+class SnapshotManager {
     constructor() {
         this.registry = {};
         this.currentTest = {};
@@ -64,13 +66,47 @@ class SnapshotManageer {
     }
 
     getSnapshotState(testFile, willUpdate) {
-        // Intilize the SnapshotState, it’s responsible for actually matching
+        // Initialize the SnapshotState, it’s responsible for actually matching
         // actual snapshot with expected one and storing results
         return new SnapshotState(testFile, {
             updateSnapshot: willUpdate
         });
     }
 
+    assertSnapshot(response, assertion) {
+        const {properties, field, error} = assertion;
+
+        if (!response[field]) {
+            error.message = `Unable to match snapshot on undefined field ${field} ${error.contextString}`;
+            error.expected = field;
+            error.actual = 'undefined';
+            assert.notEqual(response[field], undefined, error);
+        }
+
+        const hint = `[${field}]`;
+        const match = this.match(response[field], properties, hint);
+
+        Object.keys(properties).forEach((prop) => {
+            const errorMessage = `"response.${field}" is missing the expected property "${prop}"`;
+            error.message = makeMessageFromMatchMessage(match.message(), errorMessage);
+            error.expected = prop;
+            error.actual = 'undefined';
+            error.showDiff = false; // Disable mocha's diff output as it's already present in match.message()
+
+            assert.notEqual(response[field][prop], undefined, error);
+        });
+
+        if (match.pass !== true) {
+            const errorMessage = `"response.${field}" does not match snapshot.`;
+            error.message = makeMessageFromMatchMessage(match.message(), errorMessage);
+            error.expected = match.expected;
+            error.actual = match.actual;
+            error.showDiff = false; // Disable mocha's diff output as it's already present in match.message()
+        }
+
+        assert.equal(match.pass, true, error);
+    }
+
     match(received, properties = {}, hint) {
         const {testFile, snapshotName, willUpdate} = this._getConfig();
 
@@ -92,4 +128,4 @@ class SnapshotManageer {
     }
 }
 
-module.exports = SnapshotManageer;
+module.exports = SnapshotManager;

package/lib/utils.js

@@ -0,0 +1,11 @@
+/**
+ *
+ * @param {String} message
+ * @param {String} errorMessage
+ * @returns {String}
+ */
+module.exports.makeMessageFromMatchMessage = function makeMessageFromMatchMessage(message, errorMessage) {
+    const messageLines = message.split('\n');
+    messageLines.splice(0, 1, errorMessage);
+    return messageLines.join('\n');
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/jest-snapshot",
-  "version": "0.3.13",
+  "version": "0.4.1",
   "repository": "https://github.com/TryGhost/framework/tree/main/packages/jest-snapshot",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -19,16 +19,16 @@
     "access": "public"
   },
   "devDependencies": {
-    "c8": "7.11.2",
-    "mocha": "9.2.2",
+    "c8": "7.11.3",
+    "mocha": "10.0.0",
     "should": "13.2.3",
-    "sinon": "13.0.2"
+    "sinon": "14.0.0"
   },
   "dependencies": {
     "@jest/expect": "^28.0.1",
     "@jest/expect-utils": "^28.0.1",
-    "@tryghost/errors": "^1.2.12",
+    "@tryghost/errors": "^1.2.14",
     "jest-snapshot": "^28.0.0"
   },
-  "gitHead": "944b81c690bc66f703c8cf36a310e51ce5393b9f"
+  "gitHead": "8ab5a88e706d32769575ac98e0aefcd1cfbac3dc"
 }