Add support for testing Blade components (#27)

* Add support for testing Blade components

Author: ziadoz

README.md

@@ -382,6 +382,16 @@ $this->view('navigation')
     });
 ```
 
+### Usage with Blade components
+```php
+$this->component(Navigation::class)
+    ->assertElementExists('nav > ul', function(AssertElement $ul) {
+        $ul->contains('li', [
+            'class' => 'active',
+        ]);
+    });
+```
+
 ## Overview of methods
 | Base methods                                   | Description                                                                          |
 |------------------------------------------------|--------------------------------------------------------------------------------------|

composer.json

@@ -24,7 +24,8 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Tests\\": "tests/"
+            "Tests\\": "tests/",
+            "Tests\\Views\\Components\\": "tests/views/components"
         }
     },
     "extra": {

src/DomAssertionsServiceProvider.php

@@ -3,6 +3,8 @@
 namespace Sinnbeck\DomAssertions;
 
 use Illuminate\Support\ServiceProvider;
+use Illuminate\Support\Traits\Macroable;
+use Illuminate\Testing\TestComponent;
 use Illuminate\Testing\TestResponse;
 use Illuminate\Testing\TestView;
 
@@ -13,6 +15,11 @@ public function boot()
         if ($this->app->runningUnitTests()) {
             TestResponse::mixin(new TestResponseMacros);
             TestView::mixin(new TestViewMacros);
+
+            // https://github.com/laravel/framework/pull/54359
+            if (in_array(Macroable::class, class_uses(TestComponent::class) ?? [])) {
+                TestComponent::mixin(new TestComponentMacros);
+            }
         }
     }
 }

src/TestComponentMacros.php

@@ -0,0 +1,125 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sinnbeck\DomAssertions;
+
+use Closure;
+use DOMException;
+use Illuminate\Testing\TestComponent;
+use PHPUnit\Framework\Assert;
+use Sinnbeck\DomAssertions\Asserts\AssertElement;
+use Sinnbeck\DomAssertions\Asserts\AssertForm;
+use Sinnbeck\DomAssertions\Support\DomParser;
+
+/**
+ * @internal
+ *
+ * @mixin TestComponent
+ */
+class TestComponentMacros
+{
+    public function assertHtml5(): Closure
+    {
+        return function () {
+            /** @var TestComponent $this */
+            Assert::assertNotEmpty(
+                (string) $this->rendered,
+                'The component is empty!'
+            );
+
+            try {
+                $parser = DomParser::new((string) $this->rendered);
+            } catch (DOMException $exception) {
+                Assert::fail($exception->getMessage());
+            }
+
+            Assert::assertEquals(
+                'html',
+                $parser->getDocType(),
+                'Not a html5 doctype!'
+            );
+
+            return $this;
+        };
+    }
+
+    public function assertElementExists(): Closure
+    {
+        return function ($selector = 'body', $callback = null): TestComponent {
+            /** @var TestComponent $this */
+            Assert::assertNotEmpty(
+                (string) $this->rendered,
+                'The component is empty!'
+            );
+
+            try {
+                $parser = DomParser::new((string) $this->rendered);
+            } catch (DOMException $exception) {
+                Assert::fail($exception->getMessage());
+            }
+
+            if ($selector instanceof Closure) {
+                $callback = $selector;
+                $selector = 'body';
+            }
+
+            if (is_string($selector)) {
+                $element = $parser->query($selector);
+            } else {
+                Assert::fail('Invalid selector!');
+            }
+
+            Assert::assertNotNull($element, sprintf('No element found with selector: %s', $selector));
+
+            if ($callback) {
+                $callback(new AssertElement((string) $this->rendered, $element));
+            }
+
+            return $this;
+        };
+    }
+
+    public function assertFormExists(): Closure
+    {
+        return function ($selector = 'form', $callback = null): TestComponent {
+            /** @var TestComponent $this */
+            Assert::assertNotEmpty(
+                (string) $this->rendered,
+                'The component is empty!'
+            );
+
+            try {
+                $parser = DomParser::new((string) $this->rendered);
+            } catch (DOMException $exception) {
+                Assert::fail($exception->getMessage());
+            }
+
+            if ($selector instanceof Closure) {
+                $callback = $selector;
+                $selector = 'form';
+            }
+
+            if (is_string($selector)) {
+                $form = $parser->query($selector);
+            } else {
+                Assert::fail('Invalid selector!');
+            }
+
+            Assert::assertNotNull(
+                $form,
+                sprintf('No form was found with selector "%s"', $selector)
+            );
+            Assert::assertEquals(
+                'form',
+                $form->nodeName,
+                'Element is not of type form!');
+
+            if ($callback) {
+                $callback(new AssertForm((string) $this->rendered, $form));
+            }
+
+            return $this;
+        };
+    }
+}

src/TestResponseMacros.php

@@ -19,7 +19,7 @@
  */
 class TestResponseMacros
 {
-    public function assertHtml5()
+    public function assertHtml5(): Closure
     {
         return function () {
             /** @var TestResponse $this */

src/TestViewMacros.php

@@ -19,7 +19,7 @@
  */
 class TestViewMacros
 {
-    public function assertHtml5()
+    public function assertHtml5(): Closure
     {
         return function () {
             /** @var TestView $this */