tests: adding inline view and livewire component tests

Author: EJ-OB

tests/LayoutTest.php

@@ -2,12 +2,15 @@
 
 namespace Yajra\DataTables\Html\Tests;
 
-use Illuminate\Support\Facades\View;
 use InvalidArgumentException;
+use Livewire\Exceptions\ComponentNotFoundException;
 use PHPUnit\Framework\Attributes\Test;
 use Yajra\DataTables\Html\Builder;
 use Yajra\DataTables\Html\Enums\LayoutPosition;
 use Yajra\DataTables\Html\Layout;
+use Yajra\DataTables\Html\Tests\TestComponents\TestInlineView;
+use Yajra\DataTables\Html\Tests\TestComponents\TestLivewire;
+use Yajra\DataTables\Html\Tests\TestComponents\TestView;
 
 class LayoutTest extends TestCase
 {
@@ -185,8 +188,6 @@ public function it_can_accept_js_selector_for_layout_content(): void
     #[Test]
     public function it_can_accept_view_instance_or_string_for_layout_content(): void
     {
-        View::addLocation(__DIR__.'/TestBlade');
-
         $builder = resolve(Builder::class);
 
         $view = view('test-view');
@@ -196,25 +197,49 @@ public function it_can_accept_view_instance_or_string_for_layout_content(): void
                 view: $view,
                 layoutPosition: LayoutPosition::TopStart,
                 order: 1
-            )->addView(
+            )
+            ->addView(
                 view: 'test-view',
                 layoutPosition: LayoutPosition::BottomEnd,
                 order: 2
-            ));
+            )
+            ->addView(
+                view: (new TestView())->render(),
+                layoutPosition: LayoutPosition::Top,
+                order: 3
+            )
+            ->addView(
+                view: (new TestInlineView())->render(),
+                layoutPosition: LayoutPosition::Bottom,
+                order: 4
+            )
+        );
 
         $this->assertArrayHasKey('layout', $builder->getAttributes());
+
         $this->assertArrayHasKey('top1Start', $builder->getAttributes()['layout']);
         $this->assertEquals(
             'function() { return '.json_encode($view->render()).'; }',
             $builder->getAttributes()['layout']['top1Start']
         );
 
-        $this->assertArrayHasKey('layout', $builder->getAttributes());
         $this->assertArrayHasKey('bottom2End', $builder->getAttributes()['layout']);
         $this->assertEquals(
             'function() { return '.json_encode($view->render()).'; }',
             $builder->getAttributes()['layout']['bottom2End']
         );
+
+        $this->assertArrayHasKey('top3', $builder->getAttributes()['layout']);
+        $this->assertEquals(
+            'function() { return '.json_encode($view->render()).'; }',
+            $builder->getAttributes()['layout']['top3']
+        );
+
+        $this->assertArrayHasKey('bottom4', $builder->getAttributes()['layout']);
+        $this->assertEquals(
+            'function() { return '.json_encode('<p>Test Inline View</p>').'; }',
+            $builder->getAttributes()['layout']['bottom4']
+        );
     }
 
     #[Test]
@@ -234,4 +259,39 @@ public function it_throws_an_exception_if_the_view_does_not_exist_when_adding_vi
                 layoutPosition: LayoutPosition::Bottom,
             ));
     }
+
+    #[Test]
+    public function it_can_accept_livewire_component_as_layout_content(): void
+    {
+        $builder = resolve(Builder::class);
+        $builder->layout(fn (Layout $layout) => $layout
+            ->addLivewire(TestLivewire::class, LayoutPosition::TopStart, 1)
+            ->addLivewire(TestLivewire::class, LayoutPosition::BottomEnd, 2));
+
+        $this->assertArrayHasKey('layout', $builder->getAttributes());
+        $this->assertArrayHasKey('top1Start', $builder->getAttributes()['layout']);
+        $this->assertStringContainsString(
+            'test livewire',
+            $builder->getAttributes()['layout']['top1Start']
+        );
+
+        $this->assertArrayHasKey('layout', $builder->getAttributes());
+        $this->assertArrayHasKey('bottom2End', $builder->getAttributes()['layout']);
+        $this->assertStringContainsString(
+            'test livewire',
+            $builder->getAttributes()['layout']['bottom2End']
+        );
+    }
+
+    #[Test]
+    public function it_throws_an_exception_if_the_livewire_component_does_not_exist_when_adding_livewire_component(): void
+    {
+        $this->expectException(ComponentNotFoundException::class);
+        $this->expectExceptionMessage('Unable to find component: [Yajra\DataTables\Html\Tests\TestComponents\TestView]');
+
+        $builder = resolve(Builder::class);
+        $builder->layout(fn (Layout $layout) => $layout
+            ->addLivewire(TestView::class, LayoutPosition::Top)
+            ->addLivewire(TestView::class, LayoutPosition::Bottom));
+    }
 }

tests/TestCase.php

@@ -3,6 +3,9 @@
 namespace Yajra\DataTables\Html\Tests;
 
 use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Blade;
+use Illuminate\Support\Facades\View;
+use Livewire\LivewireServiceProvider;
 use Orchestra\Testbench\TestCase as BaseTestCase;
 use Yajra\DataTables\DataTablesServiceProvider;
 use Yajra\DataTables\Html\Builder;
@@ -16,8 +19,11 @@ protected function setUp(): void
     {
         parent::setUp();
 
+        config()->set('app.key', 'base64:6pASQ5U2UYo+w6noM9hwOPeHJ5vGP+BNruyMtRA8FWY=');
+
         $this->migrateDatabase();
         $this->seedDatabase();
+        $this->setupViewAndBladeDirectory();
     }
 
     protected function migrateDatabase(): void
@@ -104,6 +110,7 @@ protected function getEnvironmentSetUp($app): void
     protected function getPackageProviders($app): array
     {
         return [
+            LivewireServiceProvider::class,
             DataTablesServiceProvider::class,
             HtmlServiceProvider::class,
         ];
@@ -113,4 +120,10 @@ protected function getHtmlBuilder(): Builder
     {
         return app(Builder::class);
     }
+
+    protected function setupViewAndBladeDirectory(): void
+    {
+        View::addLocation(__DIR__.'/TestComponents');
+        Blade::componentNamespace('Yajra\\DataTables\\Html\\Tests\\TestComponents', 'test');
+    }
 }

tests/TestComponents/TestInlineView.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Yajra\DataTables\Html\Tests\TestComponents;
+
+use Illuminate\View\Component;
+
+class TestInlineView extends Component
+{
+    public function render(): string
+    {
+        return <<<'blade'
+        <p>Test Inline View</p>
+        blade;
+    }
+}

tests/TestComponents/TestLivewire.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Yajra\DataTables\Html\Tests\TestComponents;
+
+use Livewire\Component;
+
+class TestLivewire extends Component
+{
+    public function render(): string
+    {
+        return <<<'blade'
+            <div>test livewire</div>
+        blade;
+    }
+}

tests/TestComponents/TestView.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Yajra\DataTables\Html\Tests\TestComponents;
+
+use Illuminate\Contracts\Support\Renderable;
+use Illuminate\View\Component;
+
+class TestView extends Component
+{
+    public function render(): Renderable
+    {
+        return view('test-view');
+    }
+}