Merge branch 'DeltaSystems-feature-testing' into develop

Author: rappasoft

README.md

@@ -622,11 +622,17 @@ The final result would look like:
 
 - [x] Bootstrap 4 Template
 - [x] Bootstrap 5 Template
-- [ ] Sorting By Relationships
-- [ ] Test Suite
+- [x] Sorting By Relationships
+- [ ] Test Suite (WIP)
 - [ ] Column Search
 - [ ] Greater Configurability
 
+## Testing
+
+```bash
+composer test
+```
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

composer.json

@@ -24,6 +24,7 @@
         "illuminate/contracts": "^8.0"
     },
     "require-dev": {
+        "ext-sqlite3": "*",
         "orchestra/testbench": "^6.13",
         "phpunit/phpunit": "^9.3",
         "spatie/laravel-ray": "^1.9",

database/migrations/create_test_tables.php.stub

@@ -0,0 +1,39 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateTestTables extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('species', function (Blueprint $table) {
+            $table->id();
+            $table->string('name');
+        });
+
+        Schema::create('breeds', function (Blueprint $table) {
+            $table->id();
+            $table->string('name');
+            $table->integer('species_id')->unsigned();
+            $table->foreign('species_id')->references('id')->on('species');
+        });
+
+        Schema::create('pets', function (Blueprint $table) {
+            $table->id();
+            $table->string('name')->index();
+            $table->string('age')->nullable();
+            $table->date('last_visit')->nullable();
+            $table->integer('species_id')->unsigned()->nullable();
+            $table->integer('breed_id')->unsigned()->nullable();
+            $table->foreign('species_id')->references('id')->on('species');
+            $table->foreign('breed_id')->references('id')->on('breeds');
+        });
+    }
+}

tests/DataTableComponentTest.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Tests;
+
+use Illuminate\Contracts\Pagination\LengthAwarePaginator;
+use Rappasoft\LaravelLivewireTables\DataTableComponent;
+use Rappasoft\LaravelLivewireTables\Tests\Http\Livewire\PetsTable;
+
+class DataTableComponentTest extends TestCase
+{
+    protected DataTableComponent $table;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->table = new PetsTable();
+    }
+
+    /** @test */
+    public function bootstrap_test_datatable(): void
+    {
+        $this->assertInstanceOf(DataTableComponent::class, $this->table);
+    }
+
+    /** @test */
+    public function test_columns(): void
+    {
+        $columns = $this->table->columns();
+
+        $this->assertCount(5, $columns);
+    }
+
+    /** @test */
+    public function test_rows(): void
+    {
+        $rows = $this->table->rows;
+
+        $this->assertInstanceOf(LengthAwarePaginator::class, $rows);
+        $this->assertEquals(5, $this->table->getRowsProperty()->total());
+    }
+
+    /** @test */
+    public function test_search_filter(): void
+    {
+        $this->table->filters['search'] = 'Cartman';
+        $this->assertEquals(1, $this->table->getRowsProperty()->total());
+    }
+
+    /** @test */
+    public function test_search_filter_reset(): void
+    {
+        $this->table->filters['search'] = 'Cartman';
+        $this->table->resetFilters();
+        $this->assertEquals(1, $this->table->rows->total());
+    }
+
+    /** @test */
+    public function test_search_filter_remove(): void
+    {
+        $this->table->filters['search'] = 'Cartman';
+        $this->table->removeFilter('search');
+        $this->assertEquals(5, $this->table->rows->total());
+    }
+}

tests/ExampleTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Tests\Http\Livewire;
+
+use Illuminate\Database\Eloquent\Builder;
+use Rappasoft\LaravelLivewireTables\DataTableComponent;
+use Rappasoft\LaravelLivewireTables\Tests\Models\Pet;
+use Rappasoft\LaravelLivewireTables\Views\Column;
+
+class PetsTable extends DataTableComponent
+{
+    /**
+     * @return Builder
+     */
+    public function query() : Builder
+    {
+        return Pet::query()->when($this->getFilter('search'), function (Builder $query, $search) {
+            $query->where('name', 'like', '%'.$search.'%');
+        });
+    }
+
+    public function columns(): array
+    {
+        return [
+            Column::make('Name', 'name'),
+            Column::make('Age', 'age'),
+            Column::make('Last Visit', 'last_visit'),
+            Column::make('Species', 'species.name'),
+            Column::make('Breed', 'breed.name'),
+        ];
+    }
+}

