[LiveComponent] Add events assertions in InteractsWithLiveComponents

[Arkalo2]

Q	A
Bug fix?	no
New feature?	yes
Docs?	yes
Issues	no
License	MIT

This MR simplify liveComponent event testing :
Actually with the Test Helper, we can't simply test whether an event has been dispatched from a component.
This PR add 2 asserts :

$this-> assertComponentEmitEvent($render, 'event-name')->withData(['eventArg1' => $eventArg1]);
$this-> assertComponentEmitEvent($render, 'event-name')
    ->withDataSubset(['eventArg1' => $eventArg1])
    ->withDataSubset(['eventArg2' => $eventArg2])
;

$this->assertComponentNotEmitEvent($render, 'event-name');

[kbond]

Good idea!

[Kocal]

Minor wordings and types, but otherwise that's fine, thanks :)

[Kocal]

It will helps by displaying a nice diff between expected vs actual data:

Suggested change

	foreach ($parameters as $key => $value) {
	$this->assertSame($value, $eventData['data'][$key] ?? null, \sprintf('EventData (%s) is not valid', $key));
	}
	$this->assertEquals(expectedEventData, $event['data'], sprintf('The expected event "%s" data does not match.', $eventName));

[Arkalo2]

Yep but with the global assertEquals, we must pass all expectedEventDatas.

If the event contains ['a' => 'b', 'c' => 'd'];
And I expect only ['a' => 'b'];
It throw an error.

[Kocal]

That's true, but I think that's the desired behavior. Asserting the whole event data makes more sense to me, but I may be biaised and I understand that sometimes you expect to assert an array subset, but it must be explicit.

I've seen it tons of time on multiple projects, where sometimes you assert everything, or sometimes only a subset, and every time that's a mess because the method-name / PHPUnit's way of working does not help.

I can suggest you this, so everyone would be happy:

// classic way
$this->assertComponentEmitEvent($component, 'foo'); // do not care about event data
$this->assertComponentEmitEventWithData($component, 'foo', []); // assert whole array
$this->assertComponentEmitEventWithDataSubset($component, 'foo', []); // assert subset array

// or a bit exotic 
$this->assertComponentEmitEvent($component, 'foo'); // do not care about event data
$this->assertComponentEmitEvent($component, 'foo')->withData([]); // assert whole array
$this->assertComponentEmitEvent($component, 'foo')->withDataSubset([]); // assert subset array

WDYT?

[kbond]

// or a bit exotic
$this->assertComponentEmitEvent($component, 'foo'); // do not care about event data
$this->assertComponentEmitEvent($component, 'foo')->withData([]); // assert whole array
$this->assertComponentEmitEvent($component, 'foo')->withDataSubset([]); // assert subset array

I personally LOVE this! 😍

[Arkalo2]

I tested the ->with implementation

[Arkalo2]

An anonym class is enough or I have to separate it ?

The limit of the anonyme class is the dot block : I can not chained the ->with

[Kocal]

A separate concrete class please :)

[Kocal]

Rebased, squashed, some rewords, changelog updated and some documentation fixed 💅🏻

[Kocal]

Thanks @Arkalo2.