Refactor and improve #6

When performing a search apply withoutTrashed() filter only if index is "internal" (stored in model's table).
Filter out all non-existing models when mapping search results to models.

Author: pmatseykanets

src/PostgresEngine.php

@@ -216,8 +216,6 @@ protected function performSearch(Builder $builder, $perPage = 0, $page = 1)
         // does not revceive a model instance
         $this->preserveModel($builder->model);
 
-        $indexColumn = $this->getIndexColumn($builder->model);
-
         $bindings = collect([]);
 
         // The choices of parser, dictionaries and which types of tokens to index are determined
@@ -228,6 +226,8 @@ protected function performSearch(Builder $builder, $perPage = 0, $page = 1)
         $bindings->push($this->searchConfig($builder->model) ?: null)
             ->push($builder->query);
 
+        $indexColumn = $this->getIndexColumn($builder->model);
+
         // Build the query
         $query = $this->database
             ->table($builder->index ?: $builder->model->searchableAs())
@@ -238,21 +238,26 @@ protected function performSearch(Builder $builder, $perPage = 0, $page = 1)
             ->whereRaw("$indexColumn @@ query")
             ->orderBy('rank', 'desc')
             ->orderBy($builder->model->getKeyName());
-        //if model use soft delete - without trashed
-        if (method_exists($builder->model, 'getDeletedAtColumn')) {
-            $query->where($builder->model->getDeletedAtColumn(), null);
-        }
-        if ($perPage > 0) {
-            $query->skip(($page - 1) * $perPage)
-                ->limit($perPage);
-        }
 
         // Transfer the where clauses that were set on the builder instance if any
         foreach ($builder->wheres as $key => $value) {
             $query->where($key, $value);
             $bindings->push($value);
         }
 
+        // If parsed documents are being stored in the model's table
+        if (! $this->isExternalIndex($builder->model)) {
+            // and the model uses soft deletes we need to exclude trashed rows
+            if ($this->usesSoftDeletes($builder->model)) {
+                $query->whereNull($builder->model->getDeletedAtColumn());
+            }
+        }
+
+        if ($perPage > 0) {
+            $query->skip(($page - 1) * $perPage)
+                ->limit($perPage);
+        }
+
         return $this->database
             ->select($query->toSql(), $bindings->all());
     }
@@ -277,7 +282,7 @@ public function mapIds($results)
      *
      * @param  mixed $results
      * @param  \Illuminate\Database\Eloquent\Model $model
-     * @return Collection
+     * @return \Illuminate\Support\Collection
      */
     public function map($results, $model)
     {
@@ -293,9 +298,11 @@ public function map($results, $model)
             ->get()
             ->keyBy($model->getKeyName());
 
-        return $results->map(function ($result) use ($model, $models) {
-            return $models[$result->{$model->getKeyName()}];
-        });
+        return $results->pluck($model->getKeyName())
+            ->intersect($models->keys()) // Filter out no longer existing models (i.e. soft deleted)
+            ->map(function ($key) use ($model, $models) {
+                return $models[$key];
+            });
     }
 
     /**
@@ -490,4 +497,15 @@ protected function searchConfig(Model $model)
     {
         return $this->option($model, 'config', $this->config('config', ''));
     }
+
+    /**
+     * Checks if the model uses the SoftDeletes trait.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @return bool
+     */
+    protected function usesSoftDeletes(Model $model)
+    {
+        return method_exists($model, 'getDeletedAtColumn');
+    }
 }

tests/PostgresEngineTest.php

@@ -154,7 +154,7 @@ public function test_search_with_model_config()
         $engine->search($builder);
     }
 
-    public function test_search_with_soft_delete()
+    public function test_search_with_soft_deletes()
     {
         list($engine, $db) = $this->getEngine();
 
@@ -163,7 +163,7 @@ public function test_search_with_soft_delete()
         $table->shouldReceive('skip')->with(0)->andReturnSelf()
             ->shouldReceive('limit')->with(5)->andReturnSelf()
             ->shouldReceive('where')->with('bar', 1)->andReturnSelf()
-            ->shouldReceive('where')->with('deleted_at', null);
+            ->shouldReceive('whereNull')->with('deleted_at');
 
         $db->shouldReceive('select')->with(null, [null, 'foo', 1]);
 
@@ -173,7 +173,7 @@ public function test_search_with_soft_delete()
         $engine->search($builder);
     }
 
-    public function test_map_correctly_maps_results_to_models()
+    public function test_maps_results_to_models()
     {
         list($engine) = $this->getEngine();
 
@@ -188,6 +188,26 @@ public function test_map_correctly_maps_results_to_models()
         $this->assertCount(1, $results);
     }
 
+    public function test_map_filters_out_no_longer_existing_models()
+    {
+        list($engine) = $this->getEngine();
+
+        $model = Mockery::mock('StdClass');
+        $model->shouldReceive('getKeyName')->andReturn('id');
+        $model->shouldReceive('whereIn')->once()->with('id', [1, 2])->andReturn($model);
+
+        $expectedModel = new SoftDeletableTestModel();
+        $expectedModel->id = 2;
+
+        $model->shouldReceive('get')->once()->andReturn(Collection::make([$expectedModel]));
+
+        $models = $engine->map(
+            json_decode('[{"id": 1, "rank": 0.33, "total_count": 2}, {"id": 2, "rank": 0.31, "total_count": 2}]'), $model);
+
+        $this->assertCount(1, $models);
+        $this->assertEquals(2, $models->first()->id);
+    }
+
     public function test_it_returns_total_count()
     {
         list($engine) = $this->getEngine();