tests/Http/Livewire/PetsTable.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Tests\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @property int $id
+ * @property string $name
+ * @property int $species_id
+ */
+class Breed extends Model
+{
+    /**
+     * The table associated with the model.
+     *
+     * @var string
+     */
+    protected $table = 'breeds';
+
+    /**
+     * The primary key for the model.
+     *
+     * @var string
+     */
+    protected $primaryKey = 'id';
+
+    /**
+     * @var bool
+     */
+    public $timestamps = false;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'id',
+        'name',
+        'species_id',
+    ];
+}

tests/Models/Breed.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Tests\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @property int $id
+ * @property string $name
+ * @property string $age
+ * @property string $last_visit
+ * @property int $species_id
+ * @property int $breed_id
+ */
+class Pet extends Model
+{
+    /**
+     * The table associated with the model.
+     *
+     * @var string
+     */
+    protected $table = 'pets';
+
+    /**
+     * The primary key for the model.
+     *
+     * @var string
+     */
+    protected $primaryKey = 'id';
+
+    /**
+     * @var bool
+     */
+    public $timestamps = false;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'id',
+        'name',
+        'age',
+        'last_visit',
+        'species_id',
+        'breed_id',
+    ];
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|Species[]
+     */
+    public function species()
+    {
+        return $this->belongsTo(Species::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo|Breed[]
+     */
+    public function breeds()
+    {
+        return $this->belongsTo(Breed::class);
+    }
+}

tests/Models/Pet.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Tests\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @property int $id
+ * @property string $name
+ */
+class Species extends Model
+{
+    /**
+     * The table associated with the model.
+     *
+     * @var string
+     */
+    protected $table = 'species';
+
+    /**
+     * The primary key for the model.
+     *
+     * @var string
+     */
+    protected $primaryKey = 'id';
+
+    /**
+     * @var bool
+     */
+    public $timestamps = false;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'id',
+        'name',
+    ];
+}

tests/Models/Species.php

@@ -4,9 +4,48 @@
 
 use Orchestra\Testbench\TestCase as Orchestra;
 use Rappasoft\LaravelLivewireTables\LaravelLivewireTablesServiceProvider;
+use Rappasoft\LaravelLivewireTables\Tests\Models\Breed;
+use Rappasoft\LaravelLivewireTables\Tests\Models\Pet;
+use Rappasoft\LaravelLivewireTables\Tests\Models\Species;
 
 class TestCase extends Orchestra
 {
+    /**
+     * Setup the test environment.
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        Species::insert([
+            [ 'id' => 1, 'name' => 'Cat', ],
+            [ 'id' => 2, 'name' => 'Dog', ],
+            [ 'id' => 3, 'name' => 'Horse', ],
+            [ 'id' => 4, 'name' => 'Bird', ],
+        ]);
+
+        Breed::insert([
+            [ 'id' => 1, 'name' => 'American Shorthair', 'species_id' => 1, ],
+            [ 'id' => 2, 'name' => 'Maine Coon', 'species_id' => 1, ],
+            [ 'id' => 3, 'name' => 'Persian', 'species_id' => 1, ],
+            [ 'id' => 4, 'name' => 'Norwegian Forest', 'species_id' => 1, ],
+            [ 'id' => 100, 'name' => 'Beagle', 'species_id' => 2, ],
+            [ 'id' => 101, 'name' => 'Corgi', 'species_id' => 2, ],
+            [ 'id' => 102, 'name' => 'Red Setter', 'species_id' => 2, ],
+            [ 'id' => 200, 'name' => 'Arabian', 'species_id' => 3, ],
+            [ 'id' => 201, 'name' => 'Clydesdale', 'species_id' => 3, ],
+            [ 'id' => 202, 'name' => 'Mustang', 'species_id' => 3, ],
+        ]);
+
+        Pet::insert([
+            [ 'id' => 1, 'name' => 'Cartman', 'age' => 22, 'species_id' => 1, 'breed_id' => 4 ],
+            [ 'id' => 2, 'name' => 'Tux', 'age' => 8, 'species_id' => 1, 'breed_id' => 4 ],
+            [ 'id' => 3, 'name' => 'May', 'age' => 3, 'species_id' => 2, 'breed_id' => 102 ],
+            [ 'id' => 4, 'name' => 'Ben', 'age' => 5, 'species_id' => 3, 'breed_id' => 200 ],
+            [ 'id' => 5, 'name' => 'Chico', 'age' => 7, 'species_id' => 3, 'breed_id' => 202 ],
+        ]);
+    }
+
     protected function getPackageProviders($app)
     {
         return [
@@ -22,5 +61,8 @@ public function getEnvironmentSetUp($app)
             'database' => ':memory:',
             'prefix' => '',
         ]);
+
+        include_once __DIR__.'/../database/migrations/create_test_tables.php.stub';
+        (new \CreateTestTables())->up();
     }
 }