Add Configurable Scout Key Type (#752)

* add getScoutKeyType method to allow customizing the key type for scout queries

* wip

* Enhance testing of SearchableModel's queryScoutModelsByIds method for custom scoutKeyTypes

Author: geisi

src/Searchable.php

@@ -253,7 +253,7 @@ public function queryScoutModelsByIds(Builder $builder, array $ids)
             call_user_func($builder->queryCallback, $query);
         }
 
-        $whereIn = in_array($this->getKeyType(), ['int', 'integer']) ?
+        $whereIn = in_array($this->getScoutKeyType(), ['int', 'integer']) ?
             'whereIntegerInRaw' :
             'whereIn';
 
@@ -393,6 +393,16 @@ public function getScoutKey()
         return $this->getKey();
     }
 
+    /**
+     * Get the auto-incrementing key type for querying models.
+     *
+     * @return string
+     */
+    public function getScoutKeyType()
+    {
+        return $this->getKeyType();
+    }
+
     /**
      * Get the key name used to index the model.
      *

tests/Feature/SearchableTest.php

@@ -102,6 +102,36 @@ public function test_was_searchable_on_model_without_soft_deletes()
         $this->assertTrue($model->wasSearchableBeforeDelete());
     }
 
+    public function test_it_queries_searchable_models_by_their_ids_with_integer_key_type()
+    {
+        $model = M::mock(SearchableModel::class)->makePartial();
+        $model->shouldReceive('newQuery')->andReturnSelf();
+        $model->shouldReceive('getScoutKeyType')->andReturn('int');
+        $model->shouldReceive('getScoutKeyName')->andReturn('id');
+        $model->shouldReceive('qualifyColumn')->with('id')->andReturn('qualified_id');
+        $model->shouldReceive('whereIntegerInRaw')->with('qualified_id', [1, 2, 3])->andReturnSelf();
+
+        $scoutBuilder = M::mock(\Laravel\Scout\Builder::class);
+        $scoutBuilder->queryCallback = null;
+
+        $model->queryScoutModelsByIds($scoutBuilder, [1, 2, 3]);
+    }
+
+    public function test_it_queries_searchable_models_by_their_ids_with_string_key_type()
+    {
+        $model = M::mock(SearchableModel::class)->makePartial();
+        $model->shouldReceive('newQuery')->andReturnSelf();
+        $model->shouldReceive('getScoutKeyType')->andReturn('string');
+        $model->shouldReceive('getScoutKeyName')->andReturn('id');
+        $model->shouldReceive('qualifyColumn')->with('id')->andReturn('qualified_id');
+        $model->shouldReceive('whereIn')->with('qualified_id', [1, 2, 3])->andReturnSelf();
+
+        $scoutBuilder = M::mock(\Laravel\Scout\Builder::class);
+        $scoutBuilder->queryCallback = null;
+
+        $model->queryScoutModelsByIds($scoutBuilder, [1, 2, 3]);
+    }
+
     public function test_was_searchable_before_update_works_from_true_to_false()
     {
         $model = new SearchableModelWithSoftDeletes([