[Live] add test helper

Author: kbond

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 2.11.0
 
 -   Support ...spread operator with html syntax (requires Twig 3.7.0 or higher)
+-   Add `RenderedComponent::crawler()` and `toString()` methods.
 
 ## 2.9.0
 

composer.json

@@ -34,6 +34,8 @@
         "twig/twig": "^2.14.7|^3.0.4"
     },
     "require-dev": {
+        "symfony/css-selector": "^5.4|^6.0",
+        "symfony/dom-crawler": "^5.4|^6.0",
         "symfony/framework-bundle": "^5.4|^6.0",
         "symfony/phpunit-bridge": "^6.0",
         "symfony/stimulus-bundle": "^2.9.1",

doc/index.rst

@@ -1078,6 +1078,9 @@ You can test how your component is mounted and rendered using the
             );
 
             $this->assertStringContainsString('bar', $rendered);
+
+            // use the crawler
+            $this->assertCount(5, $rendered->crawler('ul li'));
         }
 
         public function testEmbeddedComponentRenders(): void

src/Test/RenderedComponent.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\UX\TwigComponent\Test;
 
+use Symfony\Component\DomCrawler\Crawler;
+
 /**
  * @author Kevin Bond <[email protected]>
  */
@@ -23,6 +25,20 @@ public function __construct(private string $html)
     {
     }
 
+    public function crawler(): Crawler
+    {
+        if (!class_exists(Crawler::class)) {
+            throw new \LogicException(sprintf('"symfony/dom-crawler" is required to use "%s()" (install with "composer require symfony/dom-crawler").', __METHOD__));
+        }
+
+        return new Crawler($this->html);
+    }
+
+    public function toString(): string
+    {
+        return $this->html;
+    }
+
     public function __toString(): string
     {
         return $this->html;

tests/Fixtures/templates/components/component_a.html.twig

@@ -1,3 +1,8 @@
 propA: {{ propA }}
 propB: {{ this.propB }}
 service: {{ this.service.value }}
+
+<ul>
+    <li>foo</li>
+    <li>bar</li>
+</ul>

tests/Integration/Test/InteractsWithTwigComponentsTest.php

@@ -50,6 +50,7 @@ public function testCanRenderComponent(string $name): void
         $this->assertStringContainsString('propA: prop a value', $rendered);
         $this->assertStringContainsString('propB: prop b value', $rendered);
         $this->assertStringContainsString('service: service a value', $rendered);
+        $this->assertCount(2, $rendered->crawler()->filter('ul li'));
     }
 
     /**