Add 1st working test >.<

yajra · yajra · commit 8bdd20623bfd · 2022-05-07T19:18:22.000+08:00
diff --git a/src/Services/DataTable.php b/src/Services/DataTable.php
@@ -77,16 +77,16 @@ abstract class DataTable implements DataTableButtons
     /**
      * Html builder.
      *
-     * @var \Yajra\DataTables\Html\Builder|null
+     * @var \Yajra\DataTables\Html\Builder
      */
-    protected ?Builder $htmlBuilder;
+    protected Builder $htmlBuilder;
 
     /**
      * Html builder extension callback.
      *
      * @var callable|null
      */
-    protected $htmlCallback = null;
+    protected $htmlCallback;
 
     /**
      * Export filename.
@@ -107,14 +107,14 @@ abstract class DataTable implements DataTableButtons
      *
      * @var callable|null
      */
-    protected $beforeCallback = null;
+    protected $beforeCallback;
 
     /**
      * Callback after processing the response.
      *
      * @var callable|null
      */
-    protected $responseCallback = null;
+    protected $responseCallback;
 
     /**
      * Available button actions. When calling an action, the value will be used
@@ -126,9 +126,9 @@ abstract class DataTable implements DataTableButtons
     protected array $actions = ['print', 'csv', 'excel', 'pdf'];
 
     /**
-     * @var \Yajra\DataTables\Utilities\Request|null
+     * @var \Yajra\DataTables\Utilities\Request
      */
-    protected ?Request $request;
+    protected Request $request;
 
     /**
      * Flag to use fast-excel package for export.
@@ -175,6 +175,18 @@ abstract class DataTable implements DataTableButtons
      */
     protected string $pdfWriter = 'Dompdf';
 
+    public function __construct()
+    {
+        /** @var Request $request */
+        $request = app('datatables.request');
+
+        /** @var Builder $builder */
+        $builder = app('datatables.html');
+
+        $this->request = $request;
+        $this->htmlBuilder = $builder;
+    }
+
     /**
      * Process dataTables needed render output.
      *
@@ -212,7 +224,7 @@ public function render(string $view, array $data = [], array $mergeData = [])
      */
     public function request(): Request
     {
-        return $this->request ?: $this->request = app('datatables.request');
+        return $this->request;
     }
 
     /**
@@ -307,7 +319,7 @@ protected function getExportColumnsFromBuilder(): Collection
      *
      * @return \Illuminate\Support\Collection
      */
-    protected function getColumnsFromBuilder()
+    protected function getColumnsFromBuilder(): Collection
     {
         return $this->html()->getColumns();
     }
@@ -329,15 +341,11 @@ public function html()
      */
     public function builder(): Builder
     {
-        if ($this->htmlBuilder) {
-            return $this->htmlBuilder;
-        }
-
         if (method_exists($this, 'htmlBuilder')) {
             return $this->htmlBuilder = $this->htmlBuilder();
         }
 
-        return $this->htmlBuilder = app('datatables.html');
+        return $this->htmlBuilder;
     }
 
     /**
diff --git a/tests/DataTableServiceTest.php b/tests/DataTableServiceTest.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace Yajra\DataTables\Buttons\Tests;
+
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+use Yajra\DataTables\Buttons\Tests\DataTables\UsersDataTable;
+
+class DataTableServiceTest extends TestCase
+{
+    use DatabaseTransactions;
+
+    /** @test */
+    public function it_can_handle_ajax_request()
+    {
+        $response = $this->getAjax('/users');
+
+        $response->assertJson([
+            'draw' => 0,
+            'recordsTotal' => 20,
+            'recordsFiltered' => 20,
+        ]);
+    }
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->app['router']->get('/users', function (UsersDataTable $dataTable) {
+            return $dataTable->render('tests::users');
+        });
+    }
+}
diff --git a/tests/DataTables/UsersDataTable.php b/tests/DataTables/UsersDataTable.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace Yajra\DataTables\Buttons\Tests\DataTables;
+
+use Illuminate\Database\Eloquent\Builder;
+use Yajra\DataTables\Buttons\Tests\Models\User;
+use Yajra\DataTables\EloquentDataTable;
+use Yajra\DataTables\Html\Column;
+use Yajra\DataTables\Services\DataTable;
+
+class UsersDataTable extends DataTable
+{
+    /**
+     * @throws \Yajra\DataTables\Exceptions\Exception
+     */
+    public function dataTable(Builder $query): EloquentDataTable
+    {
+        return datatables()->eloquent($query)->setRowId('id');
+    }
+
+    public function query(User $user): Builder
+    {
+        return $user->newQuery()->select('*');
+    }
+
+    public function html()
+    {
+        return $this->builder()
+                    ->setTableId('users-table')
+                    ->minifiedAjax()
+                    ->columns([
+                        Column::make('id'),
+                        Column::make('name'),
+                    ]);
+    }
+
+    protected function filename(): string
+    {
+        return 'Users';
+    }
+}
diff --git a/tests/Models/Post.php b/tests/Models/Post.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Yajra\DataTables\Buttons\Tests\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\SoftDeletes;
+
+class Post extends Model
+{
+    use SoftDeletes;
+
+    protected $guarded = [];
+
+    protected $dates = ['deleted_at'];
+
+    public function user(): BelongsTo
+    {
+        return $this->belongsTo(User::class);
+    }
+}
diff --git a/tests/Models/Role.php b/tests/Models/Role.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Yajra\DataTables\Buttons\Tests\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+
+class Role extends Model
+{
+    protected $guarded = [];
+
+    public function users(): BelongsToMany
+    {
+        return $this->belongsToMany(User::class);
+    }
+}
diff --git a/tests/Models/User.php b/tests/Models/User.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Yajra\DataTables\Buttons\Tests\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+
+class User extends Model
+{
+    protected $guarded = [];
+
+    public function posts(): HasMany
+    {
+        return $this->hasMany(Post::class);
+    }
+
+    public function roles(): BelongsToMany
+    {
+        return $this->belongsToMany(Role::class);
+    }
+
+    public function user(): MorphTo
+    {
+        return $this->morphTo();
+    }
+}
diff --git a/tests/Providers/TestServiceProvider.php b/tests/Providers/TestServiceProvider.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Yajra\DataTables\Buttons\Tests\Providers;
+
+use Illuminate\Support\ServiceProvider;
+
+class TestServiceProvider extends ServiceProvider
+{
+    public function boot()
+    {
+        $this->loadViewsFrom(__DIR__.'/../views', 'tests');
+    }
+}
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -2,10 +2,91 @@
 
 namespace Yajra\DataTables\Buttons\Tests;
 
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Testing\TestResponse;
 use Orchestra\Testbench\TestCase as BaseTestCase;
