Add toIncludeAllMembersInOrder.

Author: sandinmyjoints

src/matchers/index.js

@@ -54,6 +54,7 @@ export { toHaveBeenCalledOnce } from './toHaveBeenCalledOnce';
 export { toHaveBeenCalledOnceWith } from './toHaveBeenCalledOnceWith';
 export { toInclude } from './toInclude';
 export { toIncludeAllMembers } from './toIncludeAllMembers';
+export { toIncludeAllMembersInOrder } from './toIncludeAllMembersInOrder';
 export { toIncludeAllPartialMembers } from './toIncludeAllPartialMembers';
 export { toIncludeAnyMembers } from './toIncludeAnyMembers';
 export { toIncludeMultiple } from './toIncludeMultiple';

src/matchers/toIncludeAllMembersInOrder.js

@@ -0,0 +1,48 @@
+export function toIncludeAllMembersInOrder(actual, expected) {
+  const options = {
+    isNot: this.isNot,
+    promise: this.promise,
+  };
+
+  // First, check contents.
+  if (this.isNot) {
+    expect(actual).not.toIncludeAllMembers(expected);
+  } else {
+    expect(actual).toIncludeAllMembers(expected);
+  }
+
+  // Second, check order. At this point, they must have the same length, so we
+  // can go element by element and fail at the first elements that don't
+  // match.
+  const differingElementIdxs = expected
+    .map((element, idx) => {
+      return this.equals(element, actual[idx]) ? false : idx;
+    })
+    .filter(idx => idx !== false);
+
+  const pass = differingElementIdxs.length === 0;
+
+  const message = pass
+    ? () =>
+        // eslint-disable-next-line prefer-template
+        this.utils.matcherHint('toIncludeAllMembersInOrder', undefined, undefined, options) +
+        '\n\n' +
+        `Expected: not ${this.utils.printExpected(expected)}\n` +
+        `Received: ${this.utils.printReceived(actual)}`
+    : () => {
+        const firstDifferingElementIdx = differingElementIdxs[0];
+        const firstDifferingElementInActual = actual[firstDifferingElementIdx];
+        const firstDifferingElementInExpected = expected[firstDifferingElementIdx];
+
+        return (
+          // eslint-disable-next-line prefer-template
+          this.utils.matcherHint('toIncludeAllMembersInOrder', undefined, undefined, options) +
+          '\n\n' +
+          `First differing element (index ${firstDifferingElementIdx}):\n\n` +
+          `Expected: ${this.utils.printExpected(firstDifferingElementInExpected)}\n` +
+          `Received: ${this.utils.printReceived(firstDifferingElementInActual)}`
+        );
+      };
+
+  return { actual, message, pass };
+}