[8.x] Add whereHas AssertableJson method

[stevebauman]

Description

This method adds a whereHas($key, $values) method to the AssertableJson class.

Purpose

When running tests, I've found it difficult to test whether a JSON array contains a set of values, as well as out-of-order results that I don't have fine-tuned control over their sorting.

This new method is helpful when testing a JSON endpoint that returns database results, as you can test that a nested set of arrays contain all of the values/ID's you're expecting, in any order.

Comparisons are performed in a strict manner to follow suit with the other methods in the AssertableJson class. Let me know if this should be adjusted!

Example

With array of values:

$assert = AssertableJson::fromArray([
    'foo' => [1,2,3],
    'bar' => 'baz',
]);

// Passes:
$assert->whereHas('foo', 1);
$assert->whereHas('foo', [2,3]);
$assert->whereHas('bar', 'baz');

// Fails:
$assert->whereHas('foo', '1'); // Property [foo] does not contain [1].
$assert->whereHas('foo', 4); // Property [foo] does not contain [4].
$assert->whereHas('foo', [3,4]); // Property [foo] does not contain [4].
$assert->whereHas('bar', ['bar','baz']); // Property [bar] does not contain [bar].

With array of nested values:

$assert = AssertableJson::fromArray([
    ['id' => 1],
    ['id' => 2],
    ['id' => 3],
    ['id' => 4],
]);

// Passes:
$assert->whereHas('id', 1);
$assert->whereHas('id', [1,2,3,4]);
$assert->whereHas('id', [4,3,2,1]);

// Fails:
$assert->whereHas('id', '1'); // Property [id] does not contain [1].
$assert->whereHas('id', 5); // Property [id] does not contain [5].
$assert->whereHas('id', [1,2,3,4,5]); // Property [id] does not contain [5].
$assert->whereHas('id', [1,2,3,4,5,6]); // Property [id] does not contain [5, 6].

Possible edge case:

$assert = AssertableJson::fromArray([
    'foo' => 'bar',
]);

// Passes:
$assert->whereHas('foo', null);

Thanks so much for your time reviewing this. No hard feelings on closure 👍

[claudiodekker]

Thanks @stevebauman 🙂 👍

[stevebauman]

Happy to help @claudiodekker! 😄

[georgebohnisch]

This is great! Thanks!