Merge remote-tracking branch 'origin/main'

phpunit.xml.dist

@@ -16,11 +16,16 @@
         <testdoxText outputFile="build/coverage.txt"/>
     </logging>
     <php>
-        <env name="DB_CONNECTION" value="mysql"/>
-        <env name="DB_USERNAME" value="root"/>
-        <env name="DB_PASSWORD" value=""/>
-        <env name="DB_DATABASE" value="generators"/>
-        <env name="DB_HOST" value="127.0.0.1"/>
-        <env name="DB_PORT" value="3307"/>
+        <env name="APP_ENV" value="testing"/>
+        <env name="APP_MAINTENANCE_DRIVER" value="file"/>
+        <env name="BCRYPT_ROUNDS" value="4"/>
+        <env name="CACHE_STORE" value="array"/>
+        <env name="DB_CONNECTION" value="sqlite"/>
+        <env name="DB_DATABASE" value=":memory:"/>
+        <env name="MAIL_MAILER" value="array"/>
+        <env name="PULSE_ENABLED" value="false"/>
+        <env name="QUEUE_CONNECTION" value="sync"/>
+        <env name="SESSION_DRIVER" value="array"/>
+        <env name="TELESCOPE_ENABLED" value="false"/>
     </php>
 </phpunit>

src/AdminModel/AdminModel.php

@@ -5,6 +5,8 @@
 
 namespace Javaabu\Helpers\AdminModel;
 
+use Illuminate\Database\Eloquent\Builder;
+
 interface AdminModel
 {
     /**
@@ -53,4 +55,13 @@ public function getLogUrlAttribute(): string;
      * @return string
      */
     public function getCauserLogUrlAttribute(): string;
+
+    /**
+     * A search scope
+     *
+     * @param Builder $query
+     * @param $search
+     * @return mixed
+     */
+    public function scopeSearch($query, $search): mixed;
 }

src/AdminModel/IsAdminModel.php

@@ -5,6 +5,9 @@
 
 namespace Javaabu\Helpers\AdminModel;
 
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Arr;
+
 trait IsAdminModel
 {
     /**
@@ -81,4 +84,34 @@ public function getCauserLogUrlAttribute(): string
             'causer_id' => $this->id,
         ], route('admin.logs.index'));
     }
+
+    /**
+     * A search scope
+     *
+     * @param Builder $query
+     * @param $search
+     * @return mixed
+     */
+    public function scopeSearch($query, $search): mixed
+    {
+        if (property_exists($this, 'searchable') && $this->searchable) {
+            $searchable = Arr::wrap($this->searchable);
+
+            $first = true;
+            foreach ($searchable as $attribute) {
+                if  ($first) {
+                    $first = false;
+                    $method = 'where';
+                } else {
+                    $method = 'orWhere';
+                }
+
+                $query->{$method}($attribute, 'like', '%'.$search.'%');
+            }
+
+            return $query;
+        }
+
+        return $query->where($this->getKeyName(), $search);
+    }
 }

tests/Feature/AdminModelTest.php