+use Yajra\DataTables\Buttons\Tests\Models\Role;
+use Yajra\DataTables\Buttons\Tests\Models\User;
+use Yajra\DataTables\Buttons\Tests\Providers\TestServiceProvider;
+use Yajra\DataTables\ButtonsServiceProvider;
+use Yajra\DataTables\DataTablesServiceProvider;
+use Yajra\DataTables\HtmlServiceProvider;
 
 abstract class TestCase extends BaseTestCase
 {
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->migrateDatabase();
+        $this->seedDatabase();
+    }
+
+    protected function migrateDatabase()
+    {
+        /** @var \Illuminate\Database\Schema\Builder $schemaBuilder */
+        $schemaBuilder = $this->app['db']->connection()->getSchemaBuilder();
+        if (! $schemaBuilder->hasTable('users')) {
+            $schemaBuilder->create('users', function (Blueprint $table) {
+                $table->increments('id');
+                $table->string('name');
+                $table->string('email');
+                $table->string('user_type')->nullable();
+                $table->unsignedInteger('user_id')->nullable();
+                $table->timestamps();
+            });
+        }
+        if (! $schemaBuilder->hasTable('posts')) {
+            $schemaBuilder->create('posts', function (Blueprint $table) {
+                $table->increments('id');
+                $table->string('title');
+                $table->unsignedInteger('user_id');
+                $table->timestamps();
+                $table->softDeletes();
+            });
+        }
+        if (! $schemaBuilder->hasTable('roles')) {
+            $schemaBuilder->create('roles', function (Blueprint $table) {
+                $table->increments('id');
+                $table->string('role');
+                $table->timestamps();
+            });
+        }
+        if (! $schemaBuilder->hasTable('role_user')) {
+            $schemaBuilder->create('role_user', function (Blueprint $table) {
+                $table->unsignedInteger('role_id');
+                $table->unsignedInteger('user_id');
+                $table->timestamps();
+            });
+        }
+    }
+
+    protected function seedDatabase()
+    {
+        $adminRole = Role::create(['role' => 'Administrator']);
+        $userRole = Role::create(['role' => 'User']);
+
+        collect(range(1, 20))->each(function ($i) use ($userRole) {
+            /** @var User $user */
+            $user = User::query()->create([
+                'name' => 'Record-'.$i,
+                'email' => 'Email-'.$i.'@example.com',
+            ]);
+
+            collect(range(1, 3))->each(function ($i) use ($user) {
+                $user->posts()->create([
+                    'title' => "User-{$user->id} Post-{$i}",
+                ]);
+            });
+
+            if ($i % 2) {
+                $user->roles()->attach(Role::all());
+            } else {
+                $user->roles()->attach($userRole);
+            }
+        });
+    }
+
     /**
      * Set up the environment.
      *
@@ -25,9 +106,20 @@ protected function getEnvironmentSetUp($app)
     protected function getPackageProviders($app): array
     {
         return [
-            \Yajra\DataTables\DataTablesServiceProvider::class,
-            \Yajra\DataTables\ButtonsServiceProvider::class,
-            \Yajra\DataTables\HtmlServiceProvider::class,
+            TestServiceProvider::class,
+            DataTablesServiceProvider::class,
+            ButtonsServiceProvider::class,
+            HtmlServiceProvider::class,
         ];
     }
+
+    public function getAjax($uri, array $headers = []): TestResponse
+    {
+        return $this->getJson($uri, array_merge(['X-Requested-With' => 'XMLHttpRequest'], $headers));
+    }
+
+    public function postAjax($uri, array $headers = []): TestResponse
+    {
+        return $this->postJson($uri, array_merge(['X-Requested-With' => 'XMLHttpRequest'], $headers));
+    }
 }
diff --git a/tests/views/users.blade.php b/tests/views/users.blade.php
