Upgrade array-changes to fix structural moves

Author: sunesimonsen

lib/arrayChanges.js

@@ -0,0 +1,25 @@
+const arrayChanges = require('array-changes');
+
+module.exports = function (...args) {
+  console.log(args);
+  return arrayChanges(...args).map((change) => {
+    if (change.type === 'moveSource' && change.equal === false) {
+      return {
+        type: 'remove',
+        value: change.value,
+        actualIndex: change.actualIndex,
+        last: change.last,
+      };
+    }
+
+    if (change.type === 'moveTarget' && change.equal === false) {
+      return {
+        type: 'insert',
+        value: change.expected,
+        actualIndex: change.actualIndex,
+      };
+    }
+
+    return change;
+  });
+};

lib/assertions.js

@@ -1,5 +1,5 @@
 const utils = require('./utils');
-const arrayChanges = require('array-changes');
+const arrayChanges = require('./arrayChanges');
 const arrayChangesAsync = require('array-changes-async');
 const throwIfNonUnexpectedError = require('./throwIfNonUnexpectedError');
 const objectIs = utils.objectIs;

lib/types.js

@@ -1,7 +1,7 @@
 const utils = require('./utils');
 const isRegExp = utils.isRegExp;
 const leftPad = utils.leftPad;
-const arrayChanges = require('array-changes');
+const arrayChanges = require('./arrayChanges');
 const ukkonen = require('ukkonen');
 const detectIndent = require('detect-indent');
 const defaultDepth = require('./defaultDepth');

package.json

@@ -23,7 +23,7 @@
   },
   "main": "./build/lib/index.js",
   "dependencies": {
-    "array-changes": "3.0.1",
+    "array-changes": "^3.2.1",
     "array-changes-async": "3.0.1",
     "detect-indent": "3.0.1",
     "diff": "^5.0.0",

test/assertions/to-equal.spec.js

@@ -595,4 +595,24 @@ describe('to equal assertion', () => {
       expect(errors[0], 'to equal', errors[1]);
     });
   });
+
+  it('handles moving of objects with similar structures', () => {
+    expect(
+      function () {
+        expect([42, { name: 'John', age: 34 }], 'to equal', [
+          { name: 'Jane', age: 24, children: 2 },
+          42,
+        ]);
+      },
+      'to throw exception',
+      "expected [ 42, { name: 'John', age: 34 } ]\n" +
+        "to equal [ { name: 'Jane', age: 24, children: 2 }, 42 ]\n" +
+        '\n' +
+        '[\n' +
+        "  // missing { name: 'Jane', age: 24, children: 2 }\n" +
+        '  42,\n' +
+        "  { name: 'John', age: 34 } // should be removed\n" +
+        ']'
+    );
+  });
 });

test/assertions/to-satisfy.spec.js

@@ -2904,4 +2904,24 @@ describe('to satisfy assertion', () => {
       );
     });
   });
+
+  it('handles moving of objects with similar structures', () => {
+    expect(
+      function () {
+        expect([42, { name: 'John', age: 34 }], 'to satisfy', [
+          { name: 'Jane', age: 24, children: 2 },
+          42,
+        ]);
+      },
+      'to throw exception',
+      "expected [ 42, { name: 'John', age: 34 } ]\n" +
+        "to satisfy [ { name: 'Jane', age: 24, children: 2 }, 42 ]\n" +
+        '\n' +
+        '[\n' +
+        "  // missing { name: 'Jane', age: 24, children: 2 }\n" +
+        '  42,\n' +
+        "  { name: 'John', age: 34 } // should be removed\n" +
+        ']'
+    );
+  });
 });

test/assertions/when-sorted.spec.js

@@ -22,4 +22,22 @@ describe('when sorted assertion', () => {
   it("should also work without the 'when'", () => {
     expect(['c', 'd', 'a'], 'sorted', 'to equal', ['a', 'c', 'd']);
   });
+
+  describe('when failing', () => {
+    it('shows an error describing what is wrong', () => {
+      expect(
+        () => expect(['c', 'a', 'b'], 'sorted', 'to equal', ['c', 'b', 'a']),
+        'to throw',
+        "expected [ 'c', 'a', 'b' ] sorted to equal [ 'c', 'b', 'a' ]\n" +
+          '\n' +
+          '[\n' +
+          '┌───▷\n' +
+          '│ ┌─▷\n' +
+          "│ │   'a',\n" +
+          "│ └── 'b', // should be moved\n" +
+          "└──── 'c' // should be moved\n" +
+          ']'
+      );
+    });
+  });
 });