var arrayDiff = require('arraydiff-papandreou'); function extend(target) { for (var i = 1; i < arguments.length; i += 1) { var source = arguments[i]; Object.keys(source).forEach(function (key) { target[key] = source[key]; }); } return target; } module.exports = function arrayChanges(actual, expected, equal, similar, options) { if (Array.isArray(options) || typeof options === 'boolean') { throw new Error([ 'It looks like you are using arrayChanges includeNonNumericalProperties,', 'the API has changed. You need to supply it as an entry to an option object:', 'arrayChanges(actual, expected, equal, similar, {', ' includeNonNumericalProperties: ["foo", "bar"]', '})' ].join('\n')); } options = options || {}; var includeNonNumericalProperties = options.includeNonNumericalProperties; var fallbackToItemByItemDiff = 'fallbackToItemByItemDiff' in options ? options.fallbackToItemByItemDiff : true; var mutatedArray = new Array(actual.length); for (var k = 0; k < actual.length; k += 1) { mutatedArray[k] = { type: 'similar', value: actual[k], actualIndex: k }; } equal = equal || function (a, b) { return a === b; }; similar = similar || function (a, b) { return false; }; var itemsDiff = arrayDiff(Array.prototype.slice.call(actual), Array.prototype.slice.call(expected), function (a, b, aIndex, bIndex) { return equal(a, b, aIndex, bIndex) || similar(a, b, aIndex, bIndex); }); function offsetIndex(index) { var offsetIndex = 0; var i; for (i = 0; i < mutatedArray.length && offsetIndex < index; i += 1) { if (mutatedArray[i].type !== 'remove' && mutatedArray[i].type !== 'moveSource') { offsetIndex++; } } return i; } function findMoveTargetWithId(id) { return mutatedArray.find(function (diffItem) { return diffItem.type === 'moveTarget' && diffItem.id === id; }); } var removes = itemsDiff.filter(function (diffItem) { return diffItem.type === 'remove'; }); var removedItems = 0; removes.forEach(function (diffItem) { var removeIndex = removedItems + diffItem.index; mutatedArray.slice(removeIndex, diffItem.howMany + removeIndex).forEach(function (v) { v.type = 'remove'; }); removedItems += diffItem.howMany; }); var moves = itemsDiff.filter(function (diffItem) { return diffItem.type === 'move'; }); var ids = 0; moves.forEach(function (diffItem) { var moveFromIndex = offsetIndex(diffItem.from + 1) - 1; var removed = mutatedArray.slice(moveFromIndex, diffItem.howMany + moveFromIndex); removed.forEach(function (v, index) { v.type = 'moveSource'; v.id = ids++; }); var added = removed.map(function (v, index) { return extend({}, v, { last: false, type: 'moveTarget' }); }); var insertIndex = offsetIndex(diffItem.to); Array.prototype.splice.apply(mutatedArray, [insertIndex, 0].concat(added)); }); var inserts = itemsDiff.filter(function (diffItem) { return diffItem.type === 'insert'; }); inserts.forEach(function (diffItem) { var added = new Array(diffItem.values.length); for (var i = 0; i < diffItem.values.length; i += 1) { added[i] = { type: 'insert', value: diffItem.values[i], expectedIndex: diffItem.index }; } var insertIndex = offsetIndex(diffItem.index); Array.prototype.splice.apply(mutatedArray, [insertIndex, 0].concat(added)); }); var offset = 0; mutatedArray.forEach(function (diffItem, index) { var type = diffItem.type; if (type === 'moveTarget') { diffItem.expected = expected[offset + index]; diffItem.expectedIndex = offset + index; diffItem.equal = equal(diffItem.value, diffItem.expected); } else if (type === 'remove' || type === 'moveSource') { offset -= 1; } else if (type === 'similar') { diffItem.expected = expected[offset + index]; diffItem.expectedIndex = offset + index; } }); mutatedArray.forEach(function (diffItem) { if (diffItem.type === 'moveSource') { var moveTarget = findMoveTargetWithId(diffItem.id); diffItem.expected = moveTarget.expected; diffItem.expectedIndex = moveTarget.expectedIndex; diffItem.equal = moveTarget.equal; } }); var conflicts = mutatedArray.reduce(function (conflicts, item) { return item.type === 'similar' || item.type === 'moveSource' || item.type === 'moveTarget' ? conflicts : conflicts + 1; }, 0); if (fallbackToItemByItemDiff) { var c, i; for (i = 0, c = 0; i < Math.max(actual.length, expected.length) && c <= conflicts; i += 1) { if ( i >= actual.length || i >= expected.length || (!equal(actual[i], expected[i], i, i) && !similar(actual[i], expected[i], i, i)) ) { c += 1; } } if (c <= conflicts) { mutatedArray = []; var j; for (j = 0; j < Math.min(actual.length, expected.length); j += 1) { mutatedArray.push({ type: 'similar', value: actual[j], expected: expected[j], actualIndex: j, expectedIndex: j }); } if (actual.length < expected.length) { for (; j < Math.max(actual.length, expected.length); j += 1) { mutatedArray.push({ type: 'insert', value: expected[j], expectedIndex: j }); } } else { for (; j < Math.max(actual.length, expected.length); j += 1) { mutatedArray.push({ type: 'remove', value: actual[j], actualIndex: j }); } } } } mutatedArray.forEach(function (diffItem) { if (diffItem.type === 'similar' && equal(diffItem.value, diffItem.expected, diffItem.actualIndex, diffItem.expectedIndex)) { diffItem.type = 'equal'; } }); if (includeNonNumericalProperties) { var nonNumericalKeys; if (Array.isArray(includeNonNumericalProperties)) { nonNumericalKeys = includeNonNumericalProperties; } else { var isSeenByNonNumericalKey = {}; nonNumericalKeys = []; [actual, expected].forEach(function (obj) { Object.keys(obj).forEach(function (key) { if (!/^(?:0|[1-9][0-9]*)$/.test(key) && !isSeenByNonNumericalKey[key]) { isSeenByNonNumericalKey[key] = true; nonNumericalKeys.push(key); } }); if (Object.getOwnPropertySymbols) { Object.getOwnPropertySymbols(obj).forEach(function (symbol) { if (!isSeenByNonNumericalKey[symbol]) { isSeenByNonNumericalKey[symbol] = true; nonNumericalKeys.push(symbol); } }); } }); } nonNumericalKeys.forEach(function (key) { var valueExpected; if (key in actual) { var valueActual = actual[key]; valueExpected = expected[key]; if (key in expected && typeof valueExpected !== 'undefined') { valueExpected = expected[key]; mutatedArray.push({ type: equal(valueActual, valueExpected, key, key) ? 'equal' : 'similar', expectedIndex: key, actualIndex: key, value: valueActual, expected: valueExpected }); } else if (typeof valueActual !== 'undefined') { mutatedArray.push({ type: 'remove', actualIndex: key, value: valueActual }); } } else { valueExpected = expected[key]; if (typeof valueExpected !== 'undefined') { mutatedArray.push({ type: 'insert', expectedIndex: key, value: valueExpected }); } } }); } if (mutatedArray.length > 0) { mutatedArray[mutatedArray.length - 1].last = true; } return mutatedArray; };