wip

Author: d8vjork

.vscode/extensions.json

@@ -1,14 +1,5 @@
 {
-  "recommendations": [
-    "DEVSENSE.phptools-vscode",
-    "open-southeners.php-support-utils",
-    "open-southeners.laravel-pint",
-    "ikappas.composer",
-    "pixelfear.composer-links",
-    "editorconfig.editorconfig",
-    "xdebug.php-debug",
-    "junstyle.php-cs-fixer",
-    "kasik96.latte",
-    "calebporzio.better-phpunit"
-  ]
+    "recommendations": [
+        "open-southeners.vscode-php-extension-pack"
+    ]
 }

composer.json

@@ -23,11 +23,15 @@
         "illuminate/support": "^8.0|^9.0"
     },
     "require-dev": {
+        "laravel/scout": "^9.0",
         "nunomaduro/larastan": "^1.0",
         "phpstan/phpstan": "^1.0",
         "phpunit/phpunit": "^7.0|^9.0",
         "orchestra/testbench": "^4.0|^6.0|^7.0"
     },
+    "suggest": {
+        "laravel/scout": "Laravel Scout for use with UnionBuilder::search() method"
+    },
     "autoload": {
         "psr-4": {
             "OpenSoutheners\\LaravelEloquentUnionBuilder\\": "src"
@@ -41,12 +45,5 @@
     "config": {
         "sort-packages": true
     },
-    "extra": {
-        "laravel": {
-            "providers": [
-                "OpenSoutheners\\LaravelEloquentUnionBuilder\\ServiceProvider"
-            ]
-        }
-    },
     "minimum-stability": "dev"
 }

src/UnionBuilder.php

@@ -4,6 +4,7 @@
 
 use Exception;
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\SQLiteConnection;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Schema;
@@ -46,25 +47,30 @@ public function __construct(array $builders = [])
      * Make new instance of UnionBuilder by the following models classes.
      *
      * @param  array<class-string<\Illuminate\Database\Eloquent\Model>>  $models
-     * @return UnionBuilder
+     * @return \OpenSoutheners\LaravelEloquentUnionBuilder\UnionBuilder
      */
     public static function from(array $models)
     {
-        $builders = [];
+        $unionBuilder = new static();
 
-        foreach ($models as $model) {
-            $builders[$model] = $model::query();
+        foreach ($models as $model => $columns) {
+            if (is_numeric($model)) {
+                $model = $columns;
+                $columns = null;
+            }
+
+            $unionBuilder->add($model::query());
         }
 
-        return new static($builders);
+        return $unionBuilder;
     }
 
     /**
      * Search by text content on the following models using Laravel Scout.
      *
      * @param  string  $searchQuery
      * @param  array<class-string<\Illuminate\Database\Eloquent\Model>>|array<class-string<\Illuminate\Database\Eloquent\Model>, array>  $models
-     * @return UnionBuilder
+     * @return \OpenSoutheners\LaravelEloquentUnionBuilder\UnionBuilder
      */
     public static function search(string $searchQuery, array $models)
     {
@@ -76,7 +82,7 @@ public static function search(string $searchQuery, array $models)
                 $columns = null;
             }
 
-            if (! class_use($model, Searchable::class)) {
+            if (! in_array(Searchable::class, class_uses($model))) {
                 throw new Exception("Model '${model}' does not use Laravel Scout.");
             }
 
@@ -88,7 +94,7 @@ public static function search(string $searchQuery, array $models)
 
             $unionBuilder->add(
                 $model::query()->whereKey($modelSearchResultKeys->toArray()),
-                $columns ?? Schema::getColumnListing($model::getTableName())
+                $columns ?? Schema::getColumnListing((new $model)->getTable())
             );
         }
 
@@ -121,10 +127,15 @@ private function getUnionBuilder()
 
         foreach ($this->builders as $builder) {
             $model = get_class($builder->getModel());
-            $modelSelectedColumns = $this->selectModelsColumns[$model];
+            $modelSelectedColumns = $this->selectModelsColumns[$model]
+                ?? Schema::getColumnListing($builder->getModel()->getTable());
+
+            if (! ($builder->getConnection() instanceof SQLiteConnection)) {
+                $model = str_replace('\\', '\\\\', $model);
+            }
 
             $selectColumnsArr = [];
-            $selectColumnsArr[] = DB::raw("'".str_replace('\\', '\\\\', $model)."' as union_model_class");
+            $selectColumnsArr[] = DB::raw("'".$model."' as union_model_class");
             $selectColumnsArr = array_merge(
                 $selectColumnsArr,
                 array_map(function ($item) use ($modelSelectedColumns) {
@@ -157,9 +168,9 @@ public function getAllSelectedColumns()
     /**
      * Add Eloquent query builder to this union builder selecting the following columns.
      *
-     * @param  Builder  $builder
+     * @param  \Illuminate\Database\Eloquent\Builder  $builder
      * @param  array  $columns
-     * @return UnionBuilder
+     * @return $this
      */
     public function add(Builder $builder, array $columns = [])
     {

tests/Fixtures/Post.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace OpenSoutheners\LaravelEloquentUnionBuilder\Tests\Fixtures;
+
+use Illuminate\Database\Eloquent\Model;
+use Laravel\Scout\Searchable;
+
+class Post extends Model
+{
+    use Searchable;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array<string>
+     */
+    protected $fillable = ['title', 'slug', 'content'];
+
+    /**
+     * The attributes that should be hidden for serialization.
+     *
+     * @var array<string>
+     */
+    protected $hidden = ['slug'];
+
+    /**
+     * Get the indexable data array for the model.
+     *
+     * @return array
+     */
+    public function toSearchableArray()
+    {
+        return [
+            'id' => $this->id,
+            'title' => $this->title,
+            'slug' => $this->slug,
+            'content' => $this->content,
+        ];
+    }
+}

tests/Fixtures/Tag.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace OpenSoutheners\LaravelEloquentUnionBuilder\Tests\Fixtures;
+
+use Illuminate\Database\Eloquent\Model;
+use Laravel\Scout\Searchable;
+
+class Tag extends Model
+{
+    use Searchable;
+
+    /**
+     * The attributes that should be visible in serialization.
+     *
+     * @var string[]
+     */
+    protected $visible = ['name', 'slug'];
+
+    /**
+     * The attributes that aren't mass assignable.
+     *
+     * @var string[]
+     */
+    protected $guarded = [];
+
+    /**
+     * Get the indexable data array for the model.
+     *
+     * @return array
+     */
+    public function toSearchableArray()
+    {
+        return [
+            'id' => $this->id,
+            'name' => $this->name,
+            'slug' => $this->slug,
+        ];
+    }
+}

tests/Fixtures/User.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace OpenSoutheners\LaravelEloquentUnionBuilder\Tests\Fixtures;
+
+use Illuminate\Foundation\Auth\User as Authenticatable;
+use Laravel\Scout\Searchable;
+
+class User extends Authenticatable
+{
+    use Searchable;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var string[]
+     */
+    protected $fillable = ['id', 'name', 'email', 'password'];
+
+    /**
+     * The attributes that should be visible in serialization.
+     *
+     * @var string[]
+     */
+    protected $visible = ['name', 'email'];
+
+    /**
+     * The attributes that should be hidden for serialization.
+     *
+     * @var array<int, string>
+     */
+    protected $hidden = [
+        'password',
+        'remember_token',
+    ];
+
+    /**
+     * The attributes that should be cast.
+     *
+     * @var array<string, string>
+     */
+    protected $casts = [
+        'email_verified_at' => 'datetime',
+    ];
+
+    /**
+     * Get the indexable data array for the model.
+     *
+     * @return array
+     */
+    public function toSearchableArray()
+    {
+        return [
+            'id' => $this->id,
+            'name' => $this->name,
+            'email' => $this->email,
+        ];
+    }
+}

tests/TestCase.php

@@ -2,8 +2,11 @@
 
 namespace OpenSoutheners\LaravelEloquentUnionBuilder\Tests;
 
-use Orchestra\Testbench\TestCase as Orchestra;
+use Laravel\Scout\ScoutServiceProvider;
 use OpenSoutheners\LaravelEloquentUnionBuilder\ServiceProvider;
+use Orchestra\Testbench\TestCase as Orchestra;
+use MeiliSearch\Contracts\TasksQuery;
+use Laravel\Scout\EngineManager;
 
 abstract class TestCase extends Orchestra
 {
@@ -16,7 +19,36 @@ abstract class TestCase extends Orchestra
     protected function getPackageProviders($app)
     {
         return [
-            ServiceProvider::class,
+            ScoutServiceProvider::class,
         ];
     }
+
+    /**
+     * Define environment setup.
+     *
+     * @param  \Illuminate\Foundation\Application  $app
+     * @return void
+     */
+    protected function defineEnvironment($app)
+    {
+        // Setup default database to use sqlite :memory:
+        $app['config']->set('database.default', 'testing');
+        $app['config']->set('scout.driver', 'collection');
+        $app['config']->set('database.connections.testing', [
+            'driver' => 'sqlite',
+            'database' => ':memory:',
+            'prefix' => '',
+        ]);
+    }
+
+    /**
+     * Define database migrations.
+     *
+     * @return void
+     */
+    protected function defineDatabaseMigrations()
+    {
+        $this->loadLaravelMigrations();
+        $this->loadMigrationsFrom(__DIR__.'/database');
+    }
 }