Merge pull request #310 from driesvints/refactor-flush-command

[6.0] Use engine to flush records of model

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Release Notes
+
+## [v6.0.0 (unreleased)](https://github.com/laravel/scout/compare/v5.0.3...v6.0.0)
+
+### Changed
+- Flush records of a model using the engine. **This removes the emitting of the `ModelsFlushed` event.** ([#310](https://github.com/laravel/scout/pull/310))

src/Console/FlushCommand.php

@@ -3,7 +3,6 @@
 namespace Laravel\Scout\Console;
 
 use Illuminate\Console\Command;
-use Laravel\Scout\Events\ModelsFlushed;
 use Illuminate\Contracts\Events\Dispatcher;
 
 class FlushCommand extends Command
@@ -34,16 +33,8 @@ public function handle(Dispatcher $events)
 
         $model = new $class;
 
-        $events->listen(ModelsFlushed::class, function ($event) use ($class) {
-            $key = $event->models->last()->getScoutKey();
-
-            $this->line('<comment>Flushed ['.$class.'] models up to ID:</comment> '.$key);
-        });
-
         $model::removeAllFromSearch();
-
-        $events->forget(ModelsFlushed::class);
-
+
         $this->info('All ['.$class.'] records have been flushed.');
     }
 }

src/Engines/AlgoliaEngine.php

@@ -194,6 +194,19 @@ public function getTotalCount($results)
         return $results['nbHits'];
     }
 
+    /**
+     * Flush all of the model's records from the engine.
+     *
+     * @param  \Illuminate\Database\Eloquent\Model  $model
+     * @return void
+     */
+    public function flush($model)
+    {
+        $index = $this->algolia->initIndex($model->searchableAs());
+
+        $index->clearIndex();
+    }
+
     /**
      * Determine if the given model uses soft deletes.
      *

src/Engines/Engine.php

@@ -67,6 +67,14 @@ abstract public function map(Builder $builder, $results, $model);
      */
     abstract public function getTotalCount($results);
 
+    /**
+     * Flush all of the model's records from the engine.
+     *
+     * @param  \Illuminate\Database\Eloquent\Model  $model
+     * @return void
+     */
+    abstract public function flush($model);
+
     /**
      * Get the results of the query as a Collection of primary keys.
      *

src/Engines/NullEngine.php

@@ -87,4 +87,15 @@ public function getTotalCount($results)
     {
         return count($results);
     }
+
+    /**
+     * Flush all of the model's records from the engine.
+     *
+     * @param  \Illuminate\Database\Eloquent\Model  $model
+     * @return void
+     */
+    public function flush($model)
+    {
+        //
+    }
 }

src/Searchable.php

@@ -148,9 +148,7 @@ public static function removeAllFromSearch()
     {
         $self = new static();
 
-        $self->newQuery()
-            ->orderBy($self->getKeyName())
-            ->unsearchable();
+        $self->searchableUsing()->flush($self);
     }
 
     /**
@@ -264,7 +262,7 @@ public function syncWithSearchUsing()
     /**
      * Get the queue that should be used with syncing
      *
-     * @return  string
+     * @return string
      */
     public function syncWithSearchUsingQueue()
     {

tests/AlgoliaEngineTest.php

@@ -89,4 +89,14 @@ public function test_a_model_is_removed_with_a_custom_algolia_key()
         $engine = new AlgoliaEngine($client);
         $engine->delete(Collection::make([new AlgoliaEngineTestCustomKeyModel()]));
     }
+
+    public function test_flush_a_model()
+    {
+        $client = Mockery::mock('AlgoliaSearch\Client');
+        $client->shouldReceive('initIndex')->with('table')->andReturn($index = Mockery::mock('StdClass'));
+        $index->shouldReceive('clearIndex');
+
+        $engine = new AlgoliaEngine($client);
+        $engine->flush(new AlgoliaEngineTestCustomKeyModel());
+    }
 }