Scout 6/7 fixes + rebranding.

Author: olsgreen

.travis.yml

@@ -0,0 +1,15 @@
+language: php
+
+php:
+  - 7.0
+  - 7.1
+  - 7.2
+
+sudo: false
+
+install: travis_retry composer install --no-interaction --prefer-dist
+
+before_script:
+    - sleep 10
+
+script: vendor/bin/phpunit --verbose

README.md

@@ -1,8 +1,15 @@
 # Laravel Scout Elasticsearch Driver
 
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
+[![Build Status](https://travis-ci.com/boxed-code/laravel-scout-elasticsearch.svg?branch=master)](https://travis-ci.com/boxed-code/laravel-scout-elasticsearch)
 
-This package makes is the [Elasticsearch](https://www.elastic.co/products/elasticsearch) driver for Laravel Scout.
+This is a basic [elastic](https://www.elastic.co/products/elasticsearch) search backed driver [for Laravel Scout](https://laravel.com/docs/5.8/scout). 
+
+This driver has a simple configuration, requiring you to only publish the configuration and set the hostname of your elasticsearch node.
+
+Based on the original work of [ErickTamayo](https://github.com/ErickTamayo/laravel-scout-elastic).
+
+**Requires Scout 5.*, 6.* or 7.*, Laravel >=5.4, PHP >=7.0**
 
 ## Contents
 
@@ -16,10 +23,10 @@ This package makes is the [Elasticsearch](https://www.elastic.co/products/elasti
 You can install the package via composer:
 
 ``` bash
-composer require tamayo/laravel-scout-elastic
+composer require boxed-code/laravel-scout-elasticsearch
 ```
 
-You must add the Scout service provider and the package service provider in your app.php config:
+If you're using Laravel 5.4, you must add the Scout service provider and the package service provider in your app.php config:
 
 ```php
 // config/app.php
@@ -31,12 +38,9 @@ You must add the Scout service provider and the package service provider in your
 ],
 ```
 
-### Setting up Elasticsearch configuration
-You must have a Elasticsearch server up and running with the index you want to use created
+### Add the elastic search configuration
 
-If you need help with this please refer to the [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html)
-
-After you've published the Laravel Scout package configuration:
+Add the following to your scout configuration:
 
 ```php
 // config/scout.php
@@ -45,7 +49,6 @@ After you've published the Laravel Scout package configuration:
 
 ...
     'elasticsearch' => [
-        'index' => env('ELASTICSEARCH_INDEX', 'laravel'),
         'hosts' => [
             env('ELASTICSEARCH_HOST', 'http://localhost'),
         ],
@@ -55,9 +58,11 @@ After you've published the Laravel Scout package configuration:
 
 ## Usage
 
-Now you can use Laravel Scout as described in the [official documentation](https://laravel.com/docs/5.3/scout)
+Now you can use Laravel Scout as described in the [official documentation](https://laravel.com/docs/5.8/scout)
+
 ## Credits
 
+- [Oliver Green](https://github.com/olsgreen)
 - [Erick Tamayo](https://github.com/ericktamayo)
 - [All Contributors](../../contributors)
 

composer.json

@@ -1,25 +1,31 @@
 {
-    "name": "tamayo/laravel-scout-elastic",
-    "description": "Elastic Driver for Laravel Scout",
-    "keywords": ["laravel", "scout", "elasticsearch", "elastic"],
+    "name": "boxed-code/laravel-scout-elastic",
+    "description": "Elasticsearch Driver for Laravel Scout",
+    "keywords": ["laravel", "scout", "elasticsearch", "elastic", "aws", "elasticsearch service"],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Oliver Green",
+            "email": "oliver@boxedcode.co.uk"
+        }
+    ],
     "require": {
-        "php": ">=5.6.4",
-        "laravel/scout": "^5.0",
+        "php": ">=7.0",
+        "laravel/scout": "^5.0|^6.0|^7.0",
         "elasticsearch/elasticsearch": "^5.0"
     },
      "require-dev": {
-        "fzaninotto/faker": "~1.4",
-        "mockery/mockery": "0.9.*",
-        "phpunit/phpunit": "~5.0"
+        "mockery/mockery": "~1.0",
+        "phpunit/phpunit": "~6.0"
     },
     "autoload": {
         "psr-4": {
-            "ScoutEngines\\Elasticsearch\\": "src/"
+            "BoxedCode\\Laravel\\Scout\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "ScoutEngines\\Elasticsearch\\Test\\": "tests"
+            "Tests\\": "tests"
         }
     },
     "suggest": {
@@ -28,7 +34,7 @@
     "extra": {
         "laravel": {
             "providers": [
-                "ScoutEngines\\Elasticsearch\\ElasticsearchProvider"
+                "BoxedCode\\Laravel\\Scout\\ElasticsearchServiceProvider"
             ]
         }
     },

src/ElasticsearchEngine.php

@@ -1,12 +1,11 @@
 <?php
 
-namespace ScoutEngines\Elasticsearch;
+namespace BoxedCode\Laravel\Scout;
 
 use Laravel\Scout\Builder;
 use Laravel\Scout\Engines\Engine;
 use Elasticsearch\Client as Elastic;
 use Illuminate\Database\Eloquent\Collection;
-use Illuminate\Support\Collection as BaseCollection;
 
 class ElasticsearchEngine extends Engine
 {
@@ -212,23 +211,29 @@ public function mapIds($results)
     public function map(Builder $builder, $results, $model)
     {
         if ($results['hits']['total'] === 0) {
-            return Collection::make();
+            return $model->newCollection();
         }
-
-        $keys = collect($results['hits']['hits'])
-                        ->pluck('_id')->values()->all();
-
-        $models = $model->getScoutModelsByIds(
-            $builder, $keys
-        )->keyBy(function ($model) {
-            return $model->getScoutKey();
-        });
-
-        return collect($results['hits']['hits'])->map(function ($hit) use ($model, $models) {
-            return isset($models[$hit['_id']]) ? $models[$hit['_id']] : null;
-        })->filter()->values();
+        $keys = collect($results['hits']['hits'])->pluck('_id')->values()->all();
+        return $model->getScoutModelsByIds(
+                $builder, $keys
+            )->filter(function ($model) use ($keys) {
+                return in_array($model->getScoutKey(), $keys);
+            });
     }
 
+    /**
+     * Flush all of the model's records from the engine.
+     *
+     * @param  \Illuminate\Database\Eloquent\Model  $model
+     * @return void
+     */
+    public function flush($model)
+    {
+        $model->newQuery()
+            ->orderBy($model->getKeyName())
+            ->unsearchable();
+    } 
+
     /**
      * Get the total count from a raw result returned by the engine.
      *

src/ElasticsearchProvider.php src/ElasticsearchServiceProvider.phpsrc/ElasticsearchProvider.php renamed to src/ElasticsearchServiceProvider.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace ScoutEngines\Elasticsearch;
+namespace BoxedCode\Laravel\Scout;
 
 use Laravel\Scout\EngineManager;
 use Illuminate\Support\ServiceProvider;
 use Elasticsearch\ClientBuilder as ElasticBuilder;
 
-class ElasticsearchProvider extends ServiceProvider
+class ElasticsearchServiceProvider extends ServiceProvider
 {
     /**
      * Bootstrap the application services.

tests/AbstactTestCase.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Tests;
+
+use Mockery;
+use PHPUnit\Framework\TestCase;
+
+abstract class AbstractTestCase extends TestCase
+{
+    protected function tearDown()
+    {
+        Mockery::close();
+
+        parent::tearDown();
+    }
+}

tests/ElasticsearchEngineTest.php

@@ -1,16 +1,15 @@
 <?php
 
+namespace Tests;
+
+use BoxedCode\Laravel\Scout\ElasticsearchEngine;
 use Illuminate\Database\Eloquent\Collection;
 use Laravel\Scout\Builder;
-use ScoutEngines\Elasticsearch\ElasticsearchEngine;
+use Mockery;
+use Tests\Fixtures\TestModel;
 
-class ElasticsearchEngineTest extends PHPUnit_Framework_TestCase
+class ElasticsearchEngineTest extends AbstractTestCase
 {
-    public function tearDown()
-    {
-        Mockery::close();
-    }
-
     public function test_update_adds_objects_to_index()
     {
         $client = Mockery::mock('Elasticsearch\Client');
@@ -31,7 +30,7 @@ public function test_update_adds_objects_to_index()
         ]);
 
         $engine = new ElasticsearchEngine($client, 'scout');
-        $engine->update(Collection::make([new ElasticsearchEngineTestModel]));
+        $engine->update(Collection::make([new TestModel]));
     }
 
     public function test_delete_removes_objects_to_index()
@@ -50,7 +49,7 @@ public function test_delete_removes_objects_to_index()
         ]);
 
         $engine = new ElasticsearchEngine($client, 'scout');
-        $engine->delete(Collection::make([new ElasticsearchEngineTestModel]));
+        $engine->delete(Collection::make([new TestModel]));
     }
 
     public function test_search_sends_correct_parameters_to_elasticsearch()
@@ -76,7 +75,7 @@ public function test_search_sends_correct_parameters_to_elasticsearch()
         ]);
 
         $engine = new ElasticsearchEngine($client, 'scout');
-        $builder = new Laravel\Scout\Builder(new ElasticsearchEngineTestModel, 'zonda');
+        $builder = new \Laravel\Scout\Builder(new TestModel, 'zonda');
         $builder->where('foo', 1);
         $builder->where('bar', [1, 3]);
         $builder->orderBy('id', 'desc');
@@ -90,8 +89,8 @@ public function test_builder_callback_can_manipulate_search_parameters_to_elasti
         $client->shouldReceive('search')->with('modified_by_callback');
 
         $engine = new ElasticsearchEngine($client, 'scout');
-        $builder = new Laravel\Scout\Builder(
-            new ElasticsearchEngineTestModel(),
+        $builder = new \Laravel\Scout\Builder(
+            new TestModel(),
             'huayra',
             function (\Elasticsearch\Client $client, $query, $params) {
                 $this->assertNotEmpty($params);
@@ -114,8 +113,9 @@ public function test_map_correctly_maps_results_to_models()
 
         $model = Mockery::mock('Illuminate\Database\Eloquent\Model');
         $model->shouldReceive('getScoutKey')->andReturn('1');
-        $model->shouldReceive('getScoutModelsByIds')->once()->with($builder, ['1'])->andReturn(Collection::make([$model]));
-
+        $model->shouldReceive('getScoutModelsByIds')->once()->with($builder, ['1'])->andReturn($models = Collection::make([$model]));
+        $model->shouldReceive('newCollection')->andReturn($models);
+        
         $results = $engine->map($builder, [
             'hits' => [
                 'total' => '1',
@@ -129,27 +129,4 @@ public function test_map_correctly_maps_results_to_models()
 
         $this->assertEquals(1, count($results));
     }
-}
-
-class ElasticsearchEngineTestModel extends \Illuminate\Database\Eloquent\Model
-{
-    public function getIdAttribute()
-    {
-        return 1;
-    }
-
-    public function searchableAs()
-    {
-        return 'table';
-    }
-
-    public function getKey()
-    {
-        return '1';
-    }
-
-    public function toSearchableArray()
-    {
-        return ['id' => 1];
-    }
-}
+}

tests/Fixtures/TestModel.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Tests\Fixtures;
+
+class TestModel extends \Illuminate\Database\Eloquent\Model
+{
+    public function getIdAttribute()
+    {
+        return 1;
+    }
+
+    public function searchableAs()
+    {
+        return 'table';
+    }
+
+    public function getKey()
+    {
+        return '1';
+    }
+
+    public function toSearchableArray()
+    {
+        return ['id' => 1];
+    }
+}