Merge pull request #253 from yocmen/yocmen/modify-import-query

Feature: Add the makeAllSearchableUsing API to the default import source

src/Searchable/DefaultImportSource.php

@@ -75,7 +75,7 @@ private function model()
 
     private function newQuery(): Builder
     {
-        $query = $this->model()->newQuery();
+        $query = $this->className::makeAllSearchableUsing($this->model()->newQuery());
         $softDelete = $this->className::usesSoftDelete() && config('scout.soft_delete', false);
         $query
             ->when($softDelete, function ($query) {

tests/Feature/ImportCommandTest.php

@@ -6,6 +6,7 @@
 
 use App\Book;
 use App\BookWithCustomKey;
+use App\Post;
 use App\Product;
 use Illuminate\Support\Facades\Artisan;
 use Illuminate\Support\Facades\Bus;
@@ -156,16 +157,20 @@ public function test_progress_report(): void
         $output = explode("\n", $output->fetch());
         $this->assertEquals(
             trans('scout::import.start', ['searchable' => Product::class]),
-            trim($output[0]));
+            trim($output[0])
+        );
         $this->assertEquals(
             '[OK] '.trans('scout::import.done', ['searchable' => Product::class]),
-            trim($output[14]));
+            trim($output[14])
+        );
         $this->assertEquals(
             trans('scout::import.start', ['searchable' => Book::class]),
-            trim($output[16]));
+            trim($output[16])
+        );
         $this->assertEquals(
             '[OK] '.trans('scout::import.done', ['searchable' => Book::class]),
-            trim($output[30]));
+            trim($output[30])
+        );
     }
 
     public function test_progress_report_in_queue(): void
@@ -268,4 +273,36 @@ public function test_chained_queue_timeout_configuration_with_empty_string(): vo
             return $job->timeout === null;
         });
     }
+
+    public function test_makeAllSearchableUsing_method_is_called_in_the_product_model(): void
+    {
+        $dispatcher = Post::getEventDispatcher();
+        Post::unsetEventDispatcher();
+
+        factory(Post::class)->states('draft')->create();
+        factory(Post::class)->states('draft')->create();
+        factory(Post::class)->states('draft')->create();
+        factory(Post::class)->states('published')->create();
+
+        Post::setEventDispatcher($dispatcher);
+
+        // Call the makeAllSearchableUsing method on the Product model
+        Artisan::call('scout:import', ['searchable' => [Post::class]]);
+
+        $params = [
+            'index' => (new Post())->searchableAs(),
+            'body' => [
+                'query' => [
+                    'match_all' => new stdClass(),
+                ],
+            ],
+        ];
+
+        $response = $this->elasticsearch->search($params);
+
+        // Assert that only the published posts are searchable
+        // bacause in the Post model we have defined the makeAllSearchableUsing method
+        // which returns only the published posts.
+        $this->assertEquals(1, $response['hits']['total']['value']);
+    }
 }

tests/Unit/Searchable/SearchableListFactoryTest.php

@@ -18,8 +18,8 @@ public function test_only_load_seachable_classes()
 
         $searchable = $factory->make();
 
-        // There are 4 searchable models: Book, BookWithCustomKey, Product and Ticket
-        $this->assertCount(4, $searchable);
+        // There are 5 searchable models: Book, BookWithCustomKey, Product, Ticket and Post
+        $this->assertCount(5, $searchable);
     }
 
     public function test_find_searchable_trait_within_trait()

tests/laravel/app/Post.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace App;
+
+use Illuminate\Database\Eloquent\Model;
+use Laravel\Scout\Searchable;
+
+class Post extends Model
+{
+    use Searchable;
+
+    protected function makeAllSearchableUsing($query)
+    {
+        return $query->where('status', 'published');
+    }
+}

tests/laravel/database/factories/PostFactory.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+use App\Post;
+use Faker\Generator as Faker;
+
+$factory->define(Post::class, function (Faker $faker) {
+    return [
+        'title' => $faker->text,
+        'body' => $faker->text,
+        'status' => 'draft',
+        'date' => $faker->date(),
+    ];
+});
+
+$factory->state(Post::class, 'draft', function () {
+    return [
+        'status' => 'draft',
+    ];
+});
+
+$factory->state(Post::class, 'published', function () {
+    return [
+        'status' => 'published',
+    ];
+});

tests/laravel/database/migrations/2019_15_02_000002_create_post_table.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+final class CreatePostTable extends Migration
+{
+    public function up(): void
+    {
+        Schema::create('posts', function (Blueprint $table) {
+            $table->increments('id');
+            $table->string('title');
+            $table->string('body');
+            $table->string('status');
+            $table->dateTime('date');
+            $table->softDeletes();
+            $table->timestamps();
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::dropIfExists('posts');
+    }
+}