Add t.unorderedEqual() assertion

[tommy-mitchell]

Closes #3020

Adds a new assertion for testing equality in an unordered manner between two Maps or two Sets/Arrays:

test('unorderedEqual', t => {
	t.unorderedEqual([1, 2, 3], new Set([2, 3, 1]));

	t.unorderedEqual(
		new Map([['a', 1], ['b', 2], ['c', 3]]),
		new Map([['b', 2], ['c', 3], ['a', 1]]),
		'Map keys should be equal!',
	);
});

---

Todos:

• Improve error messages, format values with concordance
• Improve types (e.g. Actual extends Map | Set | Array)
  • Add type tests
• Fix failing tests

[novemberborn]

I think we could make this more generic, require both values to have an entries() method that returns an Iterator. Each result should then be an array with a key and a value.

You can make a map of the results for expected and then iterate through actual.

If we want we could then still require both values to have the same constructor but it may be interesting not to.

[novemberborn]

Could you clarify the differences with deepEqual?

[tommy-mitchell]

Thoughts?

Assert that all values in actual are in expected. This is a variant of .deepEqual() that does not depend
on the order of actual/expected and only compares instances of Maps or Sets/arrays.

The size of actual and expected must be equal. For Maps, each key-value pair in actual must be in
expected, and vice-versa. For Sets/arrays, each value in actual must be in expected.

Returns true if the assertion passed and throws otherwise.

[novemberborn]

Here too let's clarify the differences with deepEqual.

[novemberborn]

I think this should be the message argument. You can then do something like this:

ava/lib/assert.js

Lines 332 to 333 in a39dab0

	raw: {actual, expected},
	values: [formatDescriptorWithLabel('Values are deeply equal to each other, but they are not the same:', actualDescriptor)],

[novemberborn]

Did you mean:

Suggested change

	const comparedKeysResult = concordance.compare(actual.keys, expected.keys, concordanceOptions);
	const comparedKeysResult = concordance.compare(actual.keys(), expected.keys(), concordanceOptions);

Of course that returns an iterator, which Concordance may walk over (can't recall), but the keys won't be in the same order.

If both values have the same size, then you probably don't need this?

[tommy-mitchell]

Agh - the joys of plain JavaScript.

If both values have the same size, then you probably don't need this?

Good catch, I think you're right as well.

[novemberborn]

Please re-open if you have a chance to return to this.

[tommy-mitchell]

@novemberborn I don't think I can reopen by myself.

[novemberborn]

I don't think I can reopen by myself.

@tommy-mitchell done!