@tryghost/jest-snapshot 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-2022 Ghost Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,41 @@
+# Jest Snapshot
+
+Tools for using jest snapshot without jest
+
+## Install
+
+`npm install @tryghost/jest-snapshot --save`
+
+or
+
+`yarn add @tryghost/jest-snapshot`
+
+
+## Usage
+
+
+## Develop
+
+This is a mono repository, managed with [lerna](https://lernajs.io/).
+
+Follow the instructions for the top-level repo.
+1. `git clone` this repo & `cd` into it as usual
+2. Run `yarn` to install top-level dependencies.
+
+
+## Run
+
+- `yarn dev`
+
+
+## Test
+
+- `yarn lint` run just eslint
+- `yarn test` run lint and tests
+
+
+
+
+# Copyright & License 
+
+Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE).

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/jest-snapshot');

package/lib/jest-snapshot.js

@@ -0,0 +1,38 @@
+const expect = require('expect');
+const SnapshotMatcher = require('./snapshot-matcher');
+const snapshotMatcher = new SnapshotMatcher();
+
+function matchSnapshotAssertion(properties) {
+    this.params = {operator: 'to match a stored snapshot'};
+
+    const result = snapshotMatcher.matchSnapshot(this.obj, properties);
+
+    this.params.message = result.message();
+    this.assert(result.pass.should.eql(true));
+}
+
+const mochaHooks = {
+    beforeAll() {
+        snapshotMatcher.resetRegistry();
+    },
+    beforeEach() {
+        const {currentTest} = this;
+
+        snapshotMatcher.setCurrentTest({
+            filename: currentTest.file + '.snap',
+            nameTemplate: currentTest.fullTitle()
+        });
+    }
+};
+
+const {any, anything, stringMatching} = expect;
+
+module.exports = {
+    mochaHooks,
+    snapshotMatcher,
+    matchSnapshot: snapshotMatcher.matchSnapshot,
+    matchSnapshotAssertion,
+    any,
+    anything,
+    stringMatching
+};

package/lib/snapshot-matcher.js

@@ -0,0 +1,79 @@
+const {SnapshotState, toMatchSnapshot} = require('jest-snapshot');
+const expect = require('expect');
+const utils = require('expect/build/utils');
+
+class SnapshotMatcher {
+    constructor() {
+        this.registry = {};
+        this.currentTest = {};
+    }
+
+    _getNameForSnapshot(snapshotFilename, snapshotNameTemplate) {
+        if (!this.registry[snapshotFilename]) {
+            this.registry[snapshotFilename] = {};
+        }
+
+        const nextCounter = (this.registry[snapshotFilename][snapshotNameTemplate] || 0) + 1;
+        this.registry[snapshotFilename][snapshotNameTemplate] = nextCounter;
+
+        return `${snapshotNameTemplate} ${nextCounter}`;
+    }
+
+    _getConfig() {
+        const testFile = this.currentTest.filename;
+        const testTitle = this.currentTest.nameTemplate;
+        const snapshotName = this._getNameForSnapshot(testFile, testTitle);
+        const willUpdate = process.env.SNAPSHOT_UPDATE ? 'all' : 'new';
+
+        return {testFile, snapshotName, willUpdate};
+    }
+
+    resetRegistry() {
+        this.registry = {};
+    }
+
+    setCurrentTest(testConfig) {
+        this.currentTest = testConfig;
+    }
+
+    getSnapshotState(testFile, willUpdate) {
+        // Intilize the SnapshotState, it’s responsible for actually matching
+        // actual snapshot with expected one and storing results
+        return new SnapshotState(testFile, {
+            updateSnapshot: willUpdate
+        });
+    }
+
+    matchSnapshot(received, properties = {}) {
+        const {testFile, snapshotName, willUpdate} = this._getConfig();
+
+        const snapshotState = this.getSnapshotState(testFile, willUpdate);
+        // Equals is not exposed from the internals of expect
+        // This truly bananananas workaround comes from here: https://github.com/facebook/jest/issues/11867
+        let equals = () => {};
+        expect.extend({
+            __capture_equals__() {
+                equals = this.equals;
+                return {pass: true};
+            }
+        });
+        expect().__capture_equals__();
+
+        const matcher = toMatchSnapshot.bind({
+            snapshotState,
+            currentTestName: snapshotName,
+            utils,
+            equals
+        });
+
+        // Execute the matcher
+        const result = matcher(received, properties);
+
+        // Store the state of snapshot, depending on updateSnapshot value
+        snapshotState.save();
+
+        return result;
+    }
+}
+
+module.exports = SnapshotMatcher;

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@tryghost/jest-snapshot",
+  "version": "0.1.0",
+  "repository": "https://github.com/TryGhost/framework/tree/main/packages/jest-snapshot",
+  "author": "Ghost Foundation",
+  "license": "MIT",
+  "main": "index.js",
+  "scripts": {
+    "dev": "echo \"Implement me!\"",
+    "test": "NODE_ENV=testing c8 --all --check-coverage --reporter html --reporter text-summary mocha './test/**/*.test.js'",
+    "lint": "eslint . --ext .js --cache",
+    "posttest": "yarn lint"
+  },
+  "files": [
+    "index.js",
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "c8": "7.11.0",
+    "mocha": "9.2.0",
+    "should": "13.2.3",
+    "sinon": "13.0.1"
+  },
+  "dependencies": {
+    "expect": "^27.5.0",
+    "jest-snapshot": "^27.5.0"
+  },
+  "gitHead": "ba2449737cd3a66d811e34b5b28b86f5d3538396"
+}