chore: Replace atLeastAndMostLike by constrainedArrayLike

[tienvx]

Old description

atLeastAndMostLike is my invention from #310, and I don't think it's useful. Instead, I replace it with arrayLike (which is also my invention).

arrayLike do what atLeastAndMostLike do, which is checking both min and max, but it also:

• Allow any array as example value (so example value doesn't need to be a value appear multiple times)
• Allow min = 0 (in this case example value doesn't need to be empty array)
• Min can be null
• Max can be null
• Min and max can be both null (now it become $matcher->like())
• Min and max are not null (atLeastAndMostLike above)

for example (UPDATED):

$fatherUuid = '67b06dc7-af63-41c7-b011-f9bbbe6f5d45';
$motherUuid = '73778b18-f6de-4193-9b5d-970b9a5aacb5';
$childUuid = '977e35b8-ded1-4380-b206-b64c0bc0a312';
$user = [
    'id' => $matcher->uuid($childUuid),
    'gender' => $matcher->regex('male', 'male|female|other'),
    'firstName' => $macher->like('Bettye'),
    'lastName' => $macher->like('Johnston'),
    'birthday' => $matcher->date('yyyy-MM-dd', '2022-11-21'),
    'relationships' => $matcher->like([
        'spouses' => $matcher->arrayLike([$matcher->uuid('b21536d9-b0e4-4475-b9bc-b6d1d0716ba0')], 0),
        'father' => $matcher->uuid($fatherUuid),
        'mother' => $matcher->uuid($motherUuid),
        'children' => $matcher->arrayLike([$matcher->uuid('fb08f967-830b-4c09-a9ea-716a37b8fd85')], 0),
    ]),
];
$father = [
    'id' => $fatherUuid,
    'gender' => 'male',
    'firstName' => 'Deonte',
    'lastName' => 'Zulauf',
    'birthday' =>  '1970-11-21',
    'relationships' => $matcher->like([
        'spouses' => [$motherId],
        'father' => null,
        'mother' => null,
        'children' => [$childUuid],
    ]),
];
$mother = [
    'id' => $motherUuid,
    'gender' => 'female',
    'firstName' => 'Delpha',
    'lastName' => 'Ryan',
    'birthday' =>  '1986-11-21',
    'relationships' => $matcher->like([
        'spouses' => [$fatherUuid],
        'father' => null,
        'mother' => null,
        'children' => [$childUuid],
    ]),
];
$users = $matcher->arrayLike([
    $user,
    $father,
    $mother
], 1)

Link to specifications:

• https://github.com/pact-foundation/pact-specification/tree/version-4#supported-matching-rules
• https://github.com/pact-foundation/pact-specification/tree/version-3#supported-matchers
• https://github.com/pact-foundation/pact-specification/tree/version-2#supported-matchers

Code taken from pact-js

[mefellows]

Hey Tien,

Allow min = 0 (in this case example value doesn't need to be empty array)

This scenario is not allowed, see https://docs.pact.io/faq#why-is-there-no-support-for-specifying-optional-attributes.

I'd suggest modelling based on the names here, for consistency across languages: https://github.com/pact-foundation/pact-js/blob/master/src/v3/matchers.ts

[tienvx]

I updated my example so it make more sense why I use min = 0 there

This scenario is not allowed, see https://docs.pact.io/faq#why-is-there-no-support-for-specifying-optional-attributes.

Yes, I agree with it. But it's a pain to implement it. e.g. I will need to split a single test to multiple tests:

• Users with/without spouses
• Users with/without father
• Users with/without mother
• Users with/without children

I tried min = 0 and it still work, so I need to check is it a bug or not.

I'd suggest modelling based on the names here, for consistency across languages: https://github.com/pact-foundation/pact-js/blob/master/src/v3/matchers.ts

Let me mark this PR Draft for now, I will continue trying to make pact-php more consistent with pact-js

[YOU54F]

Looks good to me,

Could we update the matchers docs for this matcher

https://github.com/pact-foundation/pact-php/blob/ffi/README.md?plain=1#L154

example from the pact-js

https://github.com/pact-foundation/pact-js/blob/38a68fb4569a20f54160333498b8b0bc20ec7838/docs/matching.md?plain=1#L218

Note:- probably need to update the all the matchers there but can do that in a sep PR

[YOU54F]

Just a suggestion on updating README, otherwise great work

[YOU54F]

Just requesting your eyes across this @mefellows

[tienvx]

Update README.md with constrainedArrayLike matcher only

[YOU54F]

Thanks @tienvx

I'll get this merged and then get 10.0.0-alpha2 out for you

[mefellows]

Thanks, the constrained version of the function looks OK to me

Yes, I agree with it. But it's a pain to implement it. e.g. I will need to split a single test to multiple tests:

Yes, it is, but that's kind of the price you pay for those guarantees :)