@@ -0,0 +1,155 @@
+<?php
+
+namespace Javaabu\Helpers\Tests\Feature;
+
+use Illuminate\Database\Eloquent\Model;
+use Javaabu\Helpers\AdminModel\AdminModel;
+use Javaabu\Helpers\AdminModel\IsAdminModel;
+use Javaabu\Helpers\Tests\TestCase;
+use Javaabu\Helpers\Tests\InteractsWithDatabase;
+
+class CategoryWithSearchable extends Model implements AdminModel
+{
+    use IsAdminModel;
+
+    protected $table = 'categories';
+
+    protected array $searchable = [
+        'name'
+    ];
+
+    protected $guarded = [
+    ];
+
+    public function getAdminUrlAttribute(): string
+    {
+        return '';
+    }
+}
+
+class CategoryWithStringSearchable extends Model implements AdminModel
+{
+    use IsAdminModel;
+
+    protected $table = 'categories';
+
+    protected string $searchable = 'name';
+
+    protected $guarded = [
+    ];
+
+    public function getAdminUrlAttribute(): string
+    {
+        return '';
+    }
+}
+
+class CategoryWithMultipleSearchable extends Model implements AdminModel
+{
+    use IsAdminModel;
+
+    protected $table = 'categories';
+
+    protected array $searchable = [
+        'slug',
+        'name'
+    ];
+
+    protected $guarded = [
+    ];
+
+    public function getAdminUrlAttribute(): string
+    {
+        return '';
+    }
+}
+
+class CategoryWithoutSearchable extends Model implements AdminModel
+{
+    use IsAdminModel;
+
+    protected $table = 'categories';
+
+    protected $guarded = [
+    ];
+
+    public function getAdminUrlAttribute(): string
+    {
+        return '';
+    }
+}
+
+class AdminModelTest extends TestCase
+{
+    use InteractsWithDatabase;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->runMigrations();
+    }
+
+    /** @test */
+    public function it_can_search_models_using_a_partial_match(): void
+    {
+        $category = new CategoryWithSearchable(['name' => 'Apple', 'slug' => 'some-slug']);
+        $category->save();
+
+        $found = CategoryWithSearchable::search('pple')->first();
+
+        $this->assertEquals($category->id, $found->id);
+    }
+
+    /** @test */
+    public function it_can_search_models_using_a_single_searchable(): void
+    {
+        $category = new CategoryWithSearchable(['name' => 'Apple', 'slug' => 'some-slug']);
+        $category->save();
+
+        $found = CategoryWithSearchable::search('Apple')->first();
+
+        $this->assertEquals($category->id, $found->id);
+        $this->assertNull(CategoryWithSearchable::search('some-slug')->first());
+    }
+
+    /** @test */
+    public function it_can_search_models_using_a_string_searchable(): void
+    {
+        $category = new CategoryWithStringSearchable(['name' => 'Apple', 'slug' => 'some-slug']);
+        $category->save();
+
+        $found = CategoryWithStringSearchable::search('Apple')->first();
+
+        $this->assertEquals($category->id, $found->id);
+        $this->assertNull(CategoryWithStringSearchable::search('some-slug')->first());
+    }
+
+    /** @test */
+    public function it_can_search_models_using_multiple_searchables(): void
+    {
+        $category = new CategoryWithMultipleSearchable(['name' => 'Apple', 'slug' => 'some-slug']);
+        $category->save();
+
+        $found = CategoryWithMultipleSearchable::search('Apple')->first();
+
+        $this->assertEquals($category->id, $found->id);
+
+        $found = CategoryWithMultipleSearchable::search('some-slug')->first();
+
+        $this->assertEquals($category->id, $found->id);
+    }
+
+    /** @test */
+    public function it_can_search_models_without_searchable(): void
+    {
+        $category = new CategoryWithoutSearchable(['name' => 'Apple', 'slug' => 'some-slug']);
+        $category->save();
+
+        $found = CategoryWithoutSearchable::search($category->id)->first();
+
+        $this->assertEquals($category->id, $found->id);
+        $this->assertNull(CategoryWithoutSearchable::search('Apple')->first());
+        $this->assertNull(CategoryWithoutSearchable::search('some-slug')->first());
+    }
+}

tests/InteractsWithDatabase.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Javaabu\Helpers\Tests;
+
+trait InteractsWithDatabase
+{
+    protected function runMigrations()
+    {
+        include_once __DIR__ . '/database/create_categories_table.php';
+
+        (new \CreateCategoriesTable)->up();
+    }
+}

tests/database/create_categories_table.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateCategoriesTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('categories', function (Blueprint $table) {
+            $table->id();
+            $table->string('name');
+            $table->string('slug');
+            $table->timestamps();
+        });
+    }
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('categories');
+    }
+}