Add withData and withDataSubset functions

Author: Arkalo2

src/LiveComponent/src/Test/InteractsWithLiveComponents.php

@@ -45,30 +45,40 @@ protected function createLiveComponent(string $name, array $data = [], ?KernelBr
         );
     }
 
-    protected function assertComponentEmitEvent(TestLiveComponent $testLiveComponent, string $expectedEventName, ?array $expectedEventData = null): void
+    protected function assertComponentEmitEvent(TestLiveComponent $testLiveComponent, string $expectedEventName): object
     {
         $event = $testLiveComponent->getEmittedEvent($testLiveComponent->render(), $expectedEventName);
 
         $this->assertNotNull($event, \sprintf('The component "%s" did not emit event "%s".', $testLiveComponent->getName(), $expectedEventName));
 
-        if (null === $expectedEventData) {
-            return;
-        }
+        return new class($this, $event['event'], $event['data']) {
+            /**
+             * @param array<string, int|float|string|bool|null> $data
+             */
+            public function __construct(private KernelTestCase $parent, private readonly string $eventName, private readonly array $data) {}
 
-        foreach ($expectedEventData as $key => $value) {
-            $this->assertArrayHasKey($key, $event['data'], \sprintf('The expected event "%s" data "%s" does not exists', $event['event'], $key));
-            $this->assertSame(
-                $value,
-                $event['data'][$key],
-                \sprintf(
-                    'The expected event "%s" data "%s" expected "%s" but "%s" given',
-                    $event['event'],
-                    $key,
-                    $value,
-                    $event['data'][$key]
-                )
-            );
-        }
+            public function withDataSubset(array $expectedEventData): void
+            {
+                foreach ($expectedEventData as $key => $value) {
+                    $this->parent->assertArrayHasKey($key, $this->data, \sprintf('The expected event "%s" data "%s" does not exists', $this->eventName, $key));
+                    $this->parent->assertSame(
+                        $value,
+                        $this->data[$key],
+                        \sprintf(
+                            'The expected event "%s" data "%s" expected "%s" but "%s" given',
+                            $this->eventName,
+                            $key,
+                            $value,
+                            $this->data[$key]
+                        )
+                    );
+                }
+            }
+            public function withData(array $expectedEventData): void
+            {
+                $this->parent->assertEquals($expectedEventData, $this->data, sprintf('The expected event "%s" data does not match.', $this->eventName));
+            }
+        };
     }
 
     protected function assertComponentNotEmitEvent(TestLiveComponent $testLiveComponent, string $eventName): void

src/LiveComponent/tests/Fixtures/Component/ComponentWithEmit.php

@@ -29,7 +29,7 @@ final class ComponentWithEmit
     #[LiveAction]
     public function actionThatEmits(): void
     {
-        $this->emit('event1', ['foo' => 'bar']);
+        $this->emit('event1', ['foo' => 'bar', 'bar' => 'foo']);
         $this->events = $this->liveResponder->getEventsToEmit();
     }
 

src/LiveComponent/tests/Functional/LiveResponderTest.php

@@ -35,7 +35,7 @@ public function testComponentCanEmitEvents(): void
             ])
             ->assertSuccessful()
             ->assertSee('Event: event1')
-            ->assertSee('Data: {"foo":"bar"}');
+            ->assertSee('Data: {"foo":"bar","bar":"foo"}');
     }
 
     public function testComponentCanDispatchBrowserEvents(): void

src/LiveComponent/tests/Functional/Test/InteractsWithLiveComponentsTest.php

@@ -219,61 +219,73 @@ public function testSetLocaleRenderLocalizedComponent(): void
         $this->assertStringContainsString('Locale: de', $testComponent->render());
     }
 
-    public function testComponentEmitsExpectedEventWithExpectedEventData(): void
+    public function testComponentEmitsExpectedEventData(): void
     {
         $testComponent = $this->createLiveComponent('component_with_emit');
 
         $testComponent->call('actionThatEmits');
 
-        $this->assertComponentEmitEvent($testComponent, 'event1', [
+        $this->assertComponentEmitEvent($testComponent, 'event1')->withData([
             'foo' => 'bar',
+            'bar' => 'foo',
         ]);
     }
 
-    public function testComponentDoesNotEmitUnexpectedEvent(): void
+    public function testComponentEmitsExpectedEventDataFails(): void
     {
         $testComponent = $this->createLiveComponent('component_with_emit');
 
         $testComponent->call('actionThatEmits');
 
-        $this->assertComponentNotEmitEvent($testComponent, 'event2');
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessage('The expected event "event1" data does not match');
+        $this->assertComponentEmitEvent($testComponent, 'event1')->withData([
+            'foo' => 'bar',
+        ]);
     }
 
-    public function testComponentDoesNotEmitUnexpectedEventFails(): void
+    public function testComponentEmitsExpectedPartialEventData(): void
     {
         $testComponent = $this->createLiveComponent('component_with_emit');
 
         $testComponent->call('actionThatEmits');
 
-        $this->expectException(AssertionFailedError::class);
-        $this->expectExceptionMessage('The component "component_with_emit" did not emit event "event1".');
-        $this->assertComponentNotEmitEvent($testComponent, 'event1');
+        $this->assertComponentEmitEvent($testComponent, 'event1')->withDataSubset([
+            'foo' => 'bar',
+        ]);
+    }
+
+    public function testComponentDoesNotEmitUnexpectedEvent(): void
+    {
+        $testComponent = $this->createLiveComponent('component_with_emit');
+
+        $testComponent->call('actionThatEmits');
+
+        $this->assertComponentNotEmitEvent($testComponent, 'event2');
     }
 
-    public function testComponentEmitsEventWithNotFoundExpectedDataFails(): void
+    public function testComponentDoesNotEmitUnexpectedEventFails(): void
     {
         $testComponent = $this->createLiveComponent('component_with_emit');
 
         $testComponent->call('actionThatEmits');
 
         $this->expectException(AssertionFailedError::class);
-        $this->expectExceptionMessage('The expected event "event1" data "foo2" does not exists');
-        $this->assertComponentEmitEvent($testComponent, 'event1', [
-            'foo' => 'bar',
-            'foo2' => 'bar2',
-        ]);
+        $this->expectExceptionMessage('The component "component_with_emit" did not emit event "event1".');
+        $this->assertComponentNotEmitEvent($testComponent, 'event1');
     }
 
-    public function testComponentEmitsEventWithNotValidExpectedDataFails(): void
+    public function testComponentEmitsEventWithIncorrectDataFails(): void
     {
         $testComponent = $this->createLiveComponent('component_with_emit');
 
         $testComponent->call('actionThatEmits');
 
         $this->expectException(AssertionFailedError::class);
-        $this->expectExceptionMessage('The expected event "event1" data "foo" expected "bar2" but "bar" given');
-        $this->assertComponentEmitEvent($testComponent, 'event1', [
-            'foo' => 'bar2',
+        $this->expectExceptionMessage('The expected event "event1" data does not match.');
+        $this->assertComponentEmitEvent($testComponent, 'event1')->withData([
+            'foo' => 'bar',
+            'foo2' => 'bar2',
         ]);
     }
